UserBlocksInterface
in
Interface UserBlocksInterface.
Table of Contents
- delete() : ResponseInterface
- Unblock a user that was blocked due to an excessive amount of incorrectly provided credentials.
- deleteByIdentifier() : ResponseInterface
- Unblock a user blocked due to an excessive amount of incorrectly-provided credentials.
- get() : ResponseInterface
- Retrieve a list of blocked IP addresses for the login identifiers (email, username, phone number, etc) associated with the specified user.
- getByIdentifier() : ResponseInterface
- Retrieve a list of blocked IP addresses for a given identifier (e.g., username, phone number or email).
Methods
delete()
Unblock a user that was blocked due to an excessive amount of incorrectly provided credentials.
public
delete(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:users.
Parameters
- $id : string
-
the user_id of the user to update
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Tags
Return values
ResponseInterface —deleteByIdentifier()
Unblock a user blocked due to an excessive amount of incorrectly-provided credentials.
public
deleteByIdentifier(string $identifier[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:users.
Parameters
- $identifier : string
-
should be any of a username, phone number, or email
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Tags
Return values
ResponseInterface —get()
Retrieve a list of blocked IP addresses for the login identifiers (email, username, phone number, etc) associated with the specified user.
public
get(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:users.
Parameters
- $id : string
-
user ID to query for
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Tags
Return values
ResponseInterface —getByIdentifier()
Retrieve a list of blocked IP addresses for a given identifier (e.g., username, phone number or email).
public
getByIdentifier(string $identifier[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:users.
Parameters
- $identifier : string
-
should be any of a username, phone number, or email
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)