Class UserBlocks

Index

Constructors

constructor

new UserBlocks(_options: UserBlocks.Options): UserBlocks
Parameters
- _options: UserBlocks.Options
Returns UserBlocks

Methods

listByIdentifier

listByIdentifier(
request: Management.ListUserBlocksByIdentifierRequestParameters,
requestOptions?: UserBlocks.RequestOptions,
): HttpResponsePromise<ListUserBlocksByIdentifierResponseContent>
Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).
Parameters
- request: Management.ListUserBlocksByIdentifierRequestParameters
- OptionalrequestOptions: UserBlocks.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ListUserBlocksByIdentifierResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userBlocks.listByIdentifier({
        identifier: "identifier"
    })
```

deleteByIdentifier

deleteByIdentifier(
request: Management.DeleteUserBlocksByIdentifierRequestParameters,
requestOptions?: UserBlocks.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.
Parameters
- request: Management.DeleteUserBlocksByIdentifierRequestParameters
- OptionalrequestOptions: UserBlocks.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userBlocks.deleteByIdentifier({
        identifier: "identifier"
    })
```

list

list(
    id: string,
    request?: Management.ListUserBlocksRequestParameters,
    requestOptions?: UserBlocks.RequestOptions,
): HttpResponsePromise<ListUserBlocksResponseContent>
Retrieve details of all Brute-force Protection blocks for the user with the given ID.
Parameters
- id: string
  user_id of the user blocks to retrieve.
- request: Management.ListUserBlocksRequestParameters = {}
- OptionalrequestOptions: UserBlocks.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ListUserBlocksResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.userBlocks.list("id")
```

delete

delete(
id: string,
requestOptions?: UserBlocks.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.
Parameters
- id: string
  The user_id of the user to update.
- OptionalrequestOptions: UserBlocks.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.userBlocks.delete("id")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: UserBlocks.Options

Class UserBlocks

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns UserBlocks

Methods

listByIdentifier

Parameters

Returns HttpResponsePromise<ListUserBlocksByIdentifierResponseContent>

Throws

Throws

Throws

Throws

Example

deleteByIdentifier

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

list

Parameters

Returns HttpResponsePromise<ListUserBlocksResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options