openapi: 3.0.1
info:
  title: Scalekit Admin Portal Connections API
  description: Scalekit is the authentication platform for B2B SaaS and AI agents. The REST API provides programmatic access to enterprise Single Sign-On (SAML / OIDC connections), SCIM directory provisioning, organizations, users and memberships, organization roles, machine-to-machine (M2M) authentication, and agent / MCP connected accounts and tool execution. The API base URL is per-environment; access tokens are obtained via the OAuth 2.0 client credentials grant and passed as Bearer tokens.
  termsOfService: https://www.scalekit.com/legal/terms-of-service
  contact:
    name: Scalekit Support
    url: https://www.scalekit.com
    email: support@scalekit.com
  version: '1.0'
servers:
- url: https://{environment}.scalekit.com
  description: Production environment (per-tenant subdomain)
  variables:
    environment:
      default: your-subdomain
      description: Your Scalekit environment subdomain.
- url: https://{environment}.scalekit.dev
  description: Development environment (per-tenant subdomain)
  variables:
    environment:
      default: your-subdomain
      description: Your Scalekit development environment subdomain.
security:
- bearerAuth: []
tags:
- name: Connections
  description: Enterprise SSO connections (SAML / OIDC).
paths:
  /api/v1/connections:
    get:
      operationId: listConnections
      tags:
      - Connections
      summary: List connections
      description: Retrieve a list of SSO connections in the environment.
      parameters:
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PageToken'
      - name: organization_id
        in: query
        required: false
        description: Filter connections by organization.
        schema:
          type: string
      responses:
        '200':
          description: A list of connections.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectionsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/organizations/{organization_id}/connections:
    parameters:
    - $ref: '#/components/parameters/OrganizationIdPath'
    get:
      operationId: listOrganizationConnections
      tags:
      - Connections
      summary: List an organization's connections
      responses:
        '200':
          description: A list of the organization's SSO connections.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectionsResponse'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/organizations/{organization_id}/connections/{id}:
    parameters:
    - $ref: '#/components/parameters/OrganizationIdPath'
    - $ref: '#/components/parameters/ConnectionId'
    get:
      operationId: getConnection
      tags:
      - Connections
      summary: Get a connection
      description: Retrieve configuration and status details for a specific SSO connection.
      responses:
        '200':
          description: The connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    OrganizationIdPath:
      name: organization_id
      in: path
      required: true
      description: Organization identifier.
      schema:
        type: string
    ConnectionId:
      name: id
      in: path
      required: true
      description: Connection identifier.
      schema:
        type: string
    PageSize:
      name: page_size
      in: query
      required: false
      description: Maximum number of results per page.
      schema:
        type: integer
        default: 20
    PageToken:
      name: page_token
      in: query
      required: false
      description: Opaque token for the next page of results.
      schema:
        type: string
  responses:
    Unauthorized:
      description: Authentication failed or access token missing/expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    ListConnectionsResponse:
      type: object
      properties:
        connections:
          type: array
          items:
            $ref: '#/components/schemas/Connection'
        next_page_token:
          type: string
    Connection:
      type: object
      properties:
        id:
          type: string
        organization_id:
          type: string
        provider:
          type: string
          example: okta
        type:
          type: string
          enum:
          - SSO_SAML
          - SSO_OIDC
        status:
          type: string
          enum:
          - DRAFT
          - PENDING
          - ACTIVE
          - INACTIVE
        enabled:
          type: boolean
        create_time:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: array
          items:
            type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 client-credentials access token passed as a Bearer token.
    oauth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{environment}.scalekit.com/oauth/token
          scopes: {}