Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.auth.policy.getEntities.json
Raw

priv/docs/methods/admin.auth.policy.getEntities.json

{
"args": {
"cursor": {
"desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.",
"example": "5c3e53d5",
"required": false,
"type": "string"
},
"entity_type": {
"desc": "The type of entity to assign to the policy. Currently, `USER` is supported.",
"required": false
},
"limit": {
"default": "1000",
"desc": "The maximum number of items to return. Must be between 1 and 1000, both inclusive.",
"example": "100",
"required": false,
"type": "integer"
},
"policy_name": {
"desc": "The name of the policy to fetch entities for. Currently, `email_password` is the only policy that may be used with this method.",
"example": "email_password",
"required": true,
"type": "string"
}
},
"desc": "Fetch all the entities assigned to a particular authentication policy by name.",
"errors": {
"feature_not_enabled": "This method is only available for Enterprise organizations.",
"invalid_cursor": "The cursor passed was invalid.",
"not_an_admin": "This method is only accessible by Org Owners and Admins.",
"policy_not_found": "The `policy_name` could not be found."
},
"rate_limit": {
"label": "Tier 4: 100+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.users:read",
"url": "https://docs.slack.dev/reference/scopes/admin.users.read"
}
]
}
}