Skip to main content

@slack/web-api / AdminAuthPolicyGetEntitiesArguments

Interface: AdminAuthPolicyGetEntitiesArguments

Defined in: packages/web-api/src/types/request/admin/auth.ts:20

Extends​

  • Partial<EntityType>.PolicyName.TokenOverridable.CursorPaginationEnabled

Properties​

cursor?​

optional cursor?: string;

Defined in: packages/web-api/src/types/request/common.ts:16

Description​

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.

See​

pagination for more detail.

Inherited from​

CursorPaginationEnabled.cursor

entity_type?​

optional entity_type?: "USER";

Defined in: packages/web-api/src/types/request/admin/auth.ts:9

Description​

The type of entity interacting with the policy.

Inherited from​

AdminAuthPolicyAssignEntitiesArguments.entity_type

limit?​

optional limit?: number;

Defined in: packages/web-api/src/types/request/common.ts:9

Description​

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer with a max value of 999. Default is 100.

Inherited from​

CursorPaginationEnabled.limit

policy_name​

policy_name: "email_password";

Defined in: packages/web-api/src/types/request/admin/auth.ts:13

Description​

The name of the policy.

Inherited from​

PolicyName.policy_name

token?​

optional token?: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token