Skip to main content

Accessing Cirata Symphony

Interact with Cirata Symphony using any of six methods:

  1. The user interface that you are using now,
  2. The cirata command-line tool,
  3. The REST API,
  4. The NATS interface,
  5. A client library from a supported language and runtime, or
  6. Deploying and operating a Symphony extension, which can access the REST API and NATS interface.

In every case, access requires authentication and is constrained by authorization controls.

Accessing the Symphony user interface​

Sign in to the user interface at https://your-symphony-instance.com using your web browser. Provide your email and Symphony-specific password, or simply sign in with a configured OpenID Connect provider.

Once you have signed in, the Symphony user interface will present you with the dashboard view and menu options.

Access Control for the Symphony user interface​

Using the cirata command-line tool​

The cirata CLI is available for Linux, macOS, and Windows. All three platform binaries are included in every Symphony installation archive. Contact the operator of your Symphony instance to obtain the binary for your platform. See the Command-Line Tool page for setup instructions, or the CLI Reference for full command documentation.

Using the REST API​

Symphony exposes a REST API for programmatic access over standard HTTPS. Requests are authenticated with a bearer token in the Authorization header. See the REST API page for endpoints and examples, or the Swagger UI for interactive exploration.

Access Control for the Symphony REST API​

Using the NATS interface​

Extensions and client libraries connect to Symphony over its NATS messaging interface. A connection requires a JWT and seed obtained by exchanging a bearer token via the REST API. Once connected, the client communicates by publishing and subscribing to NATS subjects within the permissions granted by its API key.

Access Control for Symphony extensions​

Using a client library​

Symphony provides client libraries for building extensions and integrations in supported languages. Each library handles token exchange, NATS connection management, and reconnection automatically. See the extension development guides for Python, Java, Go, and Rust.