Current section
Files
Jump to
Current section
Files
priv/docs/methods/admin.conversations.restrictAccess.addGroup.json
{
"args": {
"channel_id": {
"desc": "The channel to link this group to.",
"required": true
},
"group_id": {
"desc": "The IDP Group ID to be an allowlist for the private channel.",
"required": true
},
"team_id": {
"desc": "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.",
"required": false
}
},
"desc": "Add an allowlist of IDP groups for accessing a channel",
"errors": {
"cannot_add_more_channels_to_group": "The maximum number of channels have already been linked to the group.",
"cannot_add_more_groups_to_channel": "The maximum number of groups have already been linked to the channel.",
"channel_is_not_private": "The channel is a public channel, a multi-party direct message, a direct message, or is externally-shared.",
"channel_not_found": "`channel_id` can’t be found.",
"default_channel_restricted": "The channel is a default channel on the workspace.",
"feature_not_enabled": "Feature not enabled",
"group_already_linked_to_channel": "The IDP group is already linked to the channel",
"group_must_not_be_empty": "The IDP group is currently empty.",
"group_not_found": "`group_id` can’t be found.",
"invalid_channel": "The channel can’t be linked to an IDP group (i.e., it's a public channel or external shared channel).",
"invalid_channel_type": "The channel is a public channel, a multi-party direct message, a direct message, or is externally-shared.",
"no_channel_memberships": "The channel has no members.",
"not_an_admin": "This token does not belong to an Org Admin or Owner.",
"team_not_found": "`team_id` can’t be found.",
"unable_to_link_idp_group_and_channel": "The IDP group and the channel cannot be linked."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.conversations:write",
"url": "https://docs.slack.dev/reference/scopes/admin.conversations.write"
}
]
}
}