openapi: 3.1.0
info:
  version: '1.0'
  title: Slack Admin Access Assign API
  description: "The Slack Admin API is a set of privileged endpoints\x14primarily under admin.* with related SCIM and Audit Logs APIs\x14that lets Enterprise Grid owners and admins automate organization\x11 wide management and governance. It covers user lifecycle (provision, suspend, assign roles), workspace and channel administration across workspaces (create, move, archive channels; manage membership and settings), app governance (approve/deny or allowlist/ban apps and install them to workspaces), invite request handling, and security/compliance controls such as information barriers, session and authentication policies, and org\x11level analytics exports. These APIs require elevated admin scopes and are commonly used to power automated onboarding/offboarding, centralized channel and app controls, and integrations with identity, ITSM, and compliance systems."
tags:
- name: Assign
paths:
  /admin.users.assign:
    post:
      tags:
      - Assign
      description: Add an Enterprise user to a workspace.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/admin.users.assign
      operationId: postAdminUsersAssign
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `admin.users:write`'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - team_id
              - user_id
              type: object
              properties:
                team_id:
                  type: string
                  description: The ID (`T1234`) of the workspace.
                user_id:
                  type: string
                  description: The ID of the user to add to the workspace.
                is_restricted:
                  type: boolean
                  description: True if user should be added to the workspace as a guest.
                is_ultra_restricted:
                  type: boolean
                  description: True if user should be added to the workspace as a single-channel guest.
                channel_ids:
                  type: string
                  description: Comma separated values of channel IDs to add user in the new workspace.
          application/json:
            schema:
              required:
              - team_id
              - user_id
              type: object
              properties:
                team_id:
                  type: string
                  description: The ID (`T1234`) of the workspace.
                user_id:
                  type: string
                  description: The ID of the user to add to the workspace.
                is_restricted:
                  type: boolean
                  description: True if user should be added to the workspace as a guest.
                is_ultra_restricted:
                  type: boolean
                  description: True if user should be added to the workspace as a single-channel guest.
                channel_ids:
                  type: string
                  description: Comma separated values of channel IDs to add user in the new workspace.
        required: true
      responses:
        '200':
          description: Typical success response
          content:
            application/json:
              schema:
                title: Default success template
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                additionalProperties: true
                description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
              example:
                ok: true
        default:
          description: Typical error response
          content:
            application/json:
              schema:
                title: Default error template
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: true
                description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
              example:
                error: invalid_auth
                ok: false
      security:
      - slackAuth:
        - admin.users:write
      summary: Slack Post Admin Users Assign
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK