POST
/admin.usergroups.removeChannelsRemove default channels from an IDP group
Removes one or more default channels from an organization-level IDP group. Provide the IDP group identifier and a comma-separated list of channel identifiers in channel_ids. Authenticate with a token that has the admin.usergroups:write scope.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
tokenstringrequired
Authentication token with the `admin.usergroups:write` scope.
IDP group channel associations to remove, submitted as form data.
usergroup_idstringrequired
ID of the IDP Group
channel_idsstringrequired
Comma-separated string of channel IDs
200Returns an object with `ok` set to true when the channels are removed from the IDP group.
okbooleanrequired
defaultReturns an object with `ok` set to false when the request cannot be completed.
okbooleanrequired
Error handling
The request must include usergroup_id and channel_ids. token must have the admin.usergroups:write scope, and channel_ids must be a comma-separated string of channel identifiers.