View Source Auth0.Management.Users (Auth0Api v2.2.0)

Summary

Types

authentication_method_id()

config()

error()

id()

provider()

user_id()

Functions

assign_permissions(id, params, config)

Assign permissions to a user.

assign_roles(id, params, config)

Assign one or more existing user roles to a user.

create(params, config)

Create a new user for a given database or passwordless connection.

create_authentication_methods(id, params, config)

Create an authentication method. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.

delete(id, config)

Delete a user by user ID. This action cannot be undone.

delete_authentication_method(id, authentication_method_id, config)

Remove the authentication method with the given ID from the specified user.

delete_authentication_methods(id, config)

Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action cannot be undone.

delete_authenticators(id, config)

Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone.

delete_multifactor(id, params, config)

Remove a multifactor authentication configuration from a user's account. This forces the user to manually reconfigure the multi-factor provider.

delete_refresh_tokens(id, config)

Delete all refresh tokens for a user.

delete_sessions(id, config)

Delete all sessions for a user.

get(id, params, config)

Retrieve user details. A list of fields to include or exclude may also be specified.

get_authentication_method(id, authentication_method_id, config)

Get an authentication method by ID

get_enrollments(id, config)

Retrieve the first multi-factor authentication enrollment that a specific user has confirmed.

get_logs(id, params, config)

Retrieve log events for a specific user.

get_organizations(id, params, config)

Retrieve list of the specified user's current Organization memberships. User must be specified by user ID.

get_permissions(id, params, config)

Retrieve all permissions associated with the user.

get_refresh_tokens(id, params, config)

Retrieve details for a user's refresh tokens.

get_roles(id, params, config)

Retrieve detailed list of all user roles currently assigned to a user.

get_sessions(id, params, config)

Retrieve details for a user's sessions.

invalidate_remembered_browser_for_multifactor(id, config)

Invalidate all remembered browsers across all authentication factors for a user.

link_identities(id, params, config)

Link two user accounts together forming a primary and secondary relationship. On successful linking, the endpoint returns the new array of the primary account identities.

list(params, config)

Retrieve details of users.

list_authentication_methods(id, params, config)

Retrieve detailed list of authentication methods associated with a specified user.

regenerate_recovery_code(id, config)

Remove an existing multi-factor authentication (MFA) recovery code and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.

remove_permissions(id, params, config)

Remove permissions from a user.

remove_roles(id, params, config)

Remove one or more specified user roles assigned to a user.

revoke_selected_resources(id, params \\ %{}, config \\ %Config{})

Revokes selected resources related to a user (sessions, refresh tokens, ...).

unlink_identities(id, provider, user_id, config)

Unlink a specific secondary account from a target user. This action requires the ID of both the target user and the secondary account.

update(id, params, config)

Update a user.

update_authentication_method(id, authentication_method_id, params, config)

Modify the authentication method with the given ID from the specified user.

update_authentication_methods(id, params, config)

Replace the specified user authentication methods with supplied values.

Types

authentication_method_id()

@type authentication_method_id() :: String.t()

config()

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

error()

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

id()

@type id() :: String.t()

provider()

@type provider() :: String.t()

user_id()

@type user_id() :: String.t()

Functions

assign_permissions(id, params, config)

@spec assign_permissions(id(), map(), config()) :: {:ok, String.t()} | error()

Assign permissions to a user.

see

https://auth0.com/docs/api/management/v2/users/post-permissions

assign_roles(id, params, config)

@spec assign_roles(id(), map(), config()) :: {:ok, String.t()} | error()

Assign one or more existing user roles to a user.

see

https://auth0.com/docs/api/management/v2/users/post-user-roles

create(params, config)

@spec create(map(), config()) :: {:ok, map()} | error()

Create a new user for a given database or passwordless connection.

see

https://auth0.com/docs/api/management/v2/users/post-users

create_authentication_methods(id, params, config)

@spec create_authentication_methods(id(), map(), config()) :: {:ok, map()} | error()

Create an authentication method. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.

see

https://auth0.com/docs/api/management/v2/users/post-authentication-methods

delete(id, config)

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

Delete a user by user ID. This action cannot be undone.

see

https://auth0.com/docs/api/management/v2/users/delete-users-by-id

delete_authentication_method(id, authentication_method_id, config)

@spec delete_authentication_method(id(), authentication_method_id(), config()) ::
  {:ok, String.t()} | error()

Remove the authentication method with the given ID from the specified user.

see

https://auth0.com/docs/api/management/v2/users/delete-authentication-methods-by-authentication-method-id

delete_authentication_methods(id, config)

@spec delete_authentication_methods(id(), config()) :: {:ok, String.t()} | error()

Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action cannot be undone.

see

https://auth0.com/docs/api/management/v2/users/delete-authentication-methods

delete_authenticators(id, config)

@spec delete_authenticators(id(), config()) :: {:ok, String.t()} | error()

Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone.

see

https://auth0.com/docs/api/management/v2/users/delete-authenticators

delete_multifactor(id, params, config)

@spec delete_multifactor(id(), map(), config()) :: {:ok, String.t()} | error()

Remove a multifactor authentication configuration from a user's account. This forces the user to manually reconfigure the multi-factor provider.

see

https://auth0.com/docs/api/management/v2/users/delete-multifactor-by-provider

delete_refresh_tokens(id, config)

@spec delete_refresh_tokens(id(), config()) :: {:ok, String.t()} | error()

Delete all refresh tokens for a user.

see

https://auth0.com/docs/api/management/v2/users/delete-refresh-tokens-for-user

delete_sessions(id, config)

