Current section
Files
Jump to
Current section
Files
priv/docs/methods/admin.auth.policy.assignEntities.json
{
"args": {
"entity_ids": {
"desc": "Array of IDs to assign to the policy.",
"example": "['U12345','U27345']",
"required": true,
"type": "array"
},
"entity_type": {
"desc": "The type of entity to assign to the policy. Currently, `USER` is supported.",
"required": true
},
"policy_name": {
"desc": "The name of the authentication policy to assign the entities to. Currently, `email_password` is the only policy that may be used with this method.",
"example": "email_password",
"required": true,
"type": "string"
}
},
"desc": "Assign entities to a particular authentication policy.",
"errors": {
"admin_unauthorized": "The token provided doesn't have permission to revoke a session.",
"entity_not_found": "At least one `entity_id` was not found.",
"feature_not_enabled": "This method is only available for Enterprise organizations.",
"not_an_admin": "This method is only accessible by Org Owners and Admins.",
"over_max_entity_limit": "The number of entities assigned to this policy has reached its upper limit.",
"policy_not_found": "The policy name doesn't match any of the existing org policies.",
"unknown_method": "This method is currently not available."
},
"rate_limit": {
"label": "Tier 4: 100+ 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"
}
]
}
}