> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pomerado.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the team's single sign-on setup

> Returns your Business team's single sign-on setup as WorkOS has it now: its SSO connections (SAML or OIDC, such as Okta), its Directory Sync (SCIM) directories and its domains, each with its state.

> [accordion] Details
>
> Owners and Admins only.
>
> * **Callers:** an API key, an MCP OAuth token or a Dashboard session.
> * **Permission:** `team:manage`; an API key also needs `team:manage`.
> * **Effect:** Changes nothing.
> * **Errors:** [`team_unavailable`](https://docs.pomerado.ai/errors#team_unavailable), [`role_permission_missing`](https://docs.pomerado.ai/errors#role_permission_missing), and the [errors any request can get](https://docs.pomerado.ai/errors.md).


## OpenAPI

````yaml /api-reference/openapi.json get /v1/team/sso
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: account
    x-group: Account
  - name: api_keys
    x-group: API keys
  - name: connected_apps
    x-group: Connected apps
  - name: usage
    x-group: Usage
  - name: quota
    x-group: Quota
  - name: billing
    x-group: Billing
  - name: integrations
    x-group: Integrations
  - name: connect
    x-group: Connect
  - name: code
    x-group: Code
  - name: logins
    x-group: Saved logins
  - name: two_factor
    x-group: 2FA
  - name: login_access
    x-group: Login access
  - name: tools
    x-group: Tools
  - name: webhooks
    x-group: Webhooks
  - name: runs
    x-group: Runs
  - name: builds
    x-group: Builds
  - name: jobs
    x-group: Jobs
  - name: suggestions
    x-group: Suggestions
  - name: audit
    x-group: Audit
  - name: files
    x-group: Files
  - name: team
    x-group: Team
  - name: sso
    x-group: Single sign-on
  - name: issue_reports
    x-group: Problem reports
paths:
  /v1/team/sso:
    get:
      tags:
        - sso
      summary: Get the team's single sign-on setup
      description: >-
        Returns your Business team's single sign-on setup as WorkOS has it now:
        its SSO connections (SAML or OIDC, such as Okta), its Directory Sync
        (SCIM) directories and its domains, each with its state.
      operationId: sso.get
      responses:
        '200':
          description: The team's SSO setup
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamSso'
        '400':
          description: invalid_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: team_unavailable, role_permission_missing, forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    TeamSso:
      type: object
      required:
        - connections
        - directories
        - domains
      properties:
        connections:
          type: array
          items:
            type: object
            required:
              - id
              - type
              - state
            properties:
              id:
                type: string
                description: The WorkOS connection ID
              type:
                type: string
                description: >-
                  WorkOS's connection type, such as OktaSAML, EntraIdOIDC or
                  GenericSAML
              state:
                type: string
                description: 'WorkOS''s state: draft, active, inactive or validating'
            additionalProperties: false
          description: SSO connections (SAML or OIDC); only an active one signs in
        directories:
          type: array
          items:
            type: object
            required:
              - id
              - type
              - state
            properties:
              id:
                type: string
                description: The WorkOS directory ID
              type:
                type: string
                description: >-
                  WorkOS's directory type, such as okta scim v2.0 or azure scim
                  v2.0
              state:
                type: string
                description: >-
                  WorkOS's state: active, inactive, validating,
                  invalid_credentials or deleting
            additionalProperties: false
          description: Directory Sync (SCIM) directories
        domains:
          type: array
          items:
            type: object
            required:
              - domain
              - state
            properties:
              domain:
                type: string
              state:
                type: string
                description: 'WorkOS''s state: verified, pending or failed'
            additionalProperties: false
          description: The team's email domains; SSO needs a verified one
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.