Synadia Communications

Synadia Communications Auth Callout API

The auth-callout API from Synadia Communications — 5 operation(s) for auth-callout.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 8

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

DELETE /core/beta/auth-callout/{authCalloutId} Remove an auth callout config · Delete Auth Callout Config #
Ask an LLM
“Can I turn off auth callout and restore the control account's JWT?”
“What happens to the control account when I delete an auth callout config?”
Tell an agent destructive · confirm first
Delete auth callout config {authCalloutId}.
Remove auth callout {authCalloutId} and update its control account JWT.
GET /core/beta/auth-callout/{authCalloutId} Get an auth callout config · Auth Callout Config #
Ask an LLM
“Which control account does an auth callout config use?”
“Can I view the settings of one auth callout configuration?”
Tell an agent
Show auth callout config {authCalloutId}.
Get the details of auth callout {authCalloutId}.
GET /core/beta/auth-callout/{authCalloutId}/target-accounts List auth callout target accounts · Get Target Account List #
Ask an LLM
“Which accounts can auth callout place users into?”
“Can I see the target accounts configured for an auth callout?”
Tell an agent
List target accounts for auth callout {authCalloutId}.
Show which accounts auth callout {authCalloutId} issues users for.
POST /core/beta/auth-callout/{authCalloutId}/target-accounts Add a target account to auth callout · Configure Target Account #
Ask an LLM
“How do I let auth callout issue users into another account?”
“Which signing key groups are needed to configure a target account?”
Tell an agent
Add account {account_id} as a target of auth callout {authCalloutId} using signing key group {sk_group_id} and control group {control_account_sk_group_id}.
Configure {account_id} as a target account on auth callout {authCalloutId}.
DELETE /core/beta/auth-callout/{authCalloutId}/target-accounts/{targetAccountId} Remove a target account from auth callout · Delete Target Account #
Ask an LLM
“Can I stop auth callout from issuing users into a particular account?”
“What's the way to drop one target account entry?”
Tell an agent destructive · confirm first
Remove target account {targetAccountId} from auth callout {authCalloutId}.
Delete target account entry {targetAccountId} on auth callout {authCalloutId}.
GET /core/beta/auth-callout/{authCalloutId}/users List auth callout service users · Get Target Account List #
Ask an LLM
“Which control-account users are allowed to serve auth callout requests?”
“Can I list the NATS users wired up to an auth callout?”
Tell an agent
List the auth callout users for {authCalloutId}.
Show control account users on auth callout {authCalloutId}.
POST /core/beta/auth-callout/{authCalloutId}/users Add a user that serves auth callout · Create Auth Callout User #
Ask an LLM
“How do I authorize my auth service's NATS user to handle callout requests?”
“Can an existing NATS user become an auth callout user?”
Tell an agent
Add NATS user {nats_user_id} as an auth callout user on {authCalloutId}.
Let user {nats_user_id} answer auth callout requests for {authCalloutId}.
DELETE /core/beta/auth-callout/{authCalloutId}/users/{acUserId} Remove an auth callout user · Delete Control Account User #
Ask an LLM
“Can I revoke a control account user's access to auth callout?”
“What's the way to remove a user from serving auth callout?”
Tell an agent destructive · confirm first
Remove auth callout user {acUserId} from {authCalloutId}.
Revoke callout access for user {acUserId} on auth callout {authCalloutId}.

Documentation

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

Specifications

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

Other Resources

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

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for apis

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

Call it yourself

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

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

Get an API key

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

GitHub Google LinkedIn

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

OpenAPI Specification

synadia-communications-auth-callout-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Auth Callout API
  version: beta
servers:
- description: Path to Synadia Control Plane Server Api
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: ''
security:
- bearerAuth: []
  sessionAuth: []
