Back to Node Auth0

Class BlocksClient

docs/classes/management.SDK.BlocksClient.html

5.9.13.5 KB
Original Source

Class BlocksClient

Index

Constructors

constructor

Methods

checkIpunblockIp

Properties

_options

Constructors

constructor

new BlocksClient(options: BaseClientOptions): BlocksClient

Parameters

Returns BlocksClient

Methods

checkIp

checkIp(
id: string,
requestOptions?: BlocksClient.RequestOptions,
): HttpResponsePromise<void>

Check if the given IP address is blocked via the Suspicious IP Throttling due to multiple suspicious attempts.

Parameters

  • id: string

IP address to check.

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.anomaly.blocks.checkIp("id")Copy

unblockIp

unblockIp(
id: string,
requestOptions?: BlocksClient.RequestOptions,
): HttpResponsePromise<void>

Remove a block imposed by Suspicious IP Throttling for the given IP address.

Parameters

  • id: string

IP address to unblock.

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.anomaly.blocks.unblockIp("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods checkIpunblockIp Properties _options