admin.conversations.restrictAccess.addGroup

Argument	Type	Description
`token`Required	token	Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter. Example`xxxx-xxxxxxxxx-xxxx`
`channel_id`Required		The channel to link this group to.
`group_id`Required		The IDP Group ID to be an allowlist for the private channel.
`team_id`		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.

Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.

Example responses

Common successful response

Typical success response

{
    "ok": true
}

This API method for admins may only be used on Enterprise Grid.

This API method adds an IDP group to a private channel's allowlist, so that only members belonging to the IDP group can access the channel.

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error	Description
`team_not_found`	`team_id` can’t be found.
`feature_not_enabled`	Feature not enabled
`invalid_auth`	Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
`group_not_found`	`group_id` can’t be found.
`channel_not_found`	`channel_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).
`not_an_admin`	This token does not belong to an Org Admin or Owner.
`group_already_linked_to_channel`	The IDP group is already linked to the channel
`unable_to_link_idp_group_and_channel`	The IDP group and the channel cannot be linked.
`cannot_add_more_groups_to_channel`	The maximum number of groups have already been linked to the channel.
`cannot_add_more_channels_to_group`	The maximum number of channels have already been linked to the group.
`channel_is_not_private`	The channel is a public channel, a multi-party direct message, a direct message, or is externally-shared.
`invalid_channel_type`	The channel is a public channel, a multi-party direct message, a direct message, or is externally-shared.
`default_channel_restricted`	The channel is a default channel on the workspace.
`group_must_not_be_empty`	The IDP group is currently empty.
`not_authed`	No authentication token provided.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`token_expired`	Authentication token has expired
`no_permission`	The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`not_allowed_token_type`	The token type used in this request is not allowed.
`method_deprecated`	The method has been deprecated.
`deprecated_endpoint`	The endpoint has been deprecated.
`two_factor_setup_required`	Two factor setup is required.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`is_bot`	This method cannot be called by a bot user.
`invalid_arguments`	The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_arg_name`	The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`invalid_charset`	The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.
`invalid_form_data`	The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.
`invalid_post_type`	The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`team_added_to_org`	The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`accesslimited`	Access to this method is limited on the current network
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`service_unavailable`	The service is temporarily unavailable
`fatal_error`	The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
`internal_error`	The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.

API response

URL

POST body

Submit your arguments to see the API response

Was this page helpful?