Slack Approved API

The Approved API from Slack — 2 operation(s) for approved.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

slack-approved-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  version: '1.0'
  title: Slack Admin Access Approved 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: Approved
paths:
  /admin.apps.approved.list:
    get:
      tags:
      - Approved
      description: List approved apps for an org or workspace.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/admin.apps.approved.list
      operationId: getAdminAppsApprovedList
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `admin.apps:read`'
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of items to return. Must be between 1 - 1000 both inclusive.
        schema:
          type: integer
      - name: cursor
        in: query
        description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
        schema:
          type: string
      - name: team_id
        in: query
        schema:
          type: string
      - name: enterprise_id
        in: query
        schema:
          type: string
      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:
                approved_apps:
                - app:
                    additional_info: ''
                    app_directory_url: https://myteam.enterprise.slack.com/apps/A0W7UKG8E-my-test-app
                    app_homepage_url: https://www.slack.com
                    description: test app
                    help_url: https://www.slack.com
                    icons:
                      image_1024: https://3026743124446w96_2bd4ea1ad1f89a23c242_1024.png
                      image_128: https://30267341249446w6_2bd4ea1ad1f89a23c242_128.png
                      image_192: https://30267431249446w6_2bd4ea1ad1f89a23c242_192.png
                      image_32: https://302674312496446w_2bd4ea1ad1f89a23c242_32.png
                      image_36: https://302674312496446w_2bd4ea1ad1f89a23c242_36.png
                      image_48: https://302674312496446w_2bd4ea1ad1f89a23c242_48.png
                      image_512: https://30267431249446w6_2bd4ea1ad1f89a23c242_512.png
                      image_64: https://302674312496446w_2bd4ea1ad1f89a23c242_64.png
                      image_72: https://302674312496446w_2bd4ea1ad1f89a23c242_72.png
                      image_96: https://302674312496446w_2bd4ea1ad1f89a23c242_96.png
                      image_original: https://302674446w12496_2bd4ea1ad1f89a23c242_original.png
                    id: A0W7UKG8E
                    is_app_directory_approved: false
                    is_internal: false
                    name: My Test App
                    privacy_policy_url: https://www.slack.com
                  date_updated: 1574296707
                  last_resolved_by:
                    actor_id: W0G82F4FD
                    actor_type: user
                  scopes:
                  - description: Add the ability for people to direct message or mention @my_test_app
                    is_sensitive: true
                    name: bot
                    token_type: bot
                ok: true
                response_metadata:
                  next_cursor: ''
        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.apps:read
      summary: Slack Get Admin Apps Approved List
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /admin.inviteRequests.approved.list:
    get:
      tags:
      - Approved
      description: List all approved workspace invite requests.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/admin.inviteRequests.approved.list
      operationId: getAdminInviterequestsApprovedList
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `admin.invites:read`'
        required: true
        schema:
          type: string
      - name: team_id
        in: query
        description: ID for the workspace where the invite requests were made.
        schema:
          type: string
      - name: cursor
        in: query
        description: Value of the `next_cursor` field sent as part of the previous API response
        schema:
          type: string
      - name: limit
        in: query
        description: The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
        schema:
          type: integer
      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.invites:read
      summary: Slack Get Admin Inviterequests Approved List
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK