DASHBOARD

Written for: ＋ Written for
Deprecated: ＋ Deprecated
Applies to: ＋ Applies to

AdminUpdated Sep 12, 2026

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users

Search users by email, name or id, filtered by banned, MFA or provider.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users

Create a user with a verified email and an optional password. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}

Full user profile for an administrator, including private metadata.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/ban

Ban a user and revoke every session they hold.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/ban"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/unban

Lift a ban. Sessions are not restored.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/unban"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/unlock

Clear an automated lockout for a user locked out by guessing.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/unlock"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/reset_mfa

Remove every second factor. Requires owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/reset_mfa"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/revoke_sessions

Sign a user out everywhere and bump sessions_version.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/revoke_sessions"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/sessions/{sessionId}/revoke

Revoke one of a user’s sessions (per-device sign-out).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes
`sessionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/sessions/{sessionId}/revoke"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/impersonate

Mint a single-use impersonation token. Audited by person.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/impersonate"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/delete

Soft-delete a user. PII is scrubbed after 30 days.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/delete"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations

List or search organizations, with member counts and the O4 orphaned flag.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations

Create an organization in this instance. Starts adminless until its first invite.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}

One organization with its members and its full invitation history.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}

Delete an organization. The O4 remedy; requires owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/clone

Clone an org's config (name, slug, policy, email domains, groups + role grants — not members) into the application's other environment (prod↔test).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/clone"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/members

Add an existing user of this instance to an organization (O5 enforced).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/members"

DELETE

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/members/{userId}

Remove a member. Removing the last admin is 409 LAST_ADMIN (O1).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/members/{userId}"

PATCH

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/members/{userId}

Change a member's role. Demoting the last admin is 409 LAST_ADMIN (O1).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/members/{userId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/groups

List the organization directory groups, so a role grant can pick one.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/groups"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/policy

Read the org security policy (requireMfa, ssoRequired, sessionIdleOverrideMs).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/policy"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/policy

Update the org security policy (requireMfa, ssoRequired, sessionIdleOverrideMs).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/policy"

GET

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/groups/{groupId}/roles

List the org roles granted to a directory group.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`groupId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/groups/{groupId}/roles"

PUT

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/groups/{groupId}/roles/{roleId}

Grant an org role to a directory group; members inherit its permissions.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`groupId`	path	string	yes
`roleId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/groups/{groupId}/roles/{roleId}"

DELETE

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/groups/{groupId}/roles/{roleId}

Revoke a role from a directory group.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`groupId`	path	string	yes
`roleId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/groups/{groupId}/roles/{roleId}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/invitations

Issue an invitation with no member behind it; the audit row names the operator.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/invitations"

POST

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/invitations/{invitationId}/revoke

Revoke a pending invitation. Already-accepted ones are 409.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`invitationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/invitations/{invitationId}/revoke"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains

List an organization email domains and their verification state.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains

Claim an email domain for auto-join. Returns the DNS TXT record to publish.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains"

POST

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains/{domainId}/verify

Check the DNS TXT record now and mark the domain verified.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`domainId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains/{domainId}/verify"

DELETE

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains/{domainId}

