Add up to one hundred default channels to an IDP group.

Required Params

• channel_ids - Comma separated string of channel IDs. ex: C00000000,C00000001
• usergroup_id - ID of the IDP group to add default channels for. ex: S00000000

Optional Params

• team_id - The workspace to add default channels in. ex: T00000000

Errors the API can return:

• channel_not_found - At least one of the provided channel IDs could not be found, or one of the channels has a type that is not supported.
• feature_not_enabled - The Admin APIs feature is not enabled for this workspace.
• invalid_channels_limit - The number of channel IDs passed in is larger than 100.
• not_an_admin - The calling user cannot update the specified usergroup.
• not_an_enterprise - The token passed in does not belong to an Enterprise organization.
• team_not_found - The workspace provided was not found.
• usergroup_not_found - The IDP group provided was not found.
• usergroup_not_linked_to_team - The IDP group provided is not linked to the workspace.
• usergroup_team_not_provisioned - The IDP group provided is linked to a workspace that has auto-provision disabled.

See the Common Errors guide for errors returned by every Web API method.

Associate one or more default workspaces with an organization-wide IDP group.

Required Params

• team_ids - A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token. ex: T12345678,T98765432
• usergroup_id - An encoded usergroup (IDP Group) ID. ex: S12345678

Optional Params

• auto_provision - When true, this method automatically creates new workspace accounts for the IDP group members. ex: true

Errors the API can return:

• auto_provision_failure - A failure occurred while assigning IDP group members to a specific workspace; see errors element for a list of failed team IDs.
• invalid_team_ids - One or more team IDs provided were invalid; see the errors field in the response for the list of invalid team IDs.
• no_team_ids_given - The team_ids parameter was empty.
• restricted_action - The calling user cannot update the specified usergroup.
• team_limit_exceeded - The number of teams associated with the org group would exceed the limit.
• usergroup_not_found - usergroup_id wasn't found.

See the Common Errors guide for errors returned by every Web API method.

List the channels linked to an org-level IDP group (user group).

Required Params

• usergroup_id - ID of the IDP group to list default channels for. ex: S00000000

Optional Params

• include_num_members - Flag to include or exclude the count of members per channel. ex: true
• team_id - ID of the the workspace. ex: T00000000

Errors the API can return:

• feature_not_enabled - The Admin APIs feature is not enabled for this workspace.
• invalid_user - The calling user is not valid.
• not_allowed - The calling user is not an admin or does not have necessary role
• not_an_admin - The token provided is not associated with an Org Admin or Owner.
• not_an_enterprise - The token passed in does not belong to an Enterprise organization.
• team_not_found - The workspace was not found.
• usergroup_not_found - The IDP group provided was not found.
• usergroup_not_linked_to_team - The IDP group provided is not linked to the specified workspace.

See the Common Errors guide for errors returned by every Web API method.

Remove one or more default channels from an org-level IDP group (user group).

Required Params

• channel_ids - Comma-separated string of channel IDs ex: C00000000,C00000001
• usergroup_id - ID of the IDP Group ex: S00000000

Errors the API can return:

• channel_not_found - At least one of the provided channel IDs could not be found, or one of those channels has a type that is not supported.
• feature_not_enabled - The Admin APIs feature is not enabled for this workspace.
• invalid_channels_limit - The number of channel IDs passed in is larger than 100.
• not_an_admin - The calling user cannot update the specified usergroup.
• not_an_enterprise - The token passed in does not belong to an Enterprise organization.
• usergroup_not_found - The IDP group provided was not found.

See the Common Errors guide for errors returned by every Web API method.