Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.usergroups.addTeams.json
Raw

priv/docs/methods/admin.usergroups.addTeams.json

{
"args": {
"auto_provision": {
"default": "false",
"desc": "When `true`, this method automatically creates new workspace accounts for the IDP group members.",
"example": "true",
"required": false,
"type": "boolean"
},
"team_ids": {
"desc": "A comma separated list of encoded team (workspace) IDs. Each workspace _MUST_ belong to the organization associated with the token.",
"example": "T12345678,T98765432",
"required": true,
"type": "array"
},
"usergroup_id": {
"desc": "An encoded usergroup (IDP Group) ID.",
"example": "S12345678",
"required": true,
"type": "string"
}
},
"desc": "Associate one or more default workspaces with an organization-wide IDP group.",
"errors": {
"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."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.teams:write",
"url": "https://docs.slack.dev/reference/scopes/admin.teams.write"
}
]
}
}