openapi: 3.1.0
info:
  version: '1.0'
  title: Slack Admin Access Functions 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: Functions
paths:
  /functions.completeSuccess:
    post:
      tags:
      - Functions
      summary: Complete Function Success
      description: Indicates that a custom function step in a workflow completed successfully.
      operationId: postFunctionsCompleteSuccess
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `functions:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - function_execution_id
              - outputs
              type: object
              properties:
                function_execution_id:
                  type: string
                  description: The execution ID of the function step being completed.
                outputs:
                  type: string
                  description: JSON-encoded map of output values conforming to the function's output schema.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
              example:
                ok: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: invalid_function_execution_id
      security:
      - slackAuth:
        - functions:write
  /functions.completeError:
    post:
      tags:
      - Functions
      summary: Complete Function Error
      description: Indicates that a custom function step in a workflow completed with an error.
      operationId: postFunctionsCompleteError
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `functions:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - function_execution_id
              - error
              type: object
              properties:
                function_execution_id:
                  type: string
                  description: The execution ID of the function step that failed.
                error:
                  type: string
                  description: Error message that will be surfaced to the user via Slackbot.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
              example:
                ok: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: invalid_function_execution_id
      security:
      - slackAuth:
        - functions:write
  /functions.distributions.permissions.add:
    post:
      tags:
      - Functions
      summary: Add Function Distribution Permissions
      description: Adds permissions for distributing a custom function to additional users or workspaces.
      operationId: postFunctionsDistributionsPermissionsAdd
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `functions:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - function_app_id
              - permission_type
              type: object
              properties:
                function_app_id:
                  type: string
                  description: ID of the function app.
                permission_type:
                  type: string
                  description: Type of permission to grant (named_entities, everyone).
                user_ids:
                  type: string
                  description: Comma-separated list of user IDs to grant access to.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
              example:
                ok: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: invalid_auth
      security:
      - slackAuth:
        - functions:write
  /functions.distributions.permissions.list:
    get:
      tags:
      - Functions
      summary: List Function Distribution Permissions
      description: Lists the distribution permissions for a custom function.
      operationId: getFunctionsDistributionsPermissionsList
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `functions:read`'
        required: true
        schema:
          type: string
      - name: function_app_id
        in: query
        description: ID of the function app.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  permission_type:
                    type: string
                  user_ids:
                    type: array
                    items:
                      type: string
              example:
                ok: true
                permission_type: named_entities
                user_ids:
                - U123ABC
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: invalid_auth
      security:
      - slackAuth:
        - functions:read
  /functions.distributions.permissions.remove:
    post:
      tags:
      - Functions
      summary: Remove Function Distribution Permissions
      description: Removes distribution permissions for a custom function from users or workspaces.
      operationId: postFunctionsDistributionsPermissionsRemove
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `functions:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - function_app_id
              type: object
              properties:
                function_app_id:
                  type: string
                  description: ID of the function app.
                user_ids:
                  type: string
                  description: Comma-separated list of user IDs to remove access from.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
              example:
                ok: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: invalid_auth
      security:
      - slackAuth:
        - functions:write