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

Documentation for Auth0 Management API of Users.

endpoint

/api/v2/users
/api/v2/users/{id}
/api/v2/users/{id}/enrollments
/api/v2/users/{id}/roles
/api/v2/users/{id}/logs
/api/v2/users/{id}/organizations
/api/v2/users/{id}/permissions
/api/v2/users/{id}/multifactor/{provider}
/api/v2/users/{id}/multifactor/actions/invalidate-remember-browser
/api/v2/users/{id}/identities
/api/v2/users/{id}/identities/{provider}/{user_id}
/api/v2/users/{id}/recovery-code-regeneration

Link to this section Summary

Types

config()

error()

id()

provider()

response_body()

user_id()

Functions

assign_permissions(id, params, config)

Assign Permissions to a User.

assign_roles(id, params, config)

Assign roles to a user.

create(params, config)

Create a User.

delete(id, config)

Delete a User.

delete_multifactor(id, params, config)

Delete a User's Multi-factor Provider.

get(id, params, config)

Get a User.

get_enrollments(id, config)

Get the First Confirmed Multi-factor Authentication Enrollment.

get_logs(id, params, config)

Get user's log events.

get_organizations(id, params, config)

List user's organizations.

get_permissions(id, params, config)

Get a User's Permissions.

get_roles(id, params, config)

Get a user's roles.

invalidate_remembered_browser_for_multifactor(id, config)

Invalidate All Remembered Browsers for Multi-factor Authentication.

link_identities(id, params, config)

Link a User Account.

list(params, config)

List or Search Users.

regenerate_recovery_code(id, config)

Generate New Multi-factor Authentication Recovery Code.

remove_permissions(id, params, config)

Remove Permissions from a User.

remove_roles(id, params, config)

Removes roles from a user.

unlink_identities(id, provider, user_id, config)

Unlink a User Identity.

update(id, params, config)

Update 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()

provider()

Specs

provider() :: String.t()

response_body()

Specs

response_body() :: String.t()

user_id()

Specs

user_id() :: String.t()

Link to this section Functions

assign_permissions(id, params, config)

Specs

assign_permissions(
  id(),
  Auth0.Management.Users.Permissions.Assign.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Assign Permissions to a User.

see

https://auth0.com/docs/api/management/v2/#!/Users/post_permissions

assign_roles(id, params, config)

Specs

assign_roles(
  id(),
  Auth0.Management.Users.Roles.Assign.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Assign roles to a user.

see

https://auth0.com/docs/api/management/v2/#!/Users/post_user_roles

create(params, config)

Specs

create(Auth0.Management.Users.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.User.t(), response_body()} | error()

Create a User.

see

https://auth0.com/docs/api/management/v2/#!/Users/post_users

delete(id, config)

Specs

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

Delete a User.

see

https://auth0.com/docs/api/management/v2/#!/Users/delete_users_by_id

delete_multifactor(id, params, config)

Specs

delete_multifactor(
  id(),
  Auth0.Management.Users.Multifactor.Delete.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Delete a User's Multi-factor Provider.

see

https://auth0.com/docs/api/management/v2/#!/Users/delete_multifactor_by_provider

get(id, params, config)

Specs

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

Get a User.

see

https://auth0.com/docs/api/management/v2/#!/Users/get_users_by_id

get_enrollments(id, config)

Specs

get_enrollments(id(), config()) ::
  {:ok, Auth0.Entity.Enrollments.t(), response_body()} | error()

Get the First Confirmed Multi-factor Authentication Enrollment.

see

https://auth0.com/docs/api/management/v2/#!/Users/get_enrollments

get_logs(id, params, config)

Specs

get_logs(id(), Auth0.Management.Users.Logs.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Logs.t(), response_body()} | error()

Get user's log events.

see

https://auth0.com/docs/api/management/v2/#!/Users/get_logs_by_user

get_organizations(id, params, config)

Specs

get_organizations(
  id(),
  Auth0.Management.Users.Organizations.List.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.Organizations.t(), response_body()} | error()

List user's organizations.

see

https://auth0.com/docs/api/management/v2/#!/Users/get_user_organizations

get_permissions(id, params, config)

Specs

get_permissions(
  id(),
  Auth0.Management.Users.Permissions.List.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.Permissions.t(), response_body()} | error()

Get a User's Permissions.

see

https://auth0.com/docs/api/management/v2/#!/Users/get_permissions

get_roles(id, params, config)

Specs

get_roles(id(), Auth0.Management.Users.Roles.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Roles.t(), response_body()} | error()

Get a user's roles.

see

https://auth0.com/docs/api/management/v2/#!/Users/get_user_roles

invalidate_remembered_browser_for_multifactor(id, config)

Specs

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

Invalidate All Remembered Browsers for Multi-factor Authentication.

see

https://auth0.com/docs/api/management/v2/#!/Users/post_invalidate_remember_browser

link_identities(id, params, config)

Specs

link_identities(
  id(),
  Auth0.Management.Users.Identities.Link.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.Identities.t(), response_body()} | error()

Link a User Account.

see

https://auth0.com/docs/api/management/v2/#!/Users/post_identities

list(params, config)

Specs

list(Auth0.Management.Users.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Users.t(), response_body()} | error()

List or Search Users.

see

https://auth0.com/docs/api/management/v2/#!/Users/get_users

regenerate_recovery_code(id, config)

Specs

regenerate_recovery_code(id(), config()) ::
  {:ok, Auth0.Entity.RecoveryCodeRegeneration.t(), response_body()} | error()

Generate New Multi-factor Authentication Recovery Code.

see

https://auth0.com/docs/api/management/v2/#!/Users/post_recovery_code_regeneration

remove_permissions(id, params, config)

Specs

remove_permissions(
  id(),
  Auth0.Management.Users.Permissions.Remove.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Remove Permissions from a User.

see

https://auth0.com/docs/api/management/v2/#!/Users/delete_permissions

remove_roles(id, params, config)

Specs

remove_roles(
  id(),
  Auth0.Management.Users.Roles.Remove.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Removes roles from a user.

see

https://auth0.com/docs/api/management/v2/#!/Users/delete_user_roles

unlink_identities(id, provider, user_id, config)

Specs

unlink_identities(id(), provider(), user_id(), config()) ::
  {:ok, Auth0.Entity.Identities.t(), response_body()} | error()

Unlink a User Identity.

see

https://auth0.com/docs/api/management/v2/#!/Users/delete_user_identity_by_user_id

update(id, params, config)

Specs

update(id(), Auth0.Management.Users.Patch.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.User.t(), response_body()} | error()

Update a User.

see

https://auth0.com/docs/api/management/v2/#!/Users/patch_users_by_id