POST
/admin.usergroups.addTeamsAdd workspaces to an IDP group
Associates one or more default workspaces with an organization-wide IDP group. Provide the group identifier and a comma-separated list of workspace identifiers in team_ids; each workspace must belong to the organization associated with the token. Set auto_provision to true to create workspace accounts automatically for IDP group members.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
tokenstringrequired
Authentication token with the `admin.teams:write` scope.
IDP group workspace associations submitted as form data.
usergroup_idstringrequired
An encoded usergroup (IDP Group) ID.
team_idsstringrequired
A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token.
auto_provisionbooleanoptional
When `true`, this method automatically creates new workspace accounts for the IDP group members.
200Returns an object with `ok` set to true when the workspaces are associated with 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 team_ids. Each identifier in team_ids must refer to a workspace in the token's organization, and auto_provision controls whether workspace accounts are created automatically.