com.auth0.client.mgmt

Class UserBlocksEntity

java.lang.Object

com.auth0.client.mgmt.UserBlocksEntity

public class UserBlocksEntity
extends java.lang.Object

Class that provides an implementation of the User Blocks methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/User_Blocks

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiToken
protected okhttp3.HttpUrl	baseUrl
protected okhttp3.OkHttpClient	client

Method Summary

Modifier and Type	Method and Description
Request	delete(java.lang.String userId) Delete any existing User Blocks.
Request	deleteByIdentifier(java.lang.String identifier) Delete any existing User Blocks for a given identifier.
Request<UserBlocks>	get(java.lang.String userId) Request all the User Blocks.
Request<UserBlocks>	getByIdentifier(java.lang.String identifier) Request all the User Blocks for a given identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

client

protected final okhttp3.OkHttpClient client

baseUrl

protected final okhttp3.HttpUrl baseUrl

apiToken

protected final java.lang.String apiToken

Method Detail

getByIdentifier

public Request<UserBlocks> getByIdentifier(java.lang.String identifier)

Request all the User Blocks for a given identifier. A token with scope read:users is needed. See https://auth0.com/docs/api/management/v2#!/User_Blocks/get_user_blocks

Parameters:

identifier - the identifier. Either a username, phone_number, or email.

Returns:

a Request to execute.

deleteByIdentifier

public Request deleteByIdentifier(java.lang.String identifier)

Delete any existing User Blocks for a given identifier. A token with scope update:users is needed. See https://auth0.com/docs/api/management/v2#!/User_Blocks/delete_user_blocks

Parameters:

identifier - the identifier. Either a username, phone_number, or email.

Returns:

a Request to execute.

get

public Request<UserBlocks> get(java.lang.String userId)

Request all the User Blocks. A token with scope read:users is needed. See https://auth0.com/docs/api/management/v2#!/User_Blocks/get_user_blocks_by_id

Parameters:

userId - the user id.

Returns:

a Request to execute.

delete

public Request delete(java.lang.String userId)

Delete any existing User Blocks. A token with scope update:users is needed. See https://auth0.com/docs/api/management/v2#!/User_Blocks/delete_user_blocks_by_id

Parameters:

userId - the user id.

Returns:

a Request to execute.