@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

@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

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

Clear risk assessment assessors for a specific user.

see

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

@spec create(map(), config(), keyword()) :: {: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

@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

@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

@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

@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

@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

@spec delete_multifactor(id(), provider_params(), 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

@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

@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

@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

@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

@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

@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

@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

@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

@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

@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

@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

@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

@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

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

Retrieve details of users.

see

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

@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

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

Get a User's Connected Accounts.

Retrieve all connected accounts associated with the user.

see

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

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

List the roles which grant the user a given permission (whether directly or through groups).

Lists the roles which grant the user a given permission, including roles assigned directly to the user and those inherited through group memberships.

see

https://auth0.com/docs/api/management/v2/users/get-user-effective-permission-role-sources

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

List the permissions assigned to a user directly or through roles or groups.

Returns the list of effective permissions for a user, taking into account permissions granted directly to the user, as well as those inherited through roles and group memberships.

see

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

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

Get a user's role source groups.

Lists the groups that grant a user a specific role.

see

https://auth0.com/docs/api/management/v2/users/get-user-role-source-groups

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

List the roles for a user with sources: directly assigned or through group membership.

Retrieve detailed list of effective roles for a user, including roles assigned directly and through group memberships.

see

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

@spec list_groups(String.t(), map(), config()) :: {:ok, map() | [map()]} | error()

Get user's groups.

List all groups to which this user belongs.

see

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

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

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.

see

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

@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

@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

@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

@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

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

Update a user.

see

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

@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

@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