Synadia Communications

Synadia Communications Nats User API

The nats-user API from Synadia Communications — 10 operation(s) for nats-user.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /core/beta/nats-users/{userId} Delete a NATS user · Delete NATS User #
Ask an LLM
“Can I delete a NATS user from its account?”
“How do I get rid of a NATS user nobody uses anymore?”
Tell an agent destructive · confirm first
Delete NATS user {user}.
Remove NATS user {user} from its account.
GET /core/beta/nats-users/{userId} Look up a NATS user · Get NATS User #
Ask an LLM
“How do I fetch the details of one NATS user by ID?”
“Which signing key group and JWT settings does a given NATS user have?”
Tell an agent
Show NATS user {user}.
Get the details of NATS user {user}.
PATCH /core/beta/nats-users/{userId} Update a NATS user · Update NATS User #
Ask an LLM
“How do I rename an existing NATS user?”
“Can I change how long an existing NATS user's JWT lasts?”
Tell an agent
Rename NATS user {user} to {name}.
Set NATS user {user}'s JWT to expire after {seconds} seconds.
GET /core/beta/nats-users/{userId}/app-users List app users with access to a NATS user · List Team App Users #
Ask an LLM
“Which teammates have been granted access to a specific NATS user?”
“Who can manage a given NATS user's credentials, and with what role?”
Tell an agent
List the app users assigned to NATS user {user}.
Show who has access to NATS user {user}.
DELETE /core/beta/nats-users/{userId}/app-users/{teamAppUserId} Remove a team member from a NATS user · Unassign Team App User from NATS User #
Ask an LLM
“How do I revoke a teammate's access to a particular NATS user?”
“Can I unassign an app user from just one NATS user?”
Tell an agent destructive · confirm first
Unassign app user {app_user} from NATS user {user}.
Take away app user {app_user}'s access to NATS user {user}.
POST /core/beta/nats-users/{userId}/app-users/{teamAppUserId} Grant a team member a role on a NATS user · Assign Team App User to NATS User #
Ask an LLM
“How do I give a teammate access to one NATS user with a role?”
“Can I change the role of an app user already assigned to a NATS user?”
Tell an agent
Assign app user {app_user} to NATS user {user} with role {role}.
Change app user {app_user}'s role on NATS user {user} to {role}.
POST /core/beta/nats-users/{userId}/bearer-jwt Get a bearer JWT for a NATS user · Get Bearer JWT #
Ask an LLM
“How can I get a bearer token for a NATS user to connect with?”
“Is there a way to issue a bearer JWT instead of a creds file?”
Tell an agent
Issue a bearer JWT for NATS user {user}.
Give me a bearer token for NATS user {user}.
GET /core/beta/nats-users/{userId}/connections List a NATS user's live connections · List NATs User Connections #
Ask an LLM
“Which clients are currently connected as a given NATS user?”
“Can I filter a NATS user's connections by state or subject and cap the count?”
Tell an agent
List connections for NATS user {user}.
Show NATS user {user}'s connections in state {state}, limited to {limit}.
POST /core/beta/nats-users/{userId}/copy Copy a NATS user with a new name · Copy nats user #
Ask an LLM
“Can I clone a NATS user into another signing key group?”
“Does copying a NATS user give the copy its own NKey?”
Tell an agent
Copy NATS user {user} as {name} under signing key group {sk_group}.
Duplicate NATS user {user} into group {sk_group} named {name}.
POST /core/beta/nats-users/{userId}/creds Download a creds file for a NATS user · Get Creds #
Ask an LLM
“How do I download the .creds file a NATS client needs to connect?”
“Where can I get credentials for a NATS user to use with the CLI?”
Tell an agent
Download the creds file for NATS user {user}.
Generate credentials for NATS user {user}.
POST /core/beta/nats-users/{userId}/http-gw-token Get an HTTP Gateway token for a NATS user · Get HTTP Gateway Token #
Ask an LLM
“How do I get a token to call the NATS HTTP Gateway as a user?”
“Can a NATS user be issued an HTTP Gateway token?”
Tell an agent
Issue an HTTP Gateway token for NATS user {user}.
Get NATS user {user} a token for the HTTP Gateway.
GET /core/beta/nats-users/{userId}/issuances List a NATS user's credential issuances · List nats user issuances #
Ask an LLM
“What is the history of credentials issued to a NATS user?”
“Can I audit when creds were generated for a user?”
Tell an agent
List the credential issuances for NATS user {user}.
Show the issuance history of NATS user {user}.
POST /core/beta/nats-users/{userId}/rotate Rotate a NATS user's NKey and seed · Rotate nats user nkey and seed #
Ask an LLM
“How do I rotate a NATS user's keys if their seed may have leaked?”
“Does rotating a user give it a brand new NKey?”
Tell an agent destructive · confirm first
Rotate the NKey and seed for NATS user {user}.
Generate a new NKey for NATS user {user}.

Documentation

📖
Documentation
https://docs.synadia.com/platform/control-plane
📖
APIReference
https://cloud.synadia.com/api-docs
📖
Documentation
https://docs.synadia.com/cloud/resources/http-gateway
📖
APIReference
https://api.ngs.global/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/openapi/synadia-communications-nats-user-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/synadia-io/control-plane-sdk-go

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/synadia-communications:synadia-communications-nats-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

synadia-communications-nats-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Nats User API
  version: beta
servers:
- description: Path to Synadia Control Plane Server Api
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: ''
security:
- bearerAuth: []
  sessionAuth: []
tags:


# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/openapi/synadia-communications-nats-user-api-openapi.yml