tags:
- name: auth-callout
paths:
  /core/beta/auth-callout/{authCalloutId}:
    delete:
      description: Remove auth callout config and update the control account jwt
      operationId: deleteAuthCallout
      parameters:
      - explode: false
        in: path
        name: authCalloutId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Delete Auth Callout Config
      tags:
      - auth-callout
      x-doc-tags:
      - Auth Callout
    get:
      description: Returns the Auth Callout Config
      operationId: getAuthCallout
      parameters:
      - explode: false
        in: path
        name: authCalloutId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthCalloutViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Auth Callout Config
      tags:
      - auth-callout
      x-doc-tags:
      - Auth Callout
  /core/beta/auth-callout/{authCalloutId}/target-accounts:
    get:
      description: Get a list of configured Target Accounts
      operationId: listAuthCalloutTargetAccounts
      parameters:
      - explode: false
        in: path
        name: authCalloutId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthCalloutTargetAccountListResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Target Account List
      tags:
      - auth-callout
      x-doc-tags:
      - Auth Callout
    post:
      description: Configure a target account
      operationId: addAuthCalloutTargetAccount
      parameters:
      - explode: false
        in: path
        name: authCalloutId
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthCalloutAddTargetAccountRequest'
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Configure Target Account
      tags:
      - auth-callout
      x-doc-tags:
      - Auth Callout
  /core/beta/auth-callout/{authCalloutId}/target-accounts/{targetAccountId}:
    delete:
      description: Remove configured target account entry
      operationId: deleteAuthCalloutTargetAccount
      parameters:
      - explode: false
        in: path
        name: authCalloutId
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: targetAccountId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Delete Target Account
      tags:
      - auth-callout
      x-doc-tags:
      - Auth Callout
  /core/beta/auth-callout/{authCalloutId}/users:
    get:
      description: Get a list of configured Target Accounts
      operationId: listAuthCalloutUsers
      parameters:
      - explode: false
        in: path
        name: authCalloutId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthCalloutUsersListResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Target Account List
      tags:
      - auth-callout
      x-doc-tags:
      - Auth Callout
    post:
      description: Create a Control Account User that can access auth callout
      operationId: addAuthCalloutUser
      parameters:
      - explode: false
        in: path
        name: authCalloutId
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthCalloutAddUserRequest'
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Create Auth Callout User
      tags:
      - auth-callout
      x-doc-tags:
      - Auth Callout
  /core/beta/auth-callout/{authCalloutId}/users/{acUserId}:
    delete:
      description: Remove control account auth callout user
      operationId: deleteAuthCalloutUser
      parameters:
      - explode: false
        in: path
        name: authCalloutId
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: acUserId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Delete Control Account User
      tags:
      - auth-callout
      x-doc-tags:
      - Auth Callout
