Current section
Files
Jump to
Current section
Files
priv/docs/methods/admin.roles.removeAssignments.json
{
"args": {
"entity_ids": {
"desc": "List of the entity IDs for which roles will be revoked. These can be Org IDs, Team IDs or Channel IDs",
"example": "['T00000001', 'E00000002']",
"required": true,
"type": "array"
},
"role_id": {
"desc": "ID of the role to which users will be assigned",
"example": "R0001",
"required": true,
"type": "string"
},
"user_ids": {
"desc": "List of IDs of the users whose roles will be revoked",
"example": "['U00000001', 'U00000002', 'U00000003']",
"required": true,
"type": "array"
}
},
"desc": "Removes a set of users from a role for the given scopes and entities",
"errors": {
"cannot_modify_role_admin": "Cannot modify role admin.",
"failed_for_some_entities": "At least one role scope ID was invalid",
"failed_for_some_users": "At least one user ID was invalid",
"failed_for_some_users_and_entities": "At least one role scope ID was invalid",
"feature_not_enabled": "This API is currently not enabled.",
"invalid_actor": "This API is only enabled for the Admins/Owners.",
"invalid_role_id": "The role type passed does not exist.",
"no_valid_entities": "None of the entities passed were valid.",
"no_valid_users": "None of the users passed were valid.",
"too_many_entities": "More than 10 role scopes were passed.",
"too_many_users": "More than 10 users were passed."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.roles:write",
"url": "https://docs.slack.dev/reference/scopes/admin.roles.write"
}
]
}
}