@spec delete_sessions(id(), config()) :: {:ok, String.t()} | error()

Delete all sessions for a user.

see

https://auth0.com/docs/api/management/v2/users/delete-sessions-for-user

get(id, params, config)

@spec get(id(), map(), config()) :: {:ok, map()} | error()

Retrieve user details. A list of fields to include or exclude may also be specified.

see

https://auth0.com/docs/api/management/v2/users/get-users-by-id

get_authentication_method(id, authentication_method_id, config)

@spec get_authentication_method(id(), authentication_method_id(), config()) ::
  {:ok, map()} | error()

Get an authentication method by ID

see

https://auth0.com/docs/api/management/v2/users/get-authentication-methods-by-authentication-method-id

get_enrollments(id, config)

@spec get_enrollments(id(), config()) :: {:ok, [map()]} | error()

Retrieve the first multi-factor authentication enrollment that a specific user has confirmed.

see

https://auth0.com/docs/api/management/v2/users/get-enrollments

get_logs(id, params, config)

@spec get_logs(id(), map(), config()) :: {:ok, [map()] | map()} | error()

Retrieve log events for a specific user.

see

https://auth0.com/docs/api/management/v2/users/get-logs-by-user

get_organizations(id, params, config)

@spec get_organizations(id(), map(), config()) :: {:ok, [map()] | map()} | error()

Retrieve list of the specified user's current Organization memberships. User must be specified by user ID.

see

https://auth0.com/docs/api/management/v2/users/get-user-organizations

get_permissions(id, params, config)

@spec get_permissions(id(), map(), config()) :: {:ok, [map()] | map()} | error()

Retrieve all permissions associated with the user.

see

https://auth0.com/docs/api/management/v2/users/get-permissions

get_refresh_tokens(id, params, config)

@spec get_refresh_tokens(id(), map(), config()) :: {:ok, map()} | error()

Retrieve details for a user's refresh tokens.

see

https://auth0.com/docs/api/management/v2/users/get-refresh-tokens-for-user

get_roles(id, params, config)

@spec get_roles(id(), map(), config()) :: {:ok, [map()] | map()} | error()

Retrieve detailed list of all user roles currently assigned to a user.

see

https://auth0.com/docs/api/management/v2/users/get-user-roles

get_sessions(id, params, config)

@spec get_sessions(id(), map(), config()) :: {:ok, map()} | error()

Retrieve details for a user's sessions.

see

https://auth0.com/docs/api/management/v2/users/get-sessions-for-user

invalidate_remembered_browser_for_multifactor(id, config)

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

Invalidate all remembered browsers across all authentication factors for a user.

see

https://auth0.com/docs/api/management/v2/users/post-invalidate-remember-browser

link_identities(id, params, config)

@spec link_identities(id(), map(), config()) :: {:ok, [map()]} | error()

Link two user accounts together forming a primary and secondary relationship. On successful linking, the endpoint returns the new array of the primary account identities.

see

https://auth0.com/docs/api/management/v2/users/post-identities

list(params, config)

@spec list(map(), config()) :: {:ok, [map()] | map()} | error()

Retrieve details of users.

see

https://auth0.com/docs/api/management/v2/users/get-users

list_authentication_methods(id, params, config)

@spec list_authentication_methods(id(), map(), config()) ::
  {:ok, [map()] | map()} | error()

Retrieve detailed list of authentication methods associated with a specified user.

see

https://auth0.com/docs/api/management/v2/users/get-authentication-methods

regenerate_recovery_code(id, config)

@spec regenerate_recovery_code(id(), config()) :: {:ok, map()} | error()

see

https://auth0.com/docs/api/management/v2/users/post-recovery-code-regeneration

remove_permissions(id, params, config)

@spec remove_permissions(id(), map(), config()) :: {:ok, String.t()} | error()

Remove permissions from a user.

see

https://auth0.com/docs/api/management/v2/users/delete-permissions

remove_roles(id, params, config)

@spec remove_roles(id(), map(), config()) :: {:ok, String.t()} | error()

Remove one or more specified user roles assigned to a user.

see

https://auth0.com/docs/api/management/v2/users/delete-user-roles

revoke_selected_resources(id, params \\ %{}, config \\ %Config{})

@spec revoke_selected_resources(id(), map(), config()) :: {:ok, String.t()} | error()

Revokes selected resources related to a user (sessions, refresh tokens, ...).

see

https://auth0.com/docs/api/management/v2/users/user-revoke-access

unlink_identities(id, provider, user_id, config)

@spec unlink_identities(id(), provider(), user_id(), config()) ::
  {:ok, [map()]} | error()

Unlink a specific secondary account from a target user. This action requires the ID of both the target user and the secondary account.

see

https://auth0.com/docs/api/management/v2/users/delete-user-identity-by-user-id

update(id, params, config)

@spec update(id(), map(), config()) :: {:ok, map()} | error()

Update a user.

see

https://auth0.com/docs/api/management/v2/users/patch-users-by-id

update_authentication_method(id, authentication_method_id, params, config)

@spec update_authentication_method(id(), authentication_method_id(), map(), config()) ::
  {:ok, map()} | error()

Modify the authentication method with the given ID from the specified user.

see

https://auth0.com/docs/api/management/v2/users/patch-authentication-methods-by-authentication-method-id

update_authentication_methods(id, params, config)

@spec update_authentication_methods(id(), map(), config()) :: {:ok, [map()]} | error()

Replace the specified user authentication methods with supplied values.

see

https://auth0.com/docs/api/management/v2/users/put-authentication-methods