components:
  schemas:
    AuthCalloutAddUserRequest:
      example:
        nats_user_id: nats_user_id
      properties:
        nats_user_id:
          type: string
      required:
      - nats_user_id
      type: object
    AuthCalloutTargetAccountViewResponse:
      example:
        target_account_name: target_account_name
        control_account_sk_group_id: control_account_sk_group_id
        target_account_id: target_account_id
        control_account_sk_group_name: control_account_sk_group_name
        target_account_sk_group_id: target_account_sk_group_id
        id: id
        target_account_sk_group_name: target_account_sk_group_name
      properties:
        control_account_sk_group_id:
          type: string
        control_account_sk_group_name:
          type: string
        id:
          type: string
        target_account_id:
          type: string
        target_account_name:
          type: string
        target_account_sk_group_id:
          type: string
        target_account_sk_group_name:
          type: string
      required:
      - control_account_sk_group_id
      - control_account_sk_group_name
      - id
      - target_account_id
      - target_account_name
      - target_account_sk_group_id
      - target_account_sk_group_name
      type: object
    AuthCalloutTargetAccountListResponse:
      example:
        items:
        - target_account_name: target_account_name
          control_account_sk_group_id: control_account_sk_group_id
          target_account_id: target_account_id
          control_account_sk_group_name: control_account_sk_group_name
          target_account_sk_group_id: target_account_sk_group_id
          id: id
          target_account_sk_group_name: target_account_sk_group_name
        - target_account_name: target_account_name
          control_account_sk_group_id: control_account_sk_group_id
          target_account_id: target_account_id
          control_account_sk_group_name: control_account_sk_group_name
          target_account_sk_group_id: target_account_sk_group_id
          id: id
          target_account_sk_group_name: target_account_sk_group_name
      properties:
        items:
          items:
            $ref: '#/components/schemas/AuthCalloutTargetAccountViewResponse'
          type: array
      required:
      - items
      type: object
    AuthCalloutAddTargetAccountRequest:
      example:
        sk_group_id: sk_group_id
        account_id: account_id
        control_account_sk_group_id: control_account_sk_group_id
      properties:
        account_id:
          type: string
        control_account_sk_group_id:
          type: string
        sk_group_id:
          type: string
      required:
      - account_id
      - control_account_sk_group_id
      - sk_group_id
      type: object
    AuthCalloutAuthenticatorConfigViewResponse:
      example:
        id: id
        type: type
        config: config
        enabled: true
      properties:
        config:
          type: string
        enabled:
          type: boolean
        id:
          type: string
        type:
          type: string
      required:
      - config
      - enabled
      - id
      - type
      type: object
    AuthCalloutConfig:
      example:
        xkey_public: xkey_public
        control_account_id: control_account_id
        system_id: system_id
        id: id
      properties:
        control_account_id:
          type: string
        id:
          type: string
        system_id:
          type: string
        xkey_public:
          type: string
      required:
      - control_account_id
      - id
      - system_id
      type: object
    AuthCalloutViewResponse:
      allOf:
      - $ref: '#/components/schemas/AuthCalloutConfig'
      example:
        authenticators:
        - id: id
          type: type
          config: config
          enabled: true
        - id: id
          type: type
          config: config
          enabled: true
        target_accounts:
        - target_account_name: target_account_name
          control_account_sk_group_id: control_account_sk_group_id
          target_account_id: target_account_id
          control_account_sk_group_name: control_account_sk_group_name
          target_account_sk_group_id: target_account_sk_group_id
          id: id
          target_account_sk_group_name: target_account_sk_group_name
        - target_account_name: target_account_name
          control_account_sk_group_id: control_account_sk_group_id
          target_account_id: target_account_id
          control_account_sk_group_name: control_account_sk_group_name
          target_account_sk_group_id: target_account_sk_group_id
          id: id
          target_account_sk_group_name: target_account_sk_group_name
        users:
        - name: name
          id: id
          nats_user_id: nats_user_id
        - name: name
          id: id
          nats_user_id: nats_user_id
      properties:
        authenticators:
          items:
            $ref: '#/components/schemas/AuthCalloutAuthenticatorConfigViewResponse'
          type: array
        target_accounts:
          items:
            $ref: '#/components/schemas/AuthCalloutTargetAccountViewResponse'
          type: array
        users:
          items:
            $ref: '#/components/schemas/AuthCalloutUserViewResponse'
          type: array
      type: object
    AuthCalloutUserViewResponse:
      example:
        name: name
        id: id
        nats_user_id: nats_user_id
      properties:
        id:
          type: string
        name:
          type: string
        nats_user_id:
          type: string
      required:
      - id
      - name
      - nats_user_id
      type: object
    AuthCalloutUsersListResponse:
      example:
        items:
        - name: name
          id: id
          nats_user_id: nats_user_id
        - name: name
          id: id
          nats_user_id: nats_user_id
      properties:
        items:
          items:
            $ref: '#/components/schemas/AuthCalloutUserViewResponse'
          type: array
      required:
      - items
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: Personal Access Token
      scheme: bearer
      type: http
    sessionAuth:
      in: cookie
      name: control_plane_session
      type: apiKey