Slack Web API

/admin.conversations.restrictAccess.addGroup

POST

admin.conversations.restrictAccessadmin

Add an allowlist of IDP groups for accessing a channel

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/admin.conversations.restrictAccess.addGroup' \
--data-urlencode 'channel_id=' \
--data-urlencode 'group_id=' \
--data-urlencode 'token='

Response Example

200 - response

{
    "ok": true
}

Request

Body Params application/x-www-form-urlencoded

channel_id

string

required

The channel to link this group to.

group_id

string

required

The IDP Group ID to be an allowlist for the private channel.

team_id

string

optional

The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.

token

string

required

Authentication token. Requires scope: admin.conversations:write

Responses

🟢200Typical success response

application/json

Body

This method either only returns a brief _OK_ response or a verbose schema is not available for this method.

enum<boolean>

required

Allowed value:

true

Additional properties

integer | number | string | boolean

optional

🔴500Typical error response

/admin.conversations.ekm.listOriginalConnectedChannelInfo

/admin.conversations.restrictAccess.listGroups