Synadia Communications

Synadia Communications Oidc Provider API

The oidc-provider API from Synadia Communications — 3 operation(s) for oidc-provider.

GitHub OpenAPI

Operations 6

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

GET /core/beta/oidc-providers List configured OIDC sign-in providers · List OIDC Providers #
Ask an LLM
“Which OIDC identity providers are set up for single sign-on?”
“Where do I see all OIDC providers configured for login?”
Tell an agent
List the OIDC providers.
Show every configured OIDC sign-in provider.
POST /core/beta/oidc-providers Add an OIDC sign-in provider · Create OIDC Provider #
Ask an LLM
“How do I set up single sign-on with an OIDC identity provider?”
“Can I map identity provider groups to roles when adding OIDC?”
Tell an agent
Add an OIDC provider for domain {domain}, enabled={enabled}, with client ID {client_id} and issuer {issuer}.
Configure OIDC login for domain {domain} with Microsoft tenant {tenant}, enabled={enabled}.
DELETE /core/beta/oidc-providers/{oidcProviderId} Remove an OIDC provider · Delete OIDC Provider #
Ask an LLM
“Can I remove an OIDC provider so it's no longer used for login?”
“How do I delete an SSO identity provider configuration?”
Tell an agent destructive · confirm first
Delete OIDC provider {provider}.
Remove the OIDC sign-in provider {provider}.
GET /core/beta/oidc-providers/{oidcProviderId} Look up one OIDC provider · Get OIDC Provider #
Ask an LLM
“How can I view the settings of a specific OIDC provider?”
“What issuer and client ID is a given OIDC provider using?”
Tell an agent
Show OIDC provider {provider}.
Get the configuration of OIDC provider {provider}.
PATCH /core/beta/oidc-providers/{oidcProviderId} Change an OIDC provider's settings · Update OIDC Provider #
Ask an LLM
“How do I rotate the client secret on an existing OIDC provider?”
“Can I disable an OIDC provider temporarily without deleting it?”
Tell an agent
Update OIDC provider {provider} with client secret {secret}.
Set enabled to {enabled} on OIDC provider {provider}.
GET /core/beta/oidc-providers/defaults List default OIDC provider templates · List OIDC Provider Defaults #
Ask an LLM
“What default settings are offered for common OIDC identity providers?”
“Are there preset OIDC provider defaults I can start from?”
Tell an agent
List the OIDC provider defaults.
Show the preset OIDC provider templates.

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-oidc-provider-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-oidc-provider-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-oidc-provider-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Oidc Provider API
  version: beta
servers:
- description: Path to Synadia Control Plane Server Api
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: ''
security:
- bearerAuth: []
  sessionAuth: []
tags:
- name: Oidc Provider
paths:
  /core/beta/oidc-providers:
    get:
      description: Returns a list of OIDC providers
      operationId: listOidcProviders
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcProviderListResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: List OIDC Providers
      tags:
      - Oidc Provider
      x-doc-tags:
      - OIDC Providers
    post:
      description: Creates a new OIDC provider
      operationId: createOidcProvider
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OidcProviderAddRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcProviderViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Create OIDC Provider
      tags:
      - Oidc Provider
      x-doc-tags:
      - OIDC Providers
  /core/beta/oidc-providers/{oidcProviderId}:
    delete:
      description: Deletes an OIDC provider
      operationId: deleteOidcProvider
      parameters:
      - explode: false
        in: path
        name: oidcProviderId
        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 OIDC Provider
      tags:
      - Oidc Provider
      x-doc-tags:
      - OIDC Providers
    get:
      description: Returns an OIDC provider by ID
      operationId: getOidcProvider
      parameters:
      - explode: false
        in: path
        name: oidcProviderId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcProviderViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get OIDC Provider
      tags:
      - Oidc Provider
      x-doc-tags:
      - OIDC Providers
    patch:
      description: Updates an OIDC provider
      operationId: updateOidcProvider
      parameters:
      - explode: false
        in: path
        name: oidcProviderId
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OidcProviderUpdateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcProviderViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Update OIDC Provider
      tags:
      - Oidc Provider
      x-doc-tags:
      - OIDC Providers
  /core/beta/oidc-providers/defaults:
    get:
      description: Returns a list of OIDC provider defaults
      operationId: listOidcDefaultProvider
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcProviderDefaultsListResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: List OIDC Provider Defaults
      tags:
      - Oidc Provider
      x-doc-tags:
      - OIDC Providers
components:
  schemas:
    GroupMapping:
      example:
        team_assignments:
        - role: role
          system_assignments:
          - role: role
            system_id: system_id
            system_name: system_name
            account_assignments:
            - account_id: account_id
              role: role
              account_name: account_name
            - account_id: account_id
              role: role
              account_name: account_name
          - role: role
            system_id: system_id
            system_name: system_name
            account_assignments:
            - account_id: account_id
              role: role
              account_name: account_name
            - account_id: account_id
              role: role
              account_name: account_name
          team_id: team_id
          team_name: team_name
        - role: role
          system_assignments:
          - role: role
            system_id: system_id
            system_name: system_name
            account_assignments:
            - account_id: account_id
              role: role
              account_name: account_name
            - account_id: account_id
              role: role
              account_name: account_name
          - role: role
            system_id: system_id
            system_name: system_name
            account_assignments:
            - account_id: account_id
              role: role
              account_name: account_name
            - account_id: account_id
              role: role
              account_name: account_name
          team_id: team_id
          team_name: team_name
        app_role: app_role
      properties:
        app_role:
          type: string
        team_assignments:
          items:
            $ref: '#/components/schemas/TeamAssignment'
          type: array
      type: object
    TeamAssignment:
      example:
        role: role
        system_assignments:
        - role: role
          system_id: system_id
          system_name: system_name
          account_assignments:
          - account_id: account_id
            role: role
            account_name: account_name
          - account_id: account_id
            role: role
            account_name: account_name
        - role: role
          system_id: system_id
          system_name: system_name
          account_assignments:
          - account_id: account_id
            role: role
            account_name: account_name
          - account_id: account_id
            role: role
            account_name: account_name
        team_id: team_id
        team_name: team_name
      properties:
        role:
          type: string
        system_assignments:
          items:
            $ref: '#/components/schemas/SystemAssignment'
          type: array
        team_id:
          type: string
        team_name:
          type: string
      required:
      - role
      - team_id
      type: object
    OidcProviderViewResponse:
      example:
        issuer_url: issuer_url
        created: 2000-01-23 04:56:07+00:00
        mapper: mapper
        label: label
        claims_source: claims_source
        client_id: client_id
        enabled: true
        microsoft_subject_source: microsoft_subject_source
        additional_id_token_audiences:
        - additional_id_token_audiences
        - additional_id_token_audiences
        requested_claims: ''
        provider: provider
        domain: domain
        scope:
        - scope
        - scope
        claims: claims
        auth_url: auth_url
        id: id
        group_role_mappings:
          key:
            team_assignments:
            - role: role
              system_assignments:
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              team_id: team_id
              team_name: team_name
            - role: role
              system_assignments:
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              team_id: team_id
              team_name: team_name
            app_role: app_role
        token_url: token_url
        microsoft_tenant: microsoft_tenant
      properties:
        additional_id_token_audiences:
          items:
            type: string
          type: array
        auth_url:
          type: string
        claims:
          type: string
        claims_source:
          type: string
        client_id:
          type: string
        created:
          format: date-time
          type: string
        domain:
          type: string
        enabled:
          type: boolean
        group_role_mappings:
          additionalProperties:
            $ref: '#/components/schemas/GroupMapping'
          type: object
        id:
          type: string
        issuer_url:
          type: string
        label:
          type: string
        mapper:
          type: string
        microsoft_subject_source:
          type: string
        microsoft_tenant:
          type: string
        provider:
          type: string
        requested_claims: {}
        scope:
          items:
            type: string
          type: array
        token_url:
          type: string
      required:
      - created
      - domain
      - enabled
      - id
      type: object
    OidcProviderAddRequest:
      example:
        issuer_url: issuer_url
        mapper: mapper
        label: label
        claims_source: claims_source
        client_id: client_id
        enabled: true
        microsoft_subject_source: microsoft_subject_source
        additional_id_token_audiences:
        - additional_id_token_audiences
        - additional_id_token_audiences
        requested_claims: ''
        provider: provider
        domain: domain
        scope:
        - scope
        - scope
        claims: claims
        auth_url: auth_url
        client_secret: client_secret
        group_role_mappings:
          key:
            team_assignments:
            - role: role
              system_assignments:
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              team_id: team_id
              team_name: team_name
            - role: role
              system_assignments:
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              team_id: team_id
              team_name: team_name
            app_role: app_role
        token_url: token_url
        microsoft_tenant: microsoft_tenant
      properties:
        additional_id_token_audiences:
          items:
            type: string
          type: array
        auth_url:
          type: string
        claims:
          type: string
        claims_source:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        domain:
          type: string
        enabled:
          type: boolean
        group_role_mappings:
          additionalProperties:
            $ref: '#/components/schemas/GroupMapping'
          type: object
        issuer_url:
          type: string
        label:
          type: string
        mapper:
          type: string
        microsoft_subject_source:
          type: string
        microsoft_tenant:
          type: string
        provider:
          type: string
        requested_claims: {}
        scope:
          items:
            type: string
          type: array
        token_url:
          type: string
      required:
      - domain
      - enabled
      type: object
    AccountAssignment:
      example:
        account_id: account_id
        role: role
        account_name: account_name
      properties:
        account_id:
          type: string
        account_name:
          type: string
        role:
          type: string
      required:
      - account_id
      - role
      type: object
    SystemAssignment:
      example:
        role: role
        system_id: system_id
        system_name: system_name
        account_assignments:
        - account_id: account_id
          role: role
          account_name: account_name
        - account_id: account_id
          role: role
          account_name: account_name
      properties:
        account_assignments:
          items:
            $ref: '#/components/schemas/AccountAssignment'
          type: array
        role:
          type: string
        system_id:
          type: string
        system_name:
          type: string
      required:
      - role
      - system_id
      type: object
    OidcProviderUpdateRequest:
      example:
        issuer_url: issuer_url
        mapper: mapper
        label: label
        claims_source: claims_source
        client_id: client_id
        enabled: true
        microsoft_subject_source: microsoft_subject_source
        additional_id_token_audiences:
        - additional_id_token_audiences
        - additional_id_token_audiences
        requested_claims: ''
        provider: provider
        scope:
        - scope
        - scope
        claims: claims
        auth_url: auth_url
        client_secret: client_secret
        group_role_mappings:
          key:
            team_assignments:
            - role: role
              system_assignments:
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              team_id: team_id
              team_name: team_name
            - role: role
              system_assignments:
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              - role: role
                system_id: system_id
                system_name: system_name
                account_assignments:
                - account_id: account_id
                  role: role
                  account_name: account_name
                - account_id: account_id
                  role: role
                  account_name: account_name
              team_id: team_id
              team_name: team_name
            app_role: app_role
        token_url: token_url
        microsoft_tenant: microsoft_tenant
      properties:
        additional_id_token_audiences:
          items:
            type: string
          type: array
        auth_url:
          type: string
        claims:
          type: string
        claims_source:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        enabled:
          type: boolean
        group_role_mappings:
          additionalProperties:
            $ref: '#/components/schemas/GroupMapping'
          type: object
        issuer_url:
          type: string
        label:
          type: string
        mapper:
          type: string
        microsoft_subject_source:
          type: string
        microsoft_tenant:
          type: string
        provider:
          type: string
        requested_claims: {}
        scope:
          items:
            type: string
          type: array
        token_url:
          type: string
      type: object
    OidcProviderDefaultsResponse:
      example:
        provider: provider
        claims:
        - claims
        - claims
        scopes:
        - scopes
        - scopes
      properties:
        claims:
          items:
            type: string
          type: array
        provider:
          type: string
        scopes:
          items:
            type: string
          type: array
      required:
      - claims
      - provider
      - scopes
      type: object
    OidcProviderListResponse:
      example:
        items:
        - issuer_url: issuer_url
          created: 2000-01-23 04:56:07+00:00
          mapper: mapper
          label: label
          claims_source: claims_source
          client_id: client_id
          enabled: true
          microsoft_subject_source: microsoft_subject_source
          additional_id_token_audiences:
          - additional_id_token_audiences
          - additional_id_token_audiences
          requested_claims: ''
          provider: provider
          domain: domain
          scope:
          - scope
          - scope
          claims: claims
          auth_url: auth_url
          id: id
          group_role_mappings:
            key:
              team_assignments:
              - role: role
                system_assignments:
                - role: role
                  system_id: system_id
                  system_name: system_name
                  account_assignments:
                  - account_id: account_id
                    role: role
                    account_name: account_name
                  - account_id: account_id
                    role: role
                    account_name: account_name
                - role: role
                  system_id: system_id
                  system_name: system_name
                  account_assignments:
                  - account_id: account_id
                    role: role
                    account_name: account_name
                  - account_id: account_id
                    role: role
                    account_name: account_name
                team_id: team_id
                team_name: team_name
              - role: role
                system_assignments:
                - role: role
                  system_id: system_id
                  system_name: system_name
                  account_assignments:
                  - account_id: account_id
                    role: role
                    account_name: account_name
                  - account_id: account_id
                    role: role
                    account_name: account_name
                - role: role
                  system_id: system_id
                  system_name: system_name
                  account_assignments:
                  - account_id: account_id
                    role: role
                    account_name: account_name
                  - account_id: account_id
                    role: role
                    account_name: account_name
                team_id: team_id
                team_name: team_name
              app_role: app_role
          token_url: token_url
          microsoft_tenant: microsoft_tenant
        - issuer_url: issuer_url
          created: 2000-01-23 04:56:07+00:00
          mapper: mapper
          label: label
          claims_source: claims_source
          client_id: client_id
          enabled: true
          microsoft_subject_source: microsoft_subject_source
          additional_id_token_audiences:
          - additional_id_token_audiences
          - additional_id_token_audiences
          requested_claims: ''
          provider: provider
          domain: domain
          scope:
          - scope
          - scope
          claims: claims
          auth_url: auth_url
          id: id
          group_role_mappings:
            key:
              team_assignments:
              - role: role
                system_assignments:
                - role: role
                  system_id: system_id
                  system_name: system_name
                  account_assignments:
                  - account_id: account_id
                    role: role
                    account_name: account_name
                  - account_id: account_id
                    role: role
                    account_name: account_name
                - role: role
                  system_id: system_id
                  system_name: system_name
                  account_assignments:
                  - account_id: account_id
                    role: role
                    account_name: account_name
                  - account_id: account_id
                    role: role
                    account_name: account_name
                team_id: team_id
                team_name: team_name
              - role: role
                system_assignments:
                - role: role
                  system_id: system_id
                  system_name: system_name
                  account_assignments:
                  - account_id: account_id
                    role: role
                    account_name: account_name
                  - account_id: account_id
                    role: role
                    account_name: account_name
                - role: role
                  system_id: system_id
                  system_name: system_name
                  account_assignments:
                  - account_id: account_id
                    role: role
                    account_name: account_name
                  - account_id: account_id
                    role: role
                    account_name: account_name
                team_id: team_id
                team_name: team_name
              app_role: app_role
          token_url: token_url
          microsoft_tenant: microsoft_tenant
      properties:
        items:
          items:
            $ref: '#/components/schemas/OidcProviderViewResponse'
          type: array
      required:
      - items
      type: object
    OidcProviderDefaultsListResponse:
      example:
        items:
        - provider: provider
          claims:
          - claims
          - claims
          scopes:
          - scopes
          - scopes
        - provider: provider
          claims:
          - claims
          - claims
          scopes:
          - scopes
          - scopes
      properties:
        items:
          items:
            $ref: '#/components/schemas/OidcProviderDefaultsResponse'
          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