Synadia Communications

Synadia Communications Authz API

The authz API from Synadia Communications — 3 operation(s) for authz.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 3

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

POST /core/beta/authz/check Check my authorization for a resource · Check Authz Decisions #
Ask an LLM
“Which policies apply to my session for a given service or resource?”
“Can I check whether I'm allowed to act on a resource before trying?”
Tell an agent
Check my authorization decisions for the current session.
Show which policies apply to me for this resource.
GET /core/beta/authz/policies List authorization policies · Get Policy List #
Ask an LLM
“What app policies are configured?”
“Can I see all the authorization policies in the platform?”
Tell an agent
List the configured app policies.
Show all authorization policies.
GET /core/beta/authz/roles List available roles · Get Authz roles List #
Ask an LLM
“Which roles can I assign to users and service accounts?”
“What app roles are defined?”
Tell an agent
List the available app roles.
Show me every role I can assign.

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-authz-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-authz-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-authz-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Authz API
  version: beta
servers:
- description: Path to Synadia Control Plane Server Api
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: ''
security:
- bearerAuth: []
  sessionAuth: []
tags:
- name: authz
paths:
  /core/beta/authz/check:
    post:
      description: Returns applicable policies for calling session and requested service/resource
      operationId: check
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthzViewRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthzViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Check Authz Decisions
      tags:
      - authz
      x-doc-tags:
      - Authorization
  /core/beta/authz/policies:
    get:
      description: Returns a list of configured app policies
      operationId: listPolicies
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyListResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Policy List
      tags:
      - authz
      x-doc-tags:
      - Authorization
  /core/beta/authz/roles:
    get:
      description: Returns a list of configured app roles
      operationId: listRoles
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleListResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Authz roles List
      tags:
      - authz
      x-doc-tags:
      - Authorization
components:
  schemas:
    AppPolicyStatement:
      example:
        resource:
        - resource
        - resource
        service: service
        effect:
        - null
        - null
        name: name
        action:
        - action
        - action
        operation_id: operation_id
      properties:
        action:
          items:
            type: string
          type: array
        effect:
          items:
            $ref: '#/components/schemas/AppRoleEffect'
          type: array
        name:
          type: string
        operation_id:
          type: string
        resource:
          items:
            type: string
          type: array
        service:
          type: string
      required:
      - action
      - effect
      - name
      - resource
      type: object
    AuthzResponse:
      example:
        operations:
        - operations
        - operations
        service: service
        resource_id: resource_id
      properties:
        operations:
          items:
            type: string
          type: array
        resource_id:
          type: string
        service:
          type: string
      required:
      - operations
      - resource_id
      - service
      type: object
    AuthzViewRequest:
      items:
        $ref: '#/components/schemas/AuthzRequest'
      type: array
    AuthzRequest:
      example:
        service: service
        resource_id: ''
      properties:
        resource_id:
          default: ''
          type: string
        service:
          type: string
      required:
      - resource_id
      - service
      type: object
    PolicyListResponse:
      example:
        items:
        - name: name
          description: description
          statements:
            key:
              resource:
              - resource
              - resource
              service: service
              effect:
              - null
              - null
              name: name
              action:
              - action
              - action
              operation_id: operation_id
          group: null
        - name: name
          description: description
          statements:
            key:
              resource:
              - resource
              - resource
              service: service
              effect:
              - null
              - null
              name: name
              action:
              - action
              - action
              operation_id: operation_id
          group: null
      properties:
        items:
          items:
            $ref: '#/components/schemas/AppPolicy'
          type: array
      required:
      - items
      type: object
    AppRoleScope:
      enum:
      - App
      - Team
      - System
      - Account
      - NatsUser
      type: string
    AuthzViewResponse:
      items:
        $ref: '#/components/schemas/AuthzResponse'
      type: array
    AppPolicyGroup:
      enum:
      - Core
      - Cloud
      - Connectors
      - Workloads
      - SchemaRegistry
      - Insights
      type: string
    AppRole:
      example:
        scope: null
        name: name
        policies:
        - policies
        - policies
        description: description
        id: id
        sort_order: 0.8008281904610115
        enabled: true
      properties:
        description:
          type: string
        enabled:
          type: boolean
        id:
          type: string
        name:
          type: string
        policies:
          items:
            type: string
          type: array
        scope:
          $ref: '#/components/schemas/AppRoleScope'
        sort_order:
          type: number
      required:
      - description
      - enabled
      - id
      - name
      - policies
      - scope
      - sort_order
      type: object
    AppPolicy:
      example:
        name: name
        description: description
        statements:
          key:
            resource:
            - resource
            - resource
            service: service
            effect:
            - null
            - null
            name: name
            action:
            - action
            - action
            operation_id: operation_id
        group: null
      properties:
        description:
          type: string
        group:
          $ref: '#/components/schemas/AppPolicyGroup'
        name:
          type: string
        statements:
          additionalProperties:
            $ref: '#/components/schemas/AppPolicyStatement'
          type: object
      required:
      - group
      - name
      - statements
      type: object
    AppRoleEffect:
      enum:
      - ALLOW
      - DENY
      type: string
    RoleListResponse:
      example:
        items:
        - scope: null
          name: name
          policies:
          - policies
          - policies
          description: description
          id: id
          sort_order: 0.8008281904610115
          enabled: true
        - scope: null
          name: name
          policies:
          - policies
          - policies
          description: description
          id: id
          sort_order: 0.8008281904610115
          enabled: true
      properties:
        items:
          items:
            $ref: '#/components/schemas/AppRole'
          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