Remove a claimed email domain.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`domainId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains/{domainId}"

PATCH

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains/{domainId}

Update a claimed domain auto-join and default role. The domain and its verification state are immutable.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`organizationId`	path	string	yes
`domainId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/organizations/{organizationId}/domains/{domainId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/auth_config

The instance auth config, with the bounds the UI must respect.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/auth_config"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/auth_config

Patch one or more config sections. Owner or admin; every change is audited.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/auth_config"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/captcha_secret

Store the captcha provider secret. Write-only; never returned. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/captcha_secret"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/kerberos_secret

Store the per-instance Kerberos/IWA trusted-proxy secret. Write-only, encrypted; never returned. Refused while the kerberos strategy is off. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/kerberos_secret"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/wallet_rpc_secret

Store (or clear, with an empty url) a BYOK per-chain wallet RPC endpoint for token-gating. Keyed by EIP-155 chainId; write-only, encrypted; never returned. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/wallet_rpc_secret"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/security

Read the instance kill switches and customer IP allowlist.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/security"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/security

Edit the instance kill switches and customer IP allowlist. Empty allowlist = unrestricted. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/security"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/waitlist

The sign-up waitlist queue, with counts by status.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/waitlist"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/waitlist/{entryId}/decide

Approve or deny a waitlist entry. Approval is what lets that address sign up.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`entryId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/waitlist/{entryId}/decide"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/restrictions

The allow and block lists plus whether allow-list-only sign-up is on.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/restrictions"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/restrictions

Add an email, @domain or E.164 phone to the allow or block list. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/restrictions"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/restrictions

Toggle allow-list-only sign-up, the switch that gives the allow list effect.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/restrictions"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/restrictions/{id}

Remove an allow/block list entry. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/restrictions/{id}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/network_acls

The per-instance IP allow/deny rules, priority-ordered.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/network_acls"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/network_acls

Add an IP/CIDR allow or deny rule. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/network_acls"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/network_acls/{id}

Remove a network ACL rule. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/network_acls/{id}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/network_acls/{id}

Edit a network ACL rule (action, CIDR, priority, enabled). Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/network_acls/{id}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates

The per-instance SMS templates — built-in default alongside any override.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates

Customise an SMS template body (upsert). Must keep {{code}}. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates/{name}

One SMS template — its built-in default and stored override, if any.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`name`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates/{name}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates/{name}

Reset an SMS template to the built-in default (drops the override). Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`name`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates/{name}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates/{name}

Edit an SMS template body/enabled. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`name`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates/{name}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates/{name}/preview

Render an SMS body with a fixed sample code — never a live OTP.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`name`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sms_templates/{name}/preview"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf

Managed AWS WAF config + provisioning state. Secrets are never returned, only has_* markers.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf

Set managed WAF config + write-only AWS credentials. Enabling points captcha at awswaf. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf/status

The lean managed WAF provisioning status (enabled, status, WebACL, last error).

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf/status"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf/provision

Provision the WebACL (idempotent create/update + associate). Fail-safe. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf/provision"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf/deprovision

Disassociate and delete the WebACL. Fail-safe. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/managed_waf/deprovision"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets

Outbound SCIM provisioning targets Atlas pushes users to; bearer shown as has_* only.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets

Create an outbound SCIM target. The downstream bearer is write-only. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}

One outbound SCIM target with its sync health, bearer redacted.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}

Remove an outbound SCIM target. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}

Edit an outbound SCIM target (name, base URL, bearer, mapping, pause/resume). Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}/test

Verify connectivity/auth to the downstream (ServiceProviderConfig). Writes no data. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}/test"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}/sync_user

Force one user to sync to the target now (backfill/re-push). Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}/sync_user"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}/sync_group

Force one organization (group) to sync now; skips unprovisioned members. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_provisioning_targets/{id}/sync_group"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates

The named JWT templates (custom-claim maps) stored in the instance auth config.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates

Create a JWT template (name + claims map). Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates/{id}

One JWT template with its claims map.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates/{id}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates/{id}

Remove a JWT template. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates/{id}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates/{id}

Edit a JWT template (claims, lifetime). Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jwt_templates/{id}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/localizations

Per-language overrides for emails, SMS and hosted-page copy, plus the resource catalog.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/localizations"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/localizations

Create or replace a localization override (validated like the base template).

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/localizations"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/localizations/{id}

Remove a localization override; the base template renders again.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/localizations/{id}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/localizations/{id}

Edit a localization override’s content or enabled flag.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/localizations/{id}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/user_imports

Bulk-import users from an array; small batches run inline, large ones queue. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/user_imports"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/user_exports

Export every user as a JSON array (no secrets, by construction). Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/user_exports"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jobs

List import/export jobs with live progress counters.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jobs"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jobs/{id}

Poll one import/export job (an export carries its result payload).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jobs/{id}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jobs/{id}/errors

The per-row failures recorded for an import job.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/jobs/{id}/errors"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/data_subject_requests

The GDPR/DSAR queue — export and erasure requests, filterable by type/status/user.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/data_subject_requests"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/data_subject_requests/{id}

One data-subject request, including an export package if it was fulfilled.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/data_subject_requests/{id}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/data_subject_requests/{id}/fulfill

Fulfil now — build the export or run the erasure ahead of schedule. Terminal. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/data_subject_requests/{id}/fulfill"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/data_subject_requests/{id}/reject

Reject a request with a recorded reason. Terminal. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/data_subject_requests/{id}/reject"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams

Log-stream sinks (HTTP/Datadog/Splunk); secrets shown as has_* markers only.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams

Create a log-stream sink. Destination secrets are write-only. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams/{id}

One log-stream sink with its delivery health, secrets redacted.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams/{id}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams/{id}

Remove a log-stream sink. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams/{id}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams/{id}

Edit a log-stream sink (name, destination, filter, pause/resume). Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams/{id}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams/{id}/test

Send one synthetic event to the sink and report its status. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/log_streams/{id}/test"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers

The whole provider catalog with per-instance state and the redirect URI to register.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}

Store a client id and secret. Write-only: no route ever returns the secret.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`provider`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}

Forget the credentials. Linked accounts are preserved (E17).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`provider`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}/enabled

Enable or disable a configured provider without deleting anyone identity.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`provider`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}/enabled"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}/scope

Scope a provider to sign-in, sign-up, or both. Enforced at the §6.5 resolver.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`provider`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}/scope"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}/shared_keys

Opt in or out of Atlas shared development credentials. Refused for production.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`provider`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}/shared_keys"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}/test

Probe the provider token endpoint to check the client id and secret only.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`provider`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_providers/{provider}/test"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections

List enterprise SSO connections. The OIDC client secret is never returned.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections

Create an enterprise SSO connection. The client secret is write-only.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}

Read one SSO connection. Reports has_secret only, never the secret.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}

Delete an SSO connection and its domain routing.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}

Update an SSO connection. Omitting the secret leaves the stored one untouched.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/atlas

Whether "Sign in with Atlas" is enabled on this instance, and whether the deployment offers it.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/atlas"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/atlas

Enable "Sign in with Atlas" — provisions an Atlas-ID OP client + preset OIDC connection. Owner/admin. Idempotent.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/atlas"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/atlas

Disable "Sign in with Atlas" — removes the preset connection. Owner/admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/atlas"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}/test

Validate discovery: issuer reachable and issuer-match (RFC 8414). Not the client.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}/test"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}/test_login

Begin an interactive OIDC test login (opened in a popup); the callback shows the returned claims and provisions nothing.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}/test_login"

POST

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}/import_saml_metadata

Parse an IdP SAML EntityDescriptor and populate the entity id, SSO URL and signing certificate.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}/import_saml_metadata"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}/saml_metadata

SP metadata XML for a SAML connection, plus the ACS URL and SP entity id the operator registers with their IdP.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_connections/{connectionId}/saml_metadata"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles

List self-service SSO onboarding profiles.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles

Create a self-service SSO onboarding profile (owner/admin).

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles/{profileId}

Delete an SSO onboarding profile.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`profileId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles/{profileId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles/{profileId}/tickets

List the onboarding tickets issued for a profile.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`profileId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles/{profileId}/tickets"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles/{profileId}/tickets

Issue a one-time SSO onboarding ticket + hosted setup URL (revealed once).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`profileId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_profiles/{profileId}/tickets"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_tickets/{ticketId}/revoke

Revoke an outstanding SSO onboarding ticket.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`ticketId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/sso_onboarding_tickets/{ticketId}/revoke"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers

List resource servers (APIs that accept machine tokens).

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers

Create a resource server (audience + scopes) for client-credentials tokens.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers/{id}

Read one resource server.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers/{id}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers/{id}

Delete a resource server; its client grants cascade.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers/{id}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers/{id}

Update a resource server (identifier is immutable).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/resource_servers/{id}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/grants

List a client’s machine-to-machine grants.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/grants"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/grants

Grant a confidential client client-credentials access to a resource server.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/grants"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/grants/{grantId}

Revoke a client’s machine-to-machine grant.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes
`grantId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/grants/{grantId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding

Branding as stored, plus what the renderers will actually use.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding

Update logo and colours for the hosted pages and emails.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding/preview

Render an unsaved branding draft through the real hosted-page renderer; persists nothing.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding/preview"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding/logo

Upload the instance logo (raw image bytes, validated by magic number) to object storage and point branding.logoUrl at it. 503 when image storage is not configured.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding/logo"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates

Every template with its override and the variable schema it is validated against.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates/{template}

Store a template override. Validated by the same code the mailer applies.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`template`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates/{template}"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates/{template}

Drop the override and go back to the built-in template.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`template`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates/{template}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates/{template}/preview

Compile an unsaved draft to HTML with sample values. Sends nothing.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`template`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates/{template}/preview"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates/{template}/test_send

Send a test to the operator own verified address. The address cannot be chosen.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`template`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/email_templates/{template}/test_send"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles

Roles with membership counts and permissions, plus which roles grant each permission.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles

Create a custom role. Keys are namespaced org: and may not use sys_.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles/{roleId}

Delete a role, optionally reassigning its members first with ?reassign_to.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`roleId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles/{roleId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles/{roleId}

Relabel a role. The key is immutable because it appears in issued tokens.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`roleId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles/{roleId}"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles/{roleId}/permissions

Replace a custom role permission set. System role sets are fixed.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`roleId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/roles/{roleId}/permissions"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/permissions

Define a custom permission key.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/permissions"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/permissions/{permissionId}

Delete a permission no role grants. Refused with the granting roles named.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`permissionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/permissions/{permissionId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/permissions/{permissionId}

Update a custom permission's name/description (the key is immutable). System permissions are refused.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`permissionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/permissions/{permissionId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks

Endpoints with their failure streak, plus the event catalog and retry schedule.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks

Create an endpoint. The signing secret is returned once here.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}

Delete an endpoint and its delivery history.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`endpointId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}

Change the URL, the subscribed events, or re-enable a disabled endpoint.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`endpointId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/reveal

Reveal the signing secret. Owner or admin, and audited before it is returned.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`endpointId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/reveal"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/rotate

Mint a new signing secret. Old-secret verifiers start failing immediately.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`endpointId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/rotate"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/deliveries

The delivery log, with the payload sent and the response received.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`endpointId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/deliveries"

POST

https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/deliveries/{deliveryId}/redeliver

Queue a fresh attempt for an event. A new row; the failed one is kept.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`endpointId`	path	string	yes
`deliveryId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/deliveries/{deliveryId}/redeliver"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/test

Send a synthetic webhook.test event to one endpoint. Records a real delivery; never fanned out.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`endpointId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/webhooks/{endpointId}/test"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/api_keys

Keys with last-used and a stale flag, plus the scope catalog.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/api_keys"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/api_keys

Mint a secret key. Returned exactly once.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/api_keys"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/api_keys/{keyId}/rotate

Mint a replacement with the same scopes. The old key keeps working until revoked.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`keyId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/api_keys/{keyId}/rotate"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/api_keys/{keyId}/revoke

Revoke a key. The row is kept so the audit log can still name it.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`keyId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/api_keys/{keyId}/revoke"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/events

The activity feed, filterable by type and date. ?format=csv exports it.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/events"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/audit_logs

The audit log with actor, action and target filters. ?format=csv exports it.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/audit_logs"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/domains

Custom domains with CNAME instructions, TLS status and the cookie-domain check.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/domains"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/domains

Claim a hostname for the FAPI or hosted-pages role. Subdomains only.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/domains"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/domains/{domainId}/verify

Check the CNAME now and record what DNS actually returned.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`domainId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/domains/{domainId}/verify"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/domains/{domainId}

Remove a domain. Refused for a live production FAPI host.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`domainId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/domains/{domainId}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/metadata

Edit the public, private and unsafe metadata bags. Refuses non-objects, prototype-polluting keys, oversized and over-nested documents.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/users/{userId}/metadata"

GEThttps://{apiHost}/v1/staff/accounts

§11.2 staff: search customer accounts. Requires the staff instance, an MFA-verified session and an allowlisted IP.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/staff/accounts"

GEThttps://{apiHost}/v1/staff/accounts/{accountId}

§11.2 staff: one account with its applications and instances. Read-only; user counts, never user lists.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/staff/accounts/{accountId}"

GEThttps://{apiHost}/v1/staff/platform_switches

§15.4 staff: read the global kill switches. Staff instance, MFA and IP allowlist.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/staff/platform_switches"

PATCHhttps://{apiHost}/v1/staff/platform_switches

§15.4 staff: flip the global kill switches (read-only mode, disable all sign-ups). Audited.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/staff/platform_switches"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/usage

Daily sign-in, sign-up, email and active-user series plus trailing 30-day MAU. MAU is a distinct count, never a sum of the daily active-user rows.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/usage"

GEThttps://{apiHost}/v1/dashboard/accounts

Accounts the signed-in dashboard user belongs to.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts"

POSThttps://{apiHost}/v1/dashboard/accounts

Create an account with the caller as its first owner, atomically.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts"

POSThttps://{apiHost}/v1/dashboard/onboarding/bootstrap

First-run: provision a whole workspace in one call — account + owner + an application with development and production instances. Names optional (Skip sends none, gets defaults).

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/onboarding/bootstrap"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications

Applications and their instances. Secret keys are never listed.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications

Create an application with both a development and production instance.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/members

List account members and their roles.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/members"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/members

Add a member. Requires owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/members"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/members/{userId}

Remove a member. Removing the last owner returns LAST_ADMIN.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/members/{userId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/members/{userId}

Change a member's role. Demoting the last owner returns LAST_ADMIN.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/members/{userId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions

List the instance Actions (tenant code that runs at auth-pipeline triggers). Secret values never returned.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions

Create an Action (name, trigger, code, secrets). Owner/admin only; secrets are write-only.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/{id}

Delete an Action; its trigger bindings cascade so it stops running everywhere. Owner/admin only.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/{id}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/{id}

Update an Action’s name, code, enabled state or secrets. Owner/admin only.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/{id}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/{id}/test

Dry-run an Action against a sample event in the sandbox; touches no real data. Owner/admin only.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/{id}/test"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/bindings/{trigger}

The ordered pipeline of Actions bound to a trigger (the flow).

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`trigger`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/bindings/{trigger}"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/bindings/{trigger}

Set the ordered pipeline of Actions for a trigger (reorder/add/remove). Owner/admin only.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`trigger`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/actions/bindings/{trigger}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores

List fine-grained (ReBAC) authorization stores.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores

Create an FGA authorization store. Owner/admin only.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}

Delete an FGA store and its models + tuples. Owner/admin only.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/models

List a store’s authorization models; the latest includes its full definition.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/models"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/models

Write a new (immutable, versioned) authorization model; validated before persist. Owner/admin only.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/models"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/read

Read relationship tuples in a store, optionally filtered by user/relation/object.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/read"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/write

Write and/or delete relationship tuples in a store. Owner/admin only.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/write"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/check

Run a fine-grained access check (user, relation, object) against the store’s latest model.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/fga/stores/{id}/check"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_tokens

List SCIM provisioning tokens with last-used. Never re-reveals a token.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_tokens"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_tokens

Mint a SCIM token for an organization directory. Returned exactly once.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_tokens"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_tokens/{tokenId}/revoke

Revoke a SCIM token. The row is kept so the audit log can still name it.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`tokenId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/scim_tokens/{tokenId}/revoke"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/billing

Read the account plan, whether a subscription is live, and whether Stripe billing is configured on this deployment.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/billing"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/billing/checkout

Start a Stripe Checkout Session to upgrade to pro and return its URL. Owner or admin; 503 when Stripe is not configured. Never changes the plan itself.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/billing/checkout"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/billing/portal

Open a Stripe Billing Portal session to manage or cancel the subscription and return its URL. Owner or admin; 503 when Stripe or the customer is absent.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/billing/portal"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers

Read the BYOK email and SMS providers with the plan and whether managed sending is available. Secrets are never returned, only which are set.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers/email

Store the email provider (resend, ses or smtp). Secrets are write-only; a blank or omitted secret keeps the stored one.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers/email"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers/sms

Store the SMS provider (twilio). The auth_token is write-only; a blank or omitted value keeps the stored one.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers/sms"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers/{channel}

Forget a channel's BYOK provider. The instance falls back to managed-if-paid.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`channel`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers/{channel}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers/{channel}/test

Send a clearly-marked test message to a destination to verify the configured email or SMS provider delivers, without triggering a real auth flow. Owner or admin; rate-limited; 422 when nothing is configured.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`channel`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/messaging_providers/{channel}/test"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/lti_platforms

List the registered LTI 1.3 platforms (issuer, client_id, jwks_uri, deployment_ids).

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/lti_platforms"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/lti_platforms

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/lti_platforms"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/lti_platforms/{platformId}

Delete an LTI platform registration. Future launches from it are refused.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`platformId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/lti_platforms/{platformId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/lti_platforms/{platformId}

Update an LTI platform’s endpoints, deployment_ids, or organization binding.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`platformId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/lti_platforms/{platformId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/radius_clients

List the RADIUS NAS clients (name, NAS-Identifier, optional source-IP bind, enabled). The shared secret is never returned.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/radius_clients"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/radius_clients

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/radius_clients"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/radius_clients/{clientId}

Delete a RADIUS NAS client. That NAS can no longer authenticate against the listener.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/radius_clients/{clientId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/radius_clients/{clientId}

Update a NAS client. An omitted or empty shared_secret keeps the stored one.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/radius_clients/{clientId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients

List registered "Sign in with Atlas" clients. The client secret is never re-revealed.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients

Register a "Sign in with Atlas" client. redirect_uris are validated as absolute https; the secret is revealed once (none for a public PKCE client).

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}

Delete an OAuth client. Its authorization codes and grants cascade away with it.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}

Edit an OAuth client's name, redirect_uris, scopes, logo or auth method. Never changes the client_id or the secret.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/rotate_secret

Rotate a confidential client secret. The old secret stops working immediately.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/rotate_secret"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/consents

The end-user consents (authorized users + scopes) granted to this OAuth client.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`clientId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/oauth_clients/{clientId}/consents"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding/image

Upload a branding image (logo) as raw bytes; returns its hosted asset URL. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/branding/image"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}

Delete an application. Refused for the last remaining application in the account.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`appId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}

Rename an application the account owns. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`appId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team

The application team: members and pending invitations for this application.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`appId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team/invitations

Invite a collaborator to help manage this application; returns a one-time invite link. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`appId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team/invitations"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team/invitations/{id}/revoke

Revoke a pending application-team invitation. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`appId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team/invitations/{id}/revoke"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team/members/{userId}

Remove a collaborator from the application team. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`appId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team/members/{userId}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team/members/{userId}

Change an application-team member’s role. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`appId`	path	string	yes
`userId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/applications/{appId}/team/members/{userId}"

POSThttps://{apiHost}/v1/dashboard/app_invitations/accept

Accept an application-team invitation with its token (the invitee’s own session).

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/app_invitations/accept"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/ldap_connections

Which configured LDAP connections have a stored bind password (state only, never the secret).

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/ldap_connections"

PUThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/ldap_connections/{connectionId}/bind_password

Set a connection’s LDAP bind password (write-only, encrypted). Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/ldap_connections/{connectionId}/bind_password"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/ldap_connections/{connectionId}/bind_password

Clear a connection’s stored LDAP bind password. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`connectionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/ldap_connections/{connectionId}/bind_password"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/billing_plans

List the end-user subscription plans defined for this instance.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/billing_plans"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/billing_plans

Create an end-user billing plan (slug + Stripe price + features). Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/billing_plans"

DELETEhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/billing_plans/{id}

Delete an end-user billing plan. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/billing_plans/{id}"

PATCHhttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/billing_plans/{id}

Update an end-user billing plan. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/billing_plans/{id}"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/bot_signals

Recent anti-bot signal rows (risk verdict, network origin, geo, captcha), newest first.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/bot_signals"

GEThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/invitations

List instance invitations (pending, accepted, revoked, expired).

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/invitations"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/invitations

Create an instance invitation for an email address. Owner or admin.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`instanceId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/invitations"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/invitations/{id}/revoke

Revoke a pending instance invitation. Owner or admin.

Parameters

Name	In	Type	Required
`accountId`	path	string	yes
`instanceId`	path	string	yes
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/instances/{instanceId}/invitations/{id}/revoke"

POSThttps://{apiHost}/v1/dashboard/accounts/{accountId}/billing/subscriptions/{subscriptionId}/allocate

Allocate (move) a platform subscription to one application. Each subscription powers a single app.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string	yes
`subscriptionId`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/v1/dashboard/accounts/{accountId}/billing/subscriptions/{subscriptionId}/allocate"

GEThttps://{apiHost}/v1/dashboard/me/notification_prefs

The signed-in admin’s email-notification preferences (security, product, billing, team).

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/v1/dashboard/me/notification_prefs"

PUThttps://{apiHost}/v1/dashboard/me/notification_prefs

Update the signed-in admin’s email-notification preferences. Partial patch per category.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/v1/dashboard/me/notification_prefs"

Was this page helpful?