docs/classes/management.SDK.UserBlocksClient.html
listByIdentifierdeleteByIdentifierlistdelete
new UserBlocksClient(options: BaseClientOptions): UserBlocksClient
listByIdentifier(
request: ListUserBlocksByIdentifierRequestParameters,
requestOptions?: UserBlocksClient.RequestOptions,
): HttpResponsePromise<ListUserBlocksByIdentifierResponseContent>
Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).
OptionalrequestOptions: UserBlocksClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.userBlocks.listByIdentifier({ identifier: "identifier", consider_brute_force_enablement: true })Copy
deleteByIdentifier(
request: DeleteUserBlocksByIdentifierRequestParameters,
requestOptions?: UserBlocksClient.RequestOptions,
): HttpResponsePromise<void>
Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).
Note: This endpoint does not unblock users that were blocked by a tenant administrator.
OptionalrequestOptions: UserBlocksClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.userBlocks.deleteByIdentifier({ identifier: "identifier" })Copy
list(
id: string,
request?: ListUserBlocksRequestParameters,
requestOptions?: UserBlocksClient.RequestOptions,
): HttpResponsePromise<ListUserBlocksResponseContent>
Retrieve details of all Brute-force Protection blocks for the user with the given ID.
user_id of the user blocks to retrieve.
OptionalrequestOptions: UserBlocksClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.userBlocks.list("id", { consider_brute_force_enablement: true })Copy
delete(
id: string,
requestOptions?: UserBlocksClient.RequestOptions,
): HttpResponsePromise<void>
Remove all Brute-force Protection blocks for the user with the given ID.
Note: This endpoint does not unblock users that were blocked by a tenant administrator.
The user_id of the user to update.
OptionalrequestOptions: UserBlocksClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.userBlocks.delete("id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listByIdentifierdeleteByIdentifierlistdelete Properties _options