Slack Tests API

openapi: 3.1.0
info:
  version: '1.0'
  title: Slack Admin Access Tests 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: Tests
paths:
  /auth.test:
    get:
      tags:
      - Tests
      description: Checks authentication & identity.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/auth.test
      operationId: getAuthTest
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `none`'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Standard success response when used with a user token
          content:
            application/json:
              schema:
                title: auth.test success schema
                required:
                - ok
                - team
                - team_id
                - url
                - user
                - user_id
                type: object
                properties:
                  bot_id:
                    $ref: '#/components/schemas/defs_bot_id'
                  is_enterprise_install:
                    type: boolean
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                  team:
                    type: string
                  team_id:
                    $ref: '#/components/schemas/defs_team'
                  url:
                    type: string
                  user:
                    type: string
                  user_id:
                    $ref: '#/components/schemas/defs_user_id'
                additionalProperties: false
                description: Schema for successful response auth.test method
              example:
                ok: true
                team: Subarachnoid Workspace
                team_id: T12345678
                url: https://subarachnoid.slack.com/
                user: grace
                user_id: W12345678
        default:
          description: Standard failure response when used with an invalid token
          content:
            application/json:
              schema:
                title: auth.test error schema
                required:
                - error
                - ok
                type: object
                properties:
                  callstack:
                    type: string
                    description: 'Note: PHP callstack is only visible in dev/qa'
                  error:
                    type: string
                    enum:
                    - not_authed
                    - invalid_auth
                    - token_revoked
                    - account_inactive
                    - invalid_arg_name
                    - invalid_array_arg
                    - invalid_charset
                    - invalid_form_data
                    - invalid_post_type
                    - missing_post_type
                    - invalid_json
                    - json_not_object
                    - request_timeout
                    - upgrade_required
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: false
                description: Schema for error response auth.test method
              example:
                error: invalid_auth
                ok: false
      security:
      - slackAuth:
        - none
      summary: Slack Get Auth Test
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api.test:
    get:
      tags:
      - Tests
      description: Checks API calling code.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/api.test
      operationId: getApiTest
      parameters:
      - name: error
        in: query
        description: Error response to return
        schema:
          type: string
      - name: foo
        in: query
        description: example property to return
        schema:
          type: string
      responses:
        '200':
          description: Standard success response
          content:
            application/json:
              schema:
                title: api.test success schema
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                additionalProperties:
                  type: object
                  properties: {}
                description: Schema for successful response api.test method
              example:
                ok: true
        default:
          description: Artificial error response
          content:
            application/json:
              schema:
                title: api.test error schema
                required:
                - error
                - ok
                type: object
                properties:
                  error:
                    type: string
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties:
                  type: object
                  properties: {}
                description: Schema for error response api.test method
              example:
                args:
                  error: my_error
                error: my_error
                ok: false
      security:
      - slackAuth:
        - none
      summary: Slack Get Api Test
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        PullTagsFromSummary: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK