Current section
Files
Jump to
Current section
Files
priv/docs/methods/admin.conversations.restrictAccess.removeGroup.json
{
"args": {
"channel_id": {
"desc": "The channel to remove the linked group from.",
"required": true
},
"group_id": {
"desc": "The IDP Group ID to remove from 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": true
}
},
"desc": "Remove a linked IDP group linked from a private channel",
"errors": {
"channel_not_found": "`channel_id` can’t be found.",
"failed_to_remove_group_users": "Returned when could not remove the users in the channel of the group being removed",
"failed_to_unlink_channel": "Removing the link in the database failed. Please retry.",
"feature_not_enabled": "Feature not enabled",
"group_not_found": "`group_id` can’t be found.",
"invalid_channel": "The channel could not be linked to an IDP group (i.e., it's a public channel or external shared channel).",
"link_not_found": "There was no link found between the specified channel and the IDP group.",
"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_unlink_idp_group_and_channel": "The IDP group and channel cannot be unlinked."
},
"rate_limit": {
"label": "Tier 1: 1+ 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"
}
]
}
}