GET
/
api
/
v1
/
platform
/
tenants
/
{tenant_id}
/
nats
/
principals
List NATS principals
curl --request GET \
  --url https://api.example.com/api/v1/platform/tenants/{tenant_id}/nats/principals \
  --header 'X-Api-Id: <x-api-id>' \
  --header 'X-Api-Nonce: <x-api-nonce>' \
  --header 'X-Api-Signature: <api-key>' \
  --header 'X-Api-Timestamp: <x-api-timestamp>'
[
  {
    "principal_id": "nats_principal_001",
    "tenant_id": "tenant_001",
    "nats_user": "tenant_001_api",
    "nats_account_public_key": "ADWKVDCWZ6WSPXTGGR2U",
    "nats_user_public_key": "UDWKVDCWZ6WSPXTGGR2U",
    "principal_type": "SERVICE",
    "client_id": "",
    "service_name": "api",
    "status": "ACTIVE",
    "expires_at": null,
    "request_id": "req-001"
  }
]

Authorizations

​
X-Api-Signature
string
header
required

UTMOS HMAC request signature with X-Api-Id, X-Api-Timestamp and X-Api-Nonce.

Headers

​
X-Api-Id
string
required

Platform or tenant administrator credential

​
X-Api-Timestamp
string
required

Unix seconds

​
X-Api-Nonce
string
required

Replay-protection nonce

​
X-Api-Signature
string
required

HMAC signature

​
X-Request-Id
string

Caller correlation ID; generated when omitted

Path Parameters

​
tenant_id
string
required

Tenant identifier

Query Parameters

​
limit
integer
default:100

Maximum number of records returned by a list endpoint. Defaults to 100; max 500.

Required range: 1 <= x <= 500

Response

OK

​
principal_id
string
​
tenant_id
string
​
nats_user
string
​
nats_account_public_key
string
​
nats_user_public_key
string
​
principal_type
string
​
client_id
string
​
service_name
string
​
status
enum<string>
Available options:
ACTIVE,
DISABLED,
DELETED
​
expires_at
string<date-time> | null
​
request_id
string