> ## 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.

# Email your IT admin a setup link

> Has WorkOS, Pomerado's sign-in provider, email your team's IT admin one link to verify your domain and set up single sign-on and Directory Sync in its Admin Portal.

> [accordion] Details
>
> Owners only: whoever sets up the directory decides everyone's role.
>
> * The link works for 30 days and goes only to that address; Pomerado never sees it. Follow their progress with GET /v1/team/sso.
>
> * A team has one setup email at a time. While an earlier one's link still works this sends nothing and answers setup\_email\_active; send replace: true to replace it, and the earlier link stops working. Replacing also removes every earlier address from your team's WorkOS IT contacts, so only the new one gets WorkOS's notices.
>
> * A team sends up to 5 setup emails at once, then one every 12 minutes; past that it answers setup\_email\_throttled.
>
> * **Callers:** an API key, an MCP OAuth token or a Dashboard session.
>
> * **Permission:** `team:manage`; an API key also needs `team:manage`.
>
> * **Effect:** Creates or changes something.
>
> * **Errors:** [`invalid_email`](https://docs.pomerado.ai/errors#invalid_email), [`setup_email_active`](https://docs.pomerado.ai/errors#setup_email_active), [`setup_email_throttled`](https://docs.pomerado.ai/errors#setup_email_throttled), [`team_unavailable`](https://docs.pomerado.ai/errors#team_unavailable), [`role_permission_missing`](https://docs.pomerado.ai/errors#role_permission_missing), [`owner_required`](https://docs.pomerado.ai/errors#owner_required), and the [errors any request can get](https://docs.pomerado.ai/errors.md).


## OpenAPI

````yaml /api-reference/openapi.json post /v1/team/sso/it-admin-invitations
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/it-admin-invitations:
    post:
      tags:
        - sso
      summary: Email your IT admin a setup link
      description: >-
        Has WorkOS, Pomerado's sign-in provider, email your team's IT admin one
        link to verify your domain and set up single sign-on and Directory Sync
        in its Admin Portal.
      operationId: sso.invite_it_admin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                  description: >-
                    Your IT admin's email address, where WorkOS sends the setup
                    link
                  maxLength: 320
                replace:
                  type: boolean
                  description: >-
                    Send a new email even though an earlier one's link still
                    works, which then stops working. Default: false
              additionalProperties: false
      responses:
        '201':
          description: WorkOS is sending the setup email
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamSsoItAdminInvitation'
        '400':
          description: invalid_request, invalid_email
          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, owner_required, forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: setup_email_active
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: request_too_large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: setup_email_throttled
          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:
    TeamSsoItAdminInvitation:
      type: object
      required:
        - email
        - replaced
      properties:
        email:
          type: string
          description: Where WorkOS sent the setup email
        replaced:
          type: boolean
          description: >-
            Whether it replaced an earlier setup email, whose link stopped
            working
      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.