Current section
Files
Jump to
Current section
Files
priv/docs/methods/admin.users.assign.json
{
"args": {
"channel_ids": {
"desc": "Comma separated values of channel IDs to add user in the new workspace.",
"example": "C123,C3456",
"required": false,
"type": "string"
},
"is_restricted": {
"desc": "True if user should be added to the workspace as a guest.",
"example": "true",
"required": false,
"type": "boolean"
},
"is_ultra_restricted": {
"desc": "True if user should be added to the workspace as a single-channel guest.",
"example": "true",
"required": false,
"type": "boolean"
},
"team_id": {
"desc": "The ID (`T1234`) of the workspace.",
"required": true
},
"user_id": {
"desc": "The ID of the user to add to the workspace.",
"required": true
}
},
"desc": "Add an Enterprise user to a workspace.",
"errors": {
"feature_not_enabled": "The Admin APIs feature is not enabled for this team",
"invalid_role_for_user": "The requested status is incompatible with the user's role on another workspace.",
"invited_user_not_created": "The invited user could not be created.",
"invited_user_not_reactivated": "The invited user could not be reactivated.",
"invitor_cannot_see_channel": "The invitor is not part of one or many channels that the user was requested to be added to",
"not_an_admin": "This method wasn't called by an admin.",
"team_not_found": "\\`team\\_id was not found.",
"user_already_team_member": "The given user is already active on the given team.",
"user_is_bot": "The given user is a bot from an app. This api only works with humans.",
"user_not_found": "`user_id` was not found."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.users:write",
"url": "https://docs.slack.dev/reference/scopes/admin.users.write"
}
]
}
}