Auth0.Management.UserBlocks (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of UserBlocks.

endpoint

/api/v2/user-blocks
/api/v2/user-blocks/{id}

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

get(params, config)

Get blocks by identifier.

get_by_user_id(id, params, config)

Get a user's blocks.

unblock(params, config)

Unblock by identifier.

unblock_by_user_id(id, config)

Unblock a user.

Link to this section Types

config()

Specs

config() :: Auth0.Config.t()

error()

Specs

error() :: {:error, integer(), term()} | {:error, term()}

id()

Specs

id() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

get(params, config)

Specs

get(Auth0.Management.UserBlocks.Get.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.UserBlocks.t(), response_body()} | error()

Get blocks by identifier.

see

https://auth0.com/docs/api/management/v2/#!/User_Blocks/get_user_blocks

get_by_user_id(id, params, config)

Specs

get_by_user_id(
  id(),
  Auth0.Management.UserBlocks.Users.Get.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.UserBlocks.t(), response_body()} | error()

Get a user's blocks.

see

https://auth0.com/docs/api/management/v2/#!/User_Blocks/get_user_blocks_by_id

unblock(params, config)

Specs

unblock(Auth0.Management.UserBlocks.Unblock.Params.t() | map(), config()) ::
  {:ok, String.t(), response_body()} | error()

Unblock by identifier.

see

https://auth0.com/docs/api/management/v2/#!/User_Blocks/delete_user_blocks

unblock_by_user_id(id, config)

Specs

unblock_by_user_id(id(), config()) ::
  {:ok, String.t(), response_body()} | error()

Unblock a user.

see

https://auth0.com/docs/api/management/v2/#!/User_Blocks/delete_user_blocks_by_id