View Source Auth0.Api.Management (Auth0Api v2.5.0)

Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.

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

Add a connection to an organization.

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

Associate clients with an organization.

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

Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.

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

Set one or more existing users as members of a specific Organization.

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

Assign roles to a group.

assign_organization_group_roles(organization_id, group_id, params \\ %{}, config \\ %Config{})

Assign roles to a group in an organization context.

assign_organization_roles(id, user_id, params \\ %{}, config \\ %Config{})

Assign one or more roles to a user to determine their access for a specific Organization.

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

Assign groups to a role.

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

Assign one or more users to an existing user role.

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

Assign permissions to a user.

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

Assign one or more existing user roles to a user.

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

Associate a client grant with an organization.

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

Add one or more permissions to a specified user role.

blacklist_token(params \\ %{}, config \\ %Config{}) deprecated

Add the token identified by the jti to a blacklist for the tenant.

bulk_update_prompt_renderings(params \\ %{}, config \\ %Config{})

Update render settings for multiple screens.

check_ip_blocked(ip, config \\ %Config{})

Check if the given IP address is blocked via the Suspicious IP Throttling due to multiple suspicious attempts.

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

Clear risk assessment assessors for a specific user.

configure_branding_phone_provider(params, config)

Create an phone provider.

configure_custom_domain(params \\ %{}, config \\ %Config{})

Create a new custom domain.

configure_email_provider(params \\ %{}, config \\ %Config{})

Create an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property)

create_action(params \\ %{}, config \\ %Config{})

Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.

create_action_module(params \\ %{}, config \\ %Config{})

Create a new Actions Module.

create_action_module_version(id, config \\ %Config{})

Create a new version of an Actions Module.

create_agent(params \\ %{}, config \\ %Config{})

Create an agent.

create_branding_phone_template(params, config)

Create a phone notification template

create_branding_theme(params \\ %{}, config \\ %Config{})

Create branding theme.

create_client(params \\ %{}, config \\ %Config{})

Create a new client (application or SSO integration).

create_client_grant(params \\ %{}, config \\ %Config{})

Create a client grant for a machine-to-machine login flow.

create_connection(params \\ %{}, config \\ %Config{})

Creates a new connection according to the JSON object received in body.

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

Create a directory provisioning configuration.

create_connection_directory_provisioning_synchronization(id, config \\ %Config{})

Request an on-demand synchronization of the directory.

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

Create connection keys.

create_connection_profile(params \\ %{}, config \\ %Config{})

Create a connection profile.

create_connection_scim_configuration(id, params, config)

Create a scim configuration for a connection.

create_connection_scim_configuration_tokens(id, params, config)

Create a scim token for a scim client.

create_credential(client_id, params, config \\ %Config{})

Create a client credential associated to your application. The credential will be created but not yet enabled for use with Private Key JWT authentication method. To enable the credential, set the client_authentication_methods property on the client.

create_device_credential(params \\ %{}, config \\ %Config{})

Create a device credential public key to manage refresh token rotation for a given user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.

create_email_template(params \\ %{}, config \\ %Config{})

Create an email template.

create_email_verification_ticket(params \\ %{}, config \\ %Config{}, opts \\ [])

Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address.

create_encryption_key(params, config)

Create the new, pre-activated encryption key, without the key material.

create_encryption_wrapping_key(kid, config)

Create the public wrapping key to wrap your own encryption key material.

create_event_stream(params \\ %{}, config \\ %Config{})

Create an event stream.

create_flow(params, config)

Create a flow.

create_flows_vault_connection(params \\ %{}, config \\ %Config{})

Create a Flows Vault connection.

create_form(params, config)

Create a form.

create_guardian_enrollment_ticket(params \\ %{}, config \\ %Config{}, opts \\ [])

Create a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket, to a given user.

create_hook(params \\ %{}, config \\ %Config{}) deprecated

Create a new hook.

create_job_users_exports(params \\ %{}, config \\ %Config{})

Export all users to a file via a long-running job.

create_job_users_imports(params \\ %{}, config \\ %Config{})

Import users from a formatted file into a connection via a long-running job.

create_log_stream(params \\ %{}, config \\ %Config{})

Create a log stream.

create_network_acl(params \\ %{}, config \\ %Config{})

Create a network ACL.

create_network_acl_key(params \\ %{}, config \\ %Config{})

Create a Network ACL key.

create_organization(params \\ %{}, config \\ %Config{})

Create a new Organization within your tenant.

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

Create an organization discovery domain.

create_organization_invitation(id, params \\ %{}, config \\ %Config{}, opts \\ [])

Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization.

create_password_change_ticket(params \\ %{}, config \\ %Config{}, opts \\ [])

Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow.

create_rate_limit_policy(params \\ %{}, config \\ %Config{})

Create a rate limit policy.

create_resource_server(params \\ %{}, config \\ %Config{})

Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0.

create_risk_assessment(params \\ %{}, config \\ %Config{}) deprecated

Create a risk assessment.

create_role(params \\ %{}, config \\ %Config{})

Create a user role for Role-Based Access Control.

create_rule(params \\ %{}, config \\ %Config{}) deprecated

Create a new rule.

create_self_service_profile(params, config)

Creates a self-service profile. Currently only one profile can be created per tenant.

create_self_service_profile_sso_ticket(id, params, config, opts \\ [])

Creates an sso-access ticket to initiate the Self Service SSO Flow using a self-service profile.

create_supplemental_signal(params \\ %{}, config \\ %Config{}) deprecated

Create a supplemental signal.

create_token_exchange_profile(params \\ %{}, config \\ %Config{})

Create a token exchange profile.

create_user(params \\ %{}, config \\ %Config{}, opts \\ [])

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

create_user_attribute_profile(params \\ %{}, config \\ %Config{})

Create a user attribute profile.

create_user_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.

create_verifiable_credential(params \\ %{}, config \\ %Config{})

Create a verifiable credential verification template (POST /api/v2/verifiable-credentials/verification/templates).

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

Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.

delete_action_module(id, config \\ %Config{})

Delete a specific Actions Module by ID.

delete_agent(id, config \\ %Config{})

Delete an agent.

delete_branding_phone_provider(id, config)

Delete the configured phone provider.

delete_branding_phone_template(id, config)

Delete a phone notification template

delete_branding_theme(theme_id, config \\ %Config{})

Delete branding theme.

delete_client(id, config \\ %Config{})

Delete a client and related configuration (rules, connections, etc).

delete_client_grant(id, config \\ %Config{})

Delete the Client Credential Flow from your machine-to-machine application.

delete_connection(id, config \\ %Config{})

Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.

delete_connection_directory_provisioning(id, config \\ %Config{})

Delete a directory provisioning configuration.

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

Delete synchronized group selections for a directory provisioning configuration.

delete_connection_profile(id, config \\ %Config{})

Delete Connection Profile.

delete_connection_scim_configuration(id, config)

Deletes a scim configuration by its connectionId.

delete_connection_scim_configuration_tokens(id, token_id, config)

Deletes a scim token by its connection id and tokenId.

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

Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.

delete_credential(client_id, credential_id, config \\ %Config{})

Delete a client credential you previously created. May be enabled or disabled.

delete_custom_domain_configuration(id, config \\ %Config{})

Delete a custom domain and stop serving requests for it.

delete_custom_signing_keys(config \\ %Config{})

Delete custom signing keys.

delete_device_credential(id, config \\ %Config{})

Permanently delete a device credential (such as a refresh token or public key) with the given ID.

delete_email_provider(config \\ %Config{})

Delete email provider.

delete_encryption_key(kid, config)

Delete the custom provided encryption key with the given ID and move back to using native encryption key.

delete_event_stream(id, config \\ %Config{})

Delete an event stream.

delete_flow(id, config \\ %Config{})

Delete a flow.

delete_flow_execution(flow_id, execution_id, config \\ %Config{})

Delete a flow execution.

delete_flows_vault_connection(id, config \\ %Config{})

Delete a Flows Vault connection.

delete_form(id, config \\ %Config{})

Delete a form.

delete_grant(id, config \\ %Config{})

Delete a grant associated with your account.

delete_grant_by_user_id(params \\ %{}, config \\ %Config{})

Delete a grant associated with your account.

delete_group(id, config \\ %Config{})

Delete a Group.

delete_guardian_enrollment(id, config \\ %Config{})

Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA.

delete_hook(id, config \\ %Config{}) deprecated

Delete a hook.

delete_hook_secrets(id, params \\ %{}, config \\ %Config{}) deprecated

Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.

delete_log_stream(id, config \\ %Config{})

Delete a log stream.

delete_network_acl(id, config \\ %Config{})

Delete a network ACL.

delete_network_acl_key(id, config \\ %Config{})

Delete a Network ACL key.

delete_organization(id, config \\ %Config{})

Remove an Organization from your tenant. This action cannot be undone.

delete_organization_associated_connection(id, connection_id, config \\ %Config{})

Delete a connection from an organization.

delete_organization_client_grant(id, grant_id, config \\ %Config{})

Remove a client grant from an organization.

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

Remove client associations from an organization.

delete_organization_connection(id, connection_id, config \\ %Config{})

Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.

delete_organization_discovery_domain(id, discovery_domain_id, config \\ %Config{})

Delete an organization discovery domain.

delete_organization_invitation(id, invitation_id, config \\ %Config{})

Delete an invitation to an Organization

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

Delete members from an organization

delete_organization_roles(id, user_id, params \\ %{}, config \\ %Config{})

Remove one or more Organization-specific roles from a given user.

delete_rate_limit_policy(id, config \\ %Config{})

Delete a rate limit policy.

delete_refresh_token(id, config \\ %Config{})

Delete a refresh token by its ID.

delete_resource_server(id, config \\ %Config{})

Delete an existing API by ID.

delete_role(id, config \\ %Config{})

Delete a specific user role from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.

delete_rule(id, config \\ %Config{}) deprecated

Delete a rule.

delete_rules_config(key, config \\ %Config{})

Delete a rules config variable identified by its key.

delete_self_service_profile(id, config)

Deletes a self-service profile by Id.

delete_session(id, config \\ %Config{})

Delete a session by ID.

delete_template_for_universal_login(config \\ %Config{})

Delete template for New Universal Login Experience

delete_token_exchange_profile(id, config \\ %Config{})

Delete a token exchange profile.

delete_user(id, config \\ %Config{})

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

delete_user_attribute_profile(id, config \\ %Config{})

Delete a user attribute profile.

delete_user_authentication_method(id, authentication_method_id, config)

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

delete_user_authentication_methods(id, config)

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

delete_user_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_user_multifactor(id, params \\ %{}, config \\ %Config{})

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

delete_user_refresh_tokens(id, config \\ %Config{})

Delete all refresh tokens for a user.

delete_user_sessions(id, config \\ %Config{})

Delete all sessions for a user.

delete_verifiable_credential(id, config \\ %Config{})

Delete a verifiable credential verification template.

deploy_action(id, config \\ %Config{})

Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.

get_action(id, config \\ %Config{})

Retrieve an action by its ID.

get_action_execution(id, config \\ %Config{})

Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.

get_action_module(id, config \\ %Config{})

Get a specific Actions Module by ID.

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

List all actions using an Actions Module.

get_action_module_version(id, version_id, config \\ %Config{})

Get a specific version of an Actions Module.

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

List all versions of an Actions Module.

get_action_modules(params \\ %{}, config \\ %Config{})

List Actions Modules.

get_action_trigger_bindings(trigger_id, params \\ %{}, config \\ %Config{})

Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.

get_action_triggers(config \\ %Config{})

Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.

get_action_version(action_id, id, config \\ %Config{})

Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.

get_action_versions(action_id, params \\ %{}, config \\ %Config{})

Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.

get_actions(params \\ %{}, config \\ %Config{})

Retrieve all actions.

get_active_users_count(config \\ %Config{})

Retrieve the number of active users that logged in during the last 30 days.

get_agent(id, config \\ %Config{})

Get an agent.

get_agents(params \\ %{}, config \\ %Config{})

Get agents.

get_attack_protection_bot_detection(config \\ %Config{})

Get the Bot Detection configuration of your tenant.

get_attack_protection_breached_password_detection(config \\ %Config{})

Retrieve details of the Breached Password Detection configuration of your tenant.

get_attack_protection_brute_force_protection(config \\ %Config{})

Retrieve details of the Brute-force Protection configuration of your tenant.

get_attack_protection_captcha(config \\ %Config{})

Get the CAPTCHA configuration for a tenant.

get_attack_protection_phone_provider_protection(config \\ %Config{})

Get Phone Provider Protection settings.

get_attack_protection_suspicious_ip_throttling(config \\ %Config{})

Retrieve details of the Suspicious IP Throttling configuration of your tenant.

get_blacklisted_tokens(params \\ %{}, config \\ %Config{}) deprecated

Retrieve the jti and aud of all tokens that are blacklisted.

get_branding(config \\ %Config{})

Retrieve branding settings.

get_branding_phone_provider(id, config)

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

get_branding_phone_template(id, config)

Get a phone notification template

get_branding_theme(theme_id, config \\ %Config{})

Retrieve branding theme.

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

Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified.

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

Get enabled connections for a client.

get_client_grant(id, config \\ %Config{})

Get client grant.

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

Get the organizations associated to a client grant.

get_client_grants(params \\ %{}, config \\ %Config{})

Retrieve a list of client grants, including the scopes associated with the application/API pair.

get_clients(params \\ %{}, config \\ %Config{})

Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.

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

Retrieve details for a specified connection along with options that can be used for identity provider configuration.

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

Get enabled clients for a connection.

get_connection_directory_provisioning(id, config \\ %Config{})

Get a directory provisioning configuration.

get_connection_directory_provisioning_default_mapping(id, config \\ %Config{})

Get a connection's default directory provisioning attribute mapping.

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

Get synchronized groups for a directory provisioning configuration.

get_connection_keys(id, config \\ %Config{})

Get connection keys.

get_connection_profile(id, config \\ %Config{})

Retrieve a connection profile by its ID.

get_connection_profile_template(id, config \\ %Config{})

Get Connection Profile Template.

get_connection_profile_templates(config \\ %Config{})

Get Connection Profile Templates.

get_connection_profiles(params \\ %{}, config \\ %Config{})

Retrieve a list of connection profiles.

get_connection_scim_configuration(id, config)

Retrieves a scim configuration by its connectionId.

get_connection_scim_configuration_default_mapping(id, config)

Retrieves a scim configuration's default mapping by its connectionId.

get_connection_scim_configuration_tokens(id, config)

Retrieves all scim tokens by its connection id.

get_connection_status(id, config \\ %Config{})

Retrieves the status of an ad/ldap connection referenced by its ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message

get_connections(params \\ %{}, config \\ %Config{})

Retrieves detailed list of all connections that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections.

get_connections_directory_provisionings(params \\ %{}, config \\ %Config{})

Get a list of directory provisioning configurations.

get_connections_scim_configurations(params \\ %{}, config \\ %Config{})

Get a list of SCIM configurations.

get_credential(client_id, credential_id, config \\ %Config{})

Get the details of a client credential.

get_custom_domain_configuration(id, config \\ %Config{})

Get custom domain configuration.

get_custom_domain_configurations(config_or_params \\ %Config{})

Retrieve details on custom domains.

get_custom_domain_configurations(params, config)

get_custom_signing_keys(config \\ %Config{})

Get custom signing keys.

get_daily_stats(config_or_params \\ %Config{})

Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range.

get_daily_stats(params, config)

get_default_branding_theme(config \\ %Config{})

Retrieve default branding theme.

get_default_custom_domain(config \\ %Config{})

Get the default domain.

get_device_credentials(params \\ %{}, config \\ %Config{})

Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.

get_email_provider(params \\ %{}, config \\ %Config{})

Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.

get_email_template(template_name, config \\ %Config{})

Retrieve an email template by pre-defined name. These names are verify_email, verify_email_by_code, reset_email, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, and user_invitation. The names change_password, and password_reset are also supported for legacy scenarios.

get_encryption_key(kid, config)

Retrieve details of the encryption key with the given ID.

get_encryption_keys(params, config)

Retrieve details of all the encryption keys associated with your tenant.

get_event_stream(id, config \\ %Config{})

Retrieve an event stream by its ID.

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

Get this event stream's delivery history.

get_event_stream_delivery(id, event_id, config \\ %Config{})

Get a specific event's delivery history.

get_event_streams(params \\ %{}, config \\ %Config{})

Retrieve all event streams.

get_flow(id, params, config)

Get a flow.

get_flow_execution(flow_id, execution_id, params \\ %{}, config \\ %Config{})

Get a flow execution.

get_flow_executions(flow_id, params \\ %{}, config \\ %Config{})

Get flow executions.

get_flows(params, config)

Get flows.

get_flows_vault_connection(id, config \\ %Config{})

Get a Flows Vault connection.

get_flows_vault_connections(params \\ %{}, config \\ %Config{})

Get Flows Vault connection list.

get_form(id, params, config)

Get a form.

get_forms(params, config)

Get forms.

get_grants(params \\ %{}, config \\ %Config{})

Retrieve the grants associated with your account.

get_group(id, config \\ %Config{})

Get a Group.

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

Get Group Members.

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

Get a group's roles.

get_groups(params \\ %{}, config \\ %Config{})

Get all Groups.

get_guardian_apns_configuration(config)

Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant.

get_guardian_aws_sns_configuration(config \\ %Config{})

Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA.

get_guardian_duo_settings(config \\ %Config{})

Get DUO Configuration.

get_guardian_email_settings(config \\ %Config{})

Get Email Factor Settings.

get_guardian_enrollment(id, config \\ %Config{})

Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.

get_guardian_factors(config \\ %Config{})

Retrieve details of all multi-factor authentication factors associated with your tenant.

get_guardian_notification_provider(config)

Retrieve the push notification provider configured for your tenant.

get_guardian_phone_configuration(config \\ %Config{})

Retrieve details of the multi-factor authentication phone provider configured for your tenant.

get_guardian_phone_factor(config \\ %Config{})

Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

get_guardian_phone_settings(config \\ %Config{})

Get Phone Factor Settings.

get_guardian_phone_template(config \\ %Config{})

Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.

get_guardian_settings(config \\ %Config{})

Get Guardian Settings.

get_guardian_twilio_phone_configuration(config \\ %Config{})

Retrieve configuration details for a Twilio phone provider that has been set up in your tenant.

get_hook(id, params \\ %{}, config \\ %Config{}) deprecated

Retrieve a hook by its ID. Accepts a list of fields to include in the result.

get_hook_secrets(id, config \\ %Config{}) deprecated

Retrieve a hook's secrets by the ID of the hook.

get_hooks(params \\ %{}, config \\ %Config{}) deprecated

Retrieve all hooks. Accepts a list of fields to include or exclude in the result.

get_job(id, config \\ %Config{})

Retrieves a job. Useful to check its status.

get_job_error(id, config \\ %Config{})

Retrieve error details of a failed job.

get_log_event(id, config \\ %Config{})

Retrieve an individual log event.

get_log_events(params \\ %{}, config \\ %Config{})

Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).

get_log_stream(id, config \\ %Config{})

Retrieve a log stream configuration and status.

get_log_streams(config \\ %Config{})

Retrieve details on log streams.

get_network_acl(id, config \\ %Config{})

Retrieve a network ACL by its ID.

get_network_acl_key(id, config \\ %Config{})

Get a Network ACL Key.

get_network_acl_keys(config \\ %Config{})

Get all Network ACL keys.

get_network_acls(params \\ %{}, config \\ %Config{})

Retrieve a list of network ACLs.

get_organization(id, config \\ %Config{})

Retrieve details about a single Organization specified by ID.

get_organization_associated_connection(id, connection_id, config \\ %Config{})

Get a specific connection associated with an organization.

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

Get connections associated with an organization.

get_organization_by_name(name, config \\ %Config{})

Retrieve details about a single Organization specified by name.

get_organization_client(id, client_id, config \\ %Config{})

Get an organization client association.

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

Get client grants associated to an organization.

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

List organization client associations.

get_organization_connection(id, connection_id, config \\ %Config{})

Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.

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

get_organization_discovery_domain(id, discovery_domain_id, config \\ %Config{})

Retrieve an organization discovery domain by ID.

get_organization_discovery_domain_by_name(id, discovery_domain, config \\ %Config{})

Retrieve an organization discovery domain by domain name.

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

Retrieve all organization discovery domains.

get_organization_group_roles(organization_id, group_id, params \\ %{}, config \\ %Config{})

List the roles assigned to a group in the context of an organization.

get_organization_groups(organization_id, params \\ %{}, config \\ %Config{})

List the groups that are assigned to the organization.

get_organization_invitation(id, invitation_id, params \\ %{}, config \\ %Config{})

Get a specific invitation to an Organization

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

Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration.

get_organization_member_effective_role_group_sources(id, user_id, params \\ %{}, config \\ %Config{})

List organization member role group sources.

get_organization_member_effective_roles(id, user_id, params \\ %{}, config \\ %Config{})

List organization member effective roles.

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

List organization members.

get_organization_role_groups(organization_id, role_id, params \\ %{}, config \\ %Config{})

List the groups assigned to a role in the context of an organization.

get_organization_role_members(id, role_id, params \\ %{}, config \\ %Config{})

List the members assigned to a role in the context of an organization.

get_organization_roles(id, user_id, params \\ %{}, config \\ %Config{})

Retrieve detailed list of roles assigned to a given user within the context of a specific Organization.

get_organizations(params \\ %{}, config \\ %Config{})

Retrive detailed list of all Organizations available in your tenant.

get_prompt_custom_text(prompt, language, config \\ %Config{})

Retrieve custom text for a specific prompt and language.

get_prompt_partials(prompt, config \\ %Config{})

Get template partials for a prompt

get_prompt_rendering(prompt, screen, config \\ %Config{})

Get the render settings (rendering configuration) of a single screen.

get_prompt_renderings(params \\ %{}, config \\ %Config{})

Get render setting configurations for all screens.

get_prompt_setting(config \\ %Config{})

Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

get_rate_limit_policies(params \\ %{}, config \\ %Config{})

Get rate limit policies.

get_rate_limit_policy(id, config \\ %Config{})

Get a rate limit policy.

get_refresh_token(id, config \\ %Config{})

Retrieve refresh token information.

get_refresh_tokens(params \\ %{}, config \\ %Config{})

Get refresh tokens.

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

Retrieve API details with the given ID.

get_resource_servers(params \\ %{}, config \\ %Config{})

Retrieve details of all APIs associated with your tenant.

get_risk_assessment(id, config \\ %Config{}) deprecated

Retrieve a risk assessment by its ID.

get_risk_assessments_new_device_settings(config \\ %Config{})

Get new device assessor.

get_risk_assessments_settings(config \\ %Config{})

Get risk assessment settings.

get_role(id, config \\ %Config{})

Retrieve details about a specific user role specified by ID.

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

Get a role's groups.

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

Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.

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

Retrieve list of users associated with a specific role.

get_roles(params \\ %{}, config \\ %Config{})

Retrieve detailed list of user roles created in your tenant.

get_rule(id, params \\ %{}, config \\ %Config{}) deprecated

Retrieve rule details. Accepts a list of fields to include or exclude in the result.

get_rules(params \\ %{}, config \\ %Config{}) deprecated

Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.

get_rules_configs(config \\ %Config{})

Retrieve rules config variable keys.

get_self_service_profile(id, config)

Retrieves a self-service profile by Id.

get_self_service_profile_custom_text(id, language, page, config \\ %Config{})

Get custom text for a self-service profile.

get_self_service_profiles(params, config)

Retrieves self-service profiles. Currently only one profile can be created per tenant.

get_session(id, config \\ %Config{})

Retrieve session information.

get_signing_key(kid, config \\ %Config{})

Retrieve details of the application signing key with the given ID.

get_signing_keys(config \\ %Config{})

Retrieve details of all the application signing keys associated with your tenant.

get_supplemental_signal(id, config \\ %Config{}) deprecated

Retrieve a supplemental signal by its ID.

get_supplemental_signals(config \\ %Config{})

Get the supplemental signals configuration for a tenant.

get_template_for_universal_login(config \\ %Config{})

Get template for New Universal Login Experience

get_tenant_setting(params \\ %{}, config \\ %Config{})

Retrieve tenant settings. A list of fields to include or exclude may also be specified.

get_token_exchange_profile(id, config \\ %Config{})

Retrieve a token exchange profile by its ID.

get_token_exchange_profiles(params \\ %{}, config \\ %Config{})

Retrieve a list of token exchange profiles.

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

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

get_user_attribute_profile(id, config \\ %Config{})

Retrieve a user attribute profile by its ID.

get_user_attribute_profile_template(id, config \\ %Config{})

Get User Attribute Profile Template.

get_user_attribute_profile_templates(config \\ %Config{})

Get User Attribute Profile Templates.

get_user_attribute_profiles(params \\ %{}, config \\ %Config{})

Retrieve a list of user attribute profiles.

get_user_authentication_method(id, authentication_method_id, config)

Get an authentication method by ID

get_user_block(params \\ %{}, config \\ %Config{})

Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).

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

Retrieve details of all Brute-force Protection blocks for the user with the given ID.

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

Get a User's Connected Accounts.

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

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

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

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

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

Get a user's role source groups.

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

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

get_user_enrollments(id, config \\ %Config{})

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

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

Get user's groups.

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

Retrieve log events for a specific user.

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

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

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

Retrieve all permissions associated with the user.

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

Retrieve details for a user's refresh tokens.

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

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

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

Retrieve details for a user's sessions.

get_users(params \\ %{}, config \\ %Config{})

Retrieve details of users.

get_users_by_email(params \\ %{}, config \\ %Config{})

Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.

get_verifiable_credential(id, config \\ %Config{})

Retrieve a verifiable credential verification template by its ID.

get_verifiable_credentials(params \\ %{}, config \\ %Config{})

Retrieve the verifiable credential verification templates (GET /api/v2/verifiable-credentials/verification/templates).

import_encryption_key(kid, params, config)

Import wrapped key material and activate encryption key.

invalidate_user_remembered_browser_for_multifactor(id, config \\ %Config{})

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

link_user_identities(id, params \\ %{}, config \\ %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_branding_phone_providers(params, config)

Retrieve a list ofphone providers details set for a Tenant. A list of fields to include or exclude may also be specified.

list_branding_phone_templates(params, config)

Get a list of phone notification templates

list_credentials(client_id, config \\ %Config{})

Get the details of a client credential.

list_guardian_policies(config \\ %Config{})

Retrieve the multi-factor authentication (MFA) policies configured for your tenant.

list_user_authentication_methods(id, params, config)

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

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

Update the details of a specific Organization, such as name and display name, branding options, and metadata.

modify_organization_connection(id, connection_id, params \\ %{}, config \\ %Config{})

Modify the details of a specific connection currently enabled for an Organization.

patch_email_template(template_name, params \\ %{}, config \\ %Config{})

Modify an email template.

patch_guardian_apns_configuration(params, config)

Modify configuration details of the multi-factor authentication APNS provider associated with your tenant.

patch_guardian_aws_sns_configuration(params \\ %{}, config \\ %Config{})

Configure the AWS SNS push notification provider configuration (subscription required).

patch_guardian_duo_settings(params \\ %{}, config \\ %Config{})

Update the DUO Configuration.

patch_guardian_fcm_configuration(params, config)

Modify configuration details of the multi-factor authentication FCM provider associated with your tenant.

patch_guardian_fcmv1_configuration(params, config)

Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.

preview_client_cimd_metadata(params \\ %{}, config \\ %Config{})

Preview and validate Client ID Metadata Document.

redeliver_event_stream_event(id, event_id, config \\ %Config{})

Redeliver a single failed event by ID.

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

Redeliver failed events.

regenerate_user_recovery_code(id, config \\ %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.

register_cimd_client(params \\ %{}, config \\ %Config{})

rekey_encryption_key(config)

Perform rekeying operation on the key hierarchy.

remove_blocked_ip(ip, config \\ %Config{})

Remove a block imposed by Suspicious IP Throttling for the given IP address.

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

Remove roles from a group.

remove_organization_group_roles(organization_id, group_id, params \\ %{}, config \\ %Config{})

Remove roles assigned to a group in an organization context.

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

Remove groups from a role.

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

Remove one or more permissions from a specified user role.

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

Remove permissions from a user.

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

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

reset_branding_phone_template(id, params, config)

Resets a phone notification template values

revoke_refresh_tokens(params \\ %{}, config \\ %Config{})

Revoke refresh tokens.

revoke_self_service_profile_sso_ticket(profile_id, id, config \\ %Config{})

Revoke a Self-Service Enterprise Configuration access ticket.

revoke_session(id, config \\ %Config{})

Revokes a session by ID and all associated refresh tokens.

revoke_signing_key(kid, config \\ %Config{})

Revoke the application signing key with the given ID.

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

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

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

Rollback an Actions Module to a previous version.

rollback_action_version(action_id, id, params \\ %{}, config \\ %Config{})

Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.

rotate_client_secret(id, config \\ %Config{})

Rotate a client secret.

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

Rotate connection keys.

rotate_signing_key(config \\ %Config{})

Rotate the application signing key of your tenant.

search_organizations(params \\ %{}, config \\ %Config{})

Search organizations.

search_resource_servers(params \\ %{}, config \\ %Config{})

Search resource servers.

send_job_verification_email(params \\ %{}, config \\ %Config{}, opts \\ [])

Send an email to the specified user that asks them to click a link to verify their email address.

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

Create or replace synchronized group selections for a directory provisioning configuration.

set_custom_signing_keys(params \\ %{}, config \\ %Config{})

Create or replace custom signing keys.

set_default_custom_domain(params \\ %{}, config \\ %Config{})

Update the default custom domain for the tenant.

set_guardian_policies(params \\ %{}, config \\ %Config{})

Set multi-factor authentication (MFA) policies for your tenant.

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

Update Access Control List.

set_prompt_custom_text(prompt, language, params \\ %{}, config \\ %Config{})

Set custom text for a specific prompt. Existing texts will be overwritten.

set_prompt_partials(prompt, params \\ %{}, config \\ %Config{})

Set template partials for a prompt

set_rules_config(key, params \\ %{}, config \\ %Config{})

Sets a rules config variable.

set_self_service_profile_custom_text(id, language, page, params \\ %{}, config \\ %Config{})

Set custom text for a self-service profile.

set_template_for_universal_login(params \\ %{}, config \\ %Config{})

Update the Universal Login branding template.

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

Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.

test_branding_phone_provider(id, params, config)

Send a test phone notification for the configured provider

test_branding_phone_template(id, params, config, opts \\ [])

Send a test phone notification for the configured template

test_custom_domain(id, config \\ %Config{})

Test a custom domain.

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

Send a test event to an event stream.

unblock_user_block(params \\ %{}, config \\ %Config{})

Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).

unblock_user_block_by_user_id(id, config \\ %Config{})

Remove all Brute-force Protection blocks for the user with the given ID.

unlink_user_identities(id, provider, user_id, config \\ %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_action(id, params \\ %{}, config \\ %Config{})

Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.

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

Update a specific Actions Module.

update_action_trigger_bindings(trigger_id, params \\ %{}, config \\ %Config{})

Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.

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

Update an agent.

update_attack_protection_bot_detection(params \\ %{}, config \\ %Config{})

Update the Bot Detection configuration of your tenant.

update_attack_protection_breached_password_detection(params \\ %{}, config \\ %Config{})

Update details of the Breached Password Detection configuration of your tenant.

update_attack_protection_brute_force_protection(params \\ %{}, config \\ %Config{})

Update the Brute-force Protection configuration of your tenant.

update_attack_protection_captcha(params \\ %{}, config \\ %Config{})

Partial Update for CAPTCHA Configuration.

update_attack_protection_phone_provider_protection(params \\ %{}, config \\ %Config{})

Update Phone Provider Protection settings.

update_attack_protection_suspicious_ip_throttling(params \\ %{}, config \\ %Config{})

Update the details of the Suspicious IP Throttling configuration of your tenant.

update_branding(params \\ %{}, config \\ %Config{})

Update branding settings.

update_branding_phone_provider(id, params, config)

Update an phone provider.

update_branding_phone_template(id, params, config)

Update a phone notification template

update_branding_theme(theme_id, params \\ %{}, config \\ %Config{})

Update branding theme.

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

Updates a client's settings

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

Update a client grant.

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

Update details for a specific connection, including option properties for identity provider configuration.

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

Update enabled clients for a connection.

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

Patch a directory provisioning configuration.

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

Update a connection profile.

update_connection_scim_configuration(id, params, config)

Update a scim configuration by its connectionId.

update_credential(client_id, credential_id, params, config \\ %Config{})

Change a client credential you previously created. May be enabled or disabled.

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

Update a custom domain.

update_email_provider(params \\ %{}, config \\ %Config{})

Update an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property)

update_email_template(template_name, params \\ %{}, config \\ %Config{})

Update an email template.

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

Update an event stream.

update_flow(id, params, config)

Update a flow.

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

Update a Flows Vault connection.

update_form(id, params, config)

Update a form.

update_guardian_apns_configuration(params, config)

Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.

update_guardian_aws_sns_configuration(params \\ %{}, config \\ %Config{})

Configure the AWS SNS push notification provider configuration (subscription required).

update_guardian_duo_settings(params \\ %{}, config \\ %Config{})

Set the DUO Configuration.

update_guardian_email_settings(params \\ %{}, config \\ %Config{})

Set the Email Factor Settings.

update_guardian_factor(name, params \\ %{}, config \\ %Config{})

Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.

update_guardian_fcm_configuration(params, config)

Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.

update_guardian_fcmv1_configuration(params, config)

Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.

update_guardian_notification_provider(params, config)

Modify the push notification provider configured for your tenant.

update_guardian_phone_configuration(params \\ %{}, config \\ %Config{})

Update phone provider configuration

update_guardian_phone_factor(params \\ %{}, config \\ %Config{})

Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

update_guardian_phone_settings(params \\ %{}, config \\ %Config{})

Set the Phone Factor Settings.

update_guardian_phone_template(params \\ %{}, config \\ %Config{})

Customize the messages sent to complete phone enrollment and verification (subscription required).

update_guardian_settings(params \\ %{}, config \\ %Config{})

Set the Guardian Settings.

update_guardian_twilio_phone_configuration(params \\ %{}, config \\ %Config{})

Update the configuration of a Twilio phone provider that has been set up in your tenant.

update_hook(id, params \\ %{}, config \\ %Config{}) deprecated

Update an existing hook.

update_hook_secrets(id, params \\ %{}, config \\ %Config{}) deprecated

Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.

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

Update a log stream.

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

Update a network ACL.

update_organization_associated_connection(id, connection_id, params \\ %{}, config \\ %Config{})

Update a connection for an organization.

update_organization_client(id, client_id, params \\ %{}, config \\ %Config{})

Update an organization client association.

update_organization_discovery_domain(id, discovery_domain_id, params \\ %{}, config \\ %Config{})

Update an organization discovery domain.

update_prompt_rendering(prompt, screen, params \\ %{}, config \\ %Config{})

Update the render settings (rendering configuration) of a single screen.

update_prompt_setting(params \\ %{}, config \\ %Config{})

Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

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

Update a rate limit policy.

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

Update a refresh token.

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

Change an existing API setting by resource server ID.

update_risk_assessments_new_device_settings(params \\ %{}, config \\ %Config{})

Update new device assessor.

update_risk_assessments_settings(params \\ %{}, config \\ %Config{})

Update risk assessment settings.

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

Modify the details of a specific user role specified by ID.

update_rule(id, params \\ %{}, config \\ %Config{}) deprecated

Update an existing rule.

update_self_service_profile(id, params, config)

Updates a self-service profile.

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

Update session information.

update_supplemental_signals(params \\ %{}, config \\ %Config{})

Update the supplemental signals configuration for a tenant.

update_tenant_setting(params \\ %{}, config \\ %Config{})

Update settings for a tenant.

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

Update a token exchange profile.

update_user(id, params \\ %{}, config \\ %Config{}, opts \\ [])

Update a user.

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

Update a user attribute profile.

update_user_authentication_method(id, authentication_method_id, params, config)

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

update_user_authentication_methods(id, params, config)

Replace the specified user authentication methods with supplied values.

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

Update a verifiable credential verification template.

verify_custom_domain(id, config \\ %Config{})

Run the verification process on a custom domain.

Types

action_id()

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

authentication_method_id()

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

client_id()

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

config()

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

connection_id()

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

credential_id()

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

error()

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

id()

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

invitation_id()

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

ip()

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

key()

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

kid()

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

language()

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

name()

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

prompt()

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

provider()

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

provider_params()

@type provider_params() :: %{:provider => String.t(), optional(any()) => any()}

request_opts()

@type request_opts() :: [{:custom_domain, String.t()}]

template_name()

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

theme_id()

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

token_id()

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

trigger_id()

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

user_id()

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

value_params()

@type value_params() :: %{:value => list() | map(), optional(any()) => any()}

Functions

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

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

Add synchronized group selections to a directory provisioning configuration.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/post-synchronized-groups

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

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.

Deprecated: Auth0 Hooks are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/hooks). Use the secrets of an action (update_action/3) instead.

see

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

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

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

Add a connection to an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/post-organization-connection

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

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

Associate clients with an organization.

Associate one or more clients with an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/post-organization-clients

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

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

Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.

see

https://auth0.com/docs/api/management/v2/organizations/post-enabled-connections

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

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

Set one or more existing users as members of a specific Organization.

see

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

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

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

Assign roles to a group.

Assign one or more roles to a specified group.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/groups/post-group-roles

assign_organization_group_roles(organization_id, group_id, params \\ %{}, config \\ %Config{})

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

Assign roles to a group in an organization context.

Assign one or more roles to a specified group in the context of an organization.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/post-organization-group-roles

assign_organization_roles(id, user_id, params \\ %{}, config \\ %Config{})

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

Assign one or more roles to a user to determine their access for a specific Organization.

see

https://auth0.com/docs/api/management/v2/organizations/post-organization-member-roles

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

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

Assign groups to a role.

Assign one or more groups to a specified role.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/roles/post-role-groups

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

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

Assign one or more users to an existing user role.

see

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

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

@spec assign_user_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_user_roles(id, params \\ %{}, config \\ %Config{})

@spec assign_user_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

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

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

Associate a client grant with an organization.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/create-organization-client-grants

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

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

Add one or more permissions to a specified user role.

see

https://auth0.com/docs/api/management/v2/roles/post-role-permission-assignment

blacklist_token(params \\ %{}, config \\ %Config{})

This function is deprecated. The blacklists endpoints were removed from the Auth0 Management API..

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

Add the token identified by the jti to a blacklist for the tenant.

Deprecated: The endpoint is not part of the Auth0 Management API v2 specification any more (/api/v2/blacklists/tokens). There is no direct replacement; revoke credentials with the purpose-specific APIs, e.g. revoke_refresh_tokens/2 or revoke_session/2.

see

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

bulk_update_prompt_renderings(params \\ %{}, config \\ %Config{})

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

Update render settings for multiple screens.

Learn more about configuring render settings for advanced customization.

see

https://auth0.com/docs/api/management/v2/prompts/patch-bulk-rendering

check_ip_blocked(ip, config \\ %Config{})

@spec check_ip_blocked(ip(), config()) :: {:ok, boolean()} | error()

Check if the given IP address is blocked via the Suspicious IP Throttling due to multiple suspicious attempts.

see

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

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

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

Clear risk assessment assessors for a specific user.

Path parameters are percent-encoded before they are placed in the request path.

see

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

configure_branding_phone_provider(params, config)

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

Create an phone provider.

see

https://auth0.com/docs/api/management/v2/branding/create-phone-provider

configure_custom_domain(params \\ %{}, config \\ %Config{})

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

Create a new custom domain.

see

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

configure_email_provider(params \\ %{}, config \\ %Config{})

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

Create an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property):

see

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

create_action(params \\ %{}, config \\ %Config{})

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

Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.

see

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

create_action_module(params \\ %{}, config \\ %Config{})

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

Create a new Actions Module.

Create a new Actions Module for reusable code across actions.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/actions/post-action-module

create_action_module_version(id, config \\ %Config{})

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

Create a new version of an Actions Module.

Creates a new immutable version of an Actions Module from the current draft version. This publishes the draft as a new version that can be referenced by actions, while maintaining the existing draft for continued development.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/actions/post-action-module-version

create_agent(params \\ %{}, config \\ %Config{})

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

Create an agent.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

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

create_branding_phone_template(params, config)

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

Create a phone notification template

see

https://auth0.com/docs/api/management/v2/branding/create-phone-template

create_branding_theme(params \\ %{}, config \\ %Config{})

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

Create branding theme.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

identifiers (Early Access)

see

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

create_client(params \\ %{}, config \\ %Config{})

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

Create a new client (application or SSO integration).

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

anonymous_sessions (Early Access)
b2b_integration_configuration (Early Access)
fedcm_login (Early Access)
identity_assertion_authorization_grant (Early Access)
my_organization_configuration (Early Access)
organization_discovery_methods (Early Access)
token_quota (Early Access)
token_vault_privileged_access (Early Access)

deprecated parameters

The body property oidc_backchannel_logout is deprecated (Auth0 specification: x-release-lifecycle: deprecated); use oidc_logout instead.

see

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

create_client_grant(params \\ %{}, config \\ %Config{})

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

Create a client grant for a machine-to-machine login flow.

see

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

create_connection(params \\ %{}, config \\ %Config{})

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

Creates a new connection according to the JSON object received in body.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

cross_app_access_requesting_app (Early Access)
cross_app_access_resource_app (Early Access)

deprecated parameters

enabled_clients is deprecated (Auth0 specification: x-release-lifecycle: deprecated); manage the enabled clients with get_connection_clients/3 and update_connection_clients/3 instead.
Some options / strategies are deprecated in the Auth0 specification: the Facebook options allow_context_profile_field, manage_notifications, publish_actions, read_mailbox, read_stream, user_groups, user_managed_groups, user_status (removed Facebook permissions, no replacement); the sms strategy options forward_req_info, from, gateway_authentication, gateway_url, messaging_service_sid, provider, syntax, template, twilio_sid, twilio_token; the SAML options.cert (.der certificate); and the ip, instagram, oauth1, office365 (creation), sharepoint, soundcloud and untappd strategies.

see

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

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

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

Create a directory provisioning configuration.

Create a directory provisioning configuration for a connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/post-directory-provisioning

create_connection_directory_provisioning_synchronization(id, config \\ %Config{})

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

Request an on-demand synchronization of the directory.

Path parameters are percent-encoded before they are placed in the request path.

see

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

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

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

Create connection keys.

Provision initial connection keys for Okta or OIDC connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions.

Path parameters are percent-encoded before they are placed in the request path.

see

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

create_connection_profile(params \\ %{}, config \\ %Config{})

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

Create a connection profile.

Create a Connection Profile.

see

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

create_connection_scim_configuration(id, params, config)

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

Create a scim configuration for a connection.

see

https://auth0.com/docs/api/management/v2/connections/post-scim-configuration

create_connection_scim_configuration_tokens(id, params, config)

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

Create a scim token for a scim client.

see

https://auth0.com/docs/api/management/v2/connections/post-scim-token

create_credential(client_id, params, config \\ %Config{})

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

see

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

create_device_credential(params \\ %{}, config \\ %Config{})

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

see

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

create_email_template(params \\ %{}, config \\ %Config{})

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

Create an email template.

see

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

create_email_verification_ticket(params \\ %{}, config \\ %Config{}, opts \\ [])

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

Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address.

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

https://auth0.com/docs/api/management/v2/tickets/post-email-verification

create_encryption_key(params, config)

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

Create the new, pre-activated encryption key, without the key material.

see

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

create_encryption_wrapping_key(kid, config)

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

Create the public wrapping key to wrap your own encryption key material.

see

https://auth0.com/docs/api/management/v2/keys/post-encryption-wrapping-key

create_event_stream(params \\ %{}, config \\ %Config{})

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

Create an event stream.

see

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

create_flow(params, config)

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

Create a flow.

see

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

create_flows_vault_connection(params \\ %{}, config \\ %Config{})

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

Create a Flows Vault connection.

see

https://auth0.com/docs/api/management/v2/flows/post-flows-vault-connections

create_form(params, config)

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

Create a form.

see

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

create_guardian_enrollment_ticket(params \\ %{}, config \\ %Config{}, opts \\ [])

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

Create a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket, to a given user.

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

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

create_hook(params \\ %{}, config \\ %Config{})

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Create a new hook.

Deprecated: Auth0 Hooks are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/hooks). Use create_action/2 (then deploy_action/2 and update_action_trigger_bindings/3) instead.

see

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

create_job_users_exports(params \\ %{}, config \\ %Config{})

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

Export all users to a file via a long-running job.

see

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

create_job_users_imports(params \\ %{}, config \\ %Config{})

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

Import users from a formatted file into a connection via a long-running job.

see

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

create_log_stream(params \\ %{}, config \\ %Config{})

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

Create a log stream.

see

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

create_network_acl(params \\ %{}, config \\ %Config{})

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

Create a network ACL.

see

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

create_network_acl_key(params \\ %{}, config \\ %Config{})

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

Create a Network ACL key.

Create a new key used to verify HTTP Message Signatures on Network ACL rules.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/keys/create-keys-network-acls

create_organization(params \\ %{}, config \\ %Config{})

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

Create a new Organization within your tenant.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

is_app_entitlement_active (Early Access)
token_quota (Early Access)

see

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

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

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

Create an organization discovery domain.

Create a new discovery domain for an organization.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/post-discovery-domains

create_organization_invitation(id, params \\ %{}, config \\ %Config{}, opts \\ [])

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

Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization.

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

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

create_password_change_ticket(params \\ %{}, config \\ %Config{}, opts \\ [])

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

Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

identity (Early Access)

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

https://auth0.com/docs/api/management/v2/tickets/post-password-change

create_rate_limit_policy(params \\ %{}, config \\ %Config{})

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

Create a rate limit policy.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/post-rate-limit-policies

create_resource_server(params \\ %{}, config \\ %Config{})

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

Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

access_token (Early Access)
authorization_policy (Early Access)
require_consent_non_repudiation (Early Access)
token_lifetime_for_anonymous_access_tokens (Early Access)

see

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

create_risk_assessment(params \\ %{}, config \\ %Config{})

This function is deprecated. POST /api/v2/risk-assessments does not exist in the Auth0 Management API. Use get_risk_assessments_settings/1 and update_risk_assessments_settings/2..

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

Create a risk assessment.

Deprecated: The endpoint is not part of the Auth0 Management API v2 specification any more (POST /api/v2/risk-assessments). Risk assessments are configured through get_risk_assessments_settings/1, update_risk_assessments_settings/2, the new-device settings functions and clear_user_risk_assessments/3.

see

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

create_role(params \\ %{}, config \\ %Config{})

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

Create a user role for Role-Based Access Control.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

owner_id (Early Access)
type (Early Access)

see

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

create_rule(params \\ %{}, config \\ %Config{})

This function is deprecated. Auth0 Rules are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Create a new rule.

Deprecated: Auth0 Rules are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/rules). Use create_action/2 (then deploy_action/2 and update_action_trigger_bindings/3) instead.

see

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

create_self_service_profile(params, config)

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

Creates a self-service profile. Currently only one profile can be created per tenant.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

user_attribute_profile_id (Early Access)

see

https://auth0.com/docs/api/management/v2/self-service-profiles/post-self-service-profiles

create_self_service_profile_sso_ticket(id, params, config, opts \\ [])

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

Creates an sso-access ticket to initiate the Self Service SSO Flow using a self-service profile.

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/post-sso-ticket

create_supplemental_signal(params \\ %{}, config \\ %Config{})

This function is deprecated. POST /api/v2/supplemental-signals does not exist in the Auth0 Management API. Use update_supplemental_signals/2..

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

Create a supplemental signal.

Deprecated: The endpoint is not part of the Auth0 Management API v2 specification any more (POST /api/v2/supplemental-signals). The supplemental signals configuration is read with get_supplemental_signals/1 and changed with update_supplemental_signals/2.

see

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

create_token_exchange_profile(params \\ %{}, config \\ %Config{})

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

Create a token exchange profile.

see

https://auth0.com/docs/api/management/v2/token-exchange-profiles/post-token-exchange-profiles

create_user(params \\ %{}, config \\ %Config{}, opts \\ [])

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

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

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

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

create_user_attribute_profile(params \\ %{}, config \\ %Config{})

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

Create a user attribute profile.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/post-user-attribute-profiles

create_user_authentication_methods(id, params, config)

@spec create_user_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

create_verifiable_credential(params \\ %{}, config \\ %Config{})

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

Create a verifiable credential verification template (POST /api/v2/verifiable-credentials/verification/templates).

see

https://auth0.com/docs/api/management/v2/verifiable-credentials/post-vc-templates

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

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

Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.

query parameters

force

see

https://auth0.com/docs/api/management/v2/actions/delete-action

delete_action_module(id, config \\ %Config{})

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

Delete a specific Actions Module by ID.

Permanently delete an Actions Module. This will fail if the module is still in use by any actions.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/actions/delete-action-module

delete_agent(id, config \\ %Config{})

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

Delete an agent.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/agents/delete-agent

delete_branding_phone_provider(id, config)

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

Delete the configured phone provider.

see

https://auth0.com/docs/api/management/v2/branding/delete-phone-provider

delete_branding_phone_template(id, config)

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

Delete a phone notification template

see

https://auth0.com/docs/api/management/v2/branding/delete-phone-template

delete_branding_theme(theme_id, config \\ %Config{})

@spec delete_branding_theme(theme_id(), config()) :: {:ok, String.t()} | error()

Delete branding theme.

see

https://auth0.com/docs/api/management/v2/branding/delete-branding-theme

delete_client(id, config \\ %Config{})

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

Delete a client and related configuration (rules, connections, etc).

see

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

delete_client_grant(id, config \\ %Config{})

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

Delete the Client Credential Flow from your machine-to-machine application.

see

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

delete_connection(id, config \\ %Config{})

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

Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.

see

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

delete_connection_directory_provisioning(id, config \\ %Config{})

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

Delete a directory provisioning configuration.

Delete the directory provisioning configuration of a connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/delete-directory-provisioning

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

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

Delete synchronized group selections for a directory provisioning configuration.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/delete-synchronized-groups

delete_connection_profile(id, config \\ %Config{})

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

Delete Connection Profile.

Delete a single Connection Profile specified by ID.

Path parameters are percent-encoded before they are placed in the request path.

see

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

delete_connection_scim_configuration(id, config)

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

Deletes a scim configuration by its connectionId.

see

https://auth0.com/docs/api/management/v2/connections/delete-scim-configuration

delete_connection_scim_configuration_tokens(id, token_id, config)

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

Deletes a scim token by its connection id and tokenId.

see

https://auth0.com/docs/api/management/v2/connections/delete-tokens-by-token-id

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

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

Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.

query parameters

email (required)

see

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

delete_credential(client_id, credential_id, config \\ %Config{})

@spec delete_credential(client_id(), credential_id(), config()) ::
  {:ok, String.t()} | error()

Delete a client credential you previously created. May be enabled or disabled.

see

https://auth0.com/docs/api/management/v2/clients/delete-credentials-by-credential-id

delete_custom_domain_configuration(id, config \\ %Config{})

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

Delete a custom domain and stop serving requests for it.

see

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

delete_custom_signing_keys(config \\ %Config{})

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

Delete custom signing keys.

Delete entire jwks representation of custom signing keys.

see

https://auth0.com/docs/api/management/v2/keys/delete-custom-signing-keys

delete_device_credential(id, config \\ %Config{})

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

Permanently delete a device credential (such as a refresh token or public key) with the given ID.

see

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

delete_email_provider(config \\ %Config{})

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

Delete email provider.

Delete the email provider.

see

https://auth0.com/docs/api/management/v2/emails/delete-provider

delete_encryption_key(kid, config)

@spec delete_encryption_key(kid(), config()) :: {:ok, String.t()} | error()

Delete the custom provided encryption key with the given ID and move back to using native encryption key.

see

https://auth0.com/docs/api/management/v2/keys/delete-encryption-key

delete_event_stream(id, config \\ %Config{})

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

Delete an event stream.

see

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

delete_flow(id, config \\ %Config{})

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

Delete a flow.

Path parameters are percent-encoded before they are placed in the request path.

see

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

delete_flow_execution(flow_id, execution_id, config \\ %Config{})

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

Delete a flow execution.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/flows/delete-flows-executions-by-execution-id

delete_flows_vault_connection(id, config \\ %Config{})

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

Delete a Flows Vault connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/flows/delete-flows-vault-connections-by-id

delete_form(id, config \\ %Config{})

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

Delete a form.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/forms/delete-form

delete_grant(id, config \\ %Config{})

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

Delete a grant associated with your account.

see

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

delete_grant_by_user_id(params \\ %{}, config \\ %Config{})

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

Delete a grant associated with your account.

query parameters

user_id (required)

see

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

delete_group(id, config \\ %Config{})

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

Delete a Group.

Delete a group by its ID.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/groups/delete-group

delete_guardian_enrollment(id, config \\ %Config{})

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

Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA.

see

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

delete_hook(id, config \\ %Config{})

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Delete a hook.

Deprecated: Auth0 Hooks are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/hooks). Use delete_action/3 instead.

see

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

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

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.

see

https://auth0.com/docs/api/management/v2/hooks/delete-secrets

delete_log_stream(id, config \\ %Config{})

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

Delete a log stream.

see

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

delete_network_acl(id, config \\ %Config{})

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

Delete a network ACL.

see

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

delete_network_acl_key(id, config \\ %Config{})

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

Delete a Network ACL key.

Delete a key used to verify HTTP Message Signatures on Network ACL rules

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/keys/delete-keys-network-acls

delete_organization(id, config \\ %Config{})

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

Remove an Organization from your tenant. This action cannot be undone.

see

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

delete_organization_associated_connection(id, connection_id, config \\ %Config{})

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

Delete a connection from an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/delete-organization-connection

delete_organization_client_grant(id, grant_id, config \\ %Config{})

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

Remove a client grant from an organization.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/delete-client-grants-by-grant-id

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

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

Remove client associations from an organization.

Remove one or more client associations from an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/delete-organization-clients

delete_organization_connection(id, connection_id, config \\ %Config{})

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

Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.

see

https://auth0.com/docs/api/management/v2/organizations/delete-enabled-connections-by-connection-id

delete_organization_discovery_domain(id, discovery_domain_id, config \\ %Config{})

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

Delete an organization discovery domain.

Remove a discovery domain from an organization. This action cannot be undone.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/delete-discovery-domains-by-discovery-domain-id

delete_organization_invitation(id, invitation_id, config \\ %Config{})

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

Delete an invitation to an Organization

see

https://auth0.com/docs/api/management/v2/organizations/delete-invitations-by-invitation-id

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

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

Delete members from an organization

see

https://auth0.com/docs/api/management/v2/organizations/delete-members

delete_organization_roles(id, user_id, params \\ %{}, config \\ %Config{})

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

Remove one or more Organization-specific roles from a given user.

see

https://auth0.com/docs/api/management/v2/organizations/delete-organization-member-roles

delete_rate_limit_policy(id, config \\ %Config{})

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

Delete a rate limit policy.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/delete-rate-limit-policies-by-id

delete_refresh_token(id, config \\ %Config{})

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

Delete a refresh token by its ID.

see

https://auth0.com/docs/api/management/v2/refresh-tokens/delete-refresh-token

delete_resource_server(id, config \\ %Config{})

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

Delete an existing API by ID.

see

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

delete_role(id, config \\ %Config{})

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

Delete a specific user role from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.

see

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

delete_rule(id, config \\ %Config{})

This function is deprecated. Auth0 Rules are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Delete a rule.

Deprecated: Auth0 Rules are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/rules). Use delete_action/3 instead.

see

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

delete_rules_config(key, config \\ %Config{})

@spec delete_rules_config(key(), config()) :: {:ok, String.t()} | error()

Delete a rules config variable identified by its key.

see

https://auth0.com/docs/api/management/v2/rules-configs/delete-rules-configs-by-key

delete_self_service_profile(id, config)

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

Deletes a self-service profile by Id.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/delete-self-service-profiles-by-id

delete_session(id, config \\ %Config{})

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

Delete a session by ID.

see

https://auth0.com/docs/api/management/v2/sessions/delete-session

delete_template_for_universal_login(config \\ %Config{})

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

Delete template for New Universal Login Experience

see

https://auth0.com/docs/api/management/v2/branding/delete-universal-login

delete_token_exchange_profile(id, config \\ %Config{})

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

Delete a token exchange profile.

see

https://auth0.com/docs/api/management/v2/token-exchange-profiles/delete-token-exchange-profiles-by-id

delete_user(id, config \\ %Config{})

@spec delete_user(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_user_attribute_profile(id, config \\ %Config{})

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

Delete a user attribute profile.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/delete-user-attribute-profiles-by-id

delete_user_authentication_method(id, authentication_method_id, config)

@spec delete_user_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_user_authentication_methods(id, config)

@spec delete_user_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_user_authenticators(id, config)

@spec delete_user_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_user_multifactor(id, params \\ %{}, config \\ %Config{})

@spec delete_user_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

delete_user_refresh_tokens(id, config \\ %Config{})

@spec delete_user_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_user_sessions(id, config \\ %Config{})

@spec delete_user_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

delete_verifiable_credential(id, config \\ %Config{})

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

Delete a verifiable credential verification template.

see

https://auth0.com/docs/api/management/v2/verifiable-credentials/delete-vc-templates-by-id

deploy_action(id, config \\ %Config{})

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

see

https://auth0.com/docs/api/management/v2/actions/post-deploy-action

get_action(id, config \\ %Config{})

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

Retrieve an action by its ID.

see

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

get_action_execution(id, config \\ %Config{})

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

see

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

get_action_module(id, config \\ %Config{})

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

Get a specific Actions Module by ID.

Retrieve details of a specific Actions Module by its unique identifier.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/actions/get-action-module

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

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

List all actions using an Actions Module.

Lists all actions that are using a specific Actions Module, showing which deployed action versions reference this Actions Module.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

page
per_page

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/actions/get-action-module-actions

get_action_module_version(id, version_id, config \\ %Config{})

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

Get a specific version of an Actions Module.

Retrieve the details of a specific, immutable version of an Actions Module.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/actions/get-action-module-version

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

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

List all versions of an Actions Module.

List all published versions of a specific Actions Module.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

page
per_page

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/actions/get-action-module-versions

get_action_modules(params \\ %{}, config \\ %Config{})

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

List Actions Modules.

Retrieve a paginated list of all Actions Modules with optional filtering and totals.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

page
per_page

see

https://auth0.com/docs/api/management/v2/actions/get-action-modules

get_action_trigger_bindings(trigger_id, params \\ %{}, config \\ %Config{})

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

query parameters

page
per_page

see

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

get_action_triggers(config \\ %Config{})

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

Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.

see

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

get_action_version(action_id, id, config \\ %Config{})

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

Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.

see

https://auth0.com/docs/api/management/v2/actions/get-action-version

get_action_versions(action_id, params \\ %{}, config \\ %Config{})

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

Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.

query parameters

page
per_page

see

https://auth0.com/docs/api/management/v2/actions/get-action-versions

get_actions(params \\ %{}, config \\ %Config{})

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

Retrieve all actions.

query parameters

triggerId
actionName
deployed
page
per_page
installed

see

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

get_active_users_count(config \\ %Config{})

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

Retrieve the number of active users that logged in during the last 30 days.

The response body is returned as the raw string (for example {:ok, "123"}), it is not decoded to an integer.

see

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

get_agent(id, config \\ %Config{})

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

Get an agent.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

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

get_agents(params \\ %{}, config \\ %Config{})

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

Get agents.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

from
take

see

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

get_attack_protection_bot_detection(config \\ %Config{})

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

Get the Bot Detection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-bot-detection

get_attack_protection_breached_password_detection(config \\ %Config{})

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

Retrieve details of the Breached Password Detection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-breached-password-detection

get_attack_protection_brute_force_protection(config \\ %Config{})

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

Retrieve details of the Brute-force Protection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-brute-force-protection

get_attack_protection_captcha(config \\ %Config{})

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

Get the CAPTCHA configuration for a tenant.

Get the CAPTCHA configuration for your client.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-captcha

get_attack_protection_phone_provider_protection(config \\ %Config{})

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

Get Phone Provider Protection settings.

Get the phone provider protection configuration for a tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-phone-provider-protection

get_attack_protection_suspicious_ip_throttling(config \\ %Config{})

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

Retrieve details of the Suspicious IP Throttling configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-suspicious-ip-throttling

get_blacklisted_tokens(params \\ %{}, config \\ %Config{})

This function is deprecated. The blacklists endpoints were removed from the Auth0 Management API..

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

Retrieve the jti and aud of all tokens that are blacklisted.

see

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

get_branding(config \\ %Config{})

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

Retrieve branding settings.

see

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

get_branding_phone_provider(id, config)

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

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

see

https://auth0.com/docs/api/management/v2/branding/get-phone-provider

get_branding_phone_template(id, config)

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

Get a phone notification template

see

https://auth0.com/docs/api/management/v2/branding/get-phone-template

get_branding_theme(theme_id, config \\ %Config{})

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

Retrieve branding theme.

see

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

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

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

Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified.

query parameters

fields
include_fields

see

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

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

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

Get enabled connections for a client.

Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.

query parameters

strategy (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated strategy= keys)
from
take
fields
include_fields

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/clients/get-client-connections

get_client_grant(id, config \\ %Config{})

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

Get client grant.

Retrieve a single client grant, including the scopes associated with the application/API pair.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/client-grants/get-client-grant

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

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

Get the organizations associated to a client grant.

query parameters

page
per_page
include_totals
from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/client-grants/get-client-grant-organizations

get_client_grants(params \\ %{}, config \\ %Config{})

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

Retrieve a list of client grants, including the scopes associated with the application/API pair.

query parameters

per_page
page
include_totals
from
take
audience
client_id
allow_any_organization
subject_type
default_for

see

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

get_clients(params \\ %{}, config \\ %Config{})

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

Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.

query parameters

fields
include_fields
page
per_page
include_totals
from
take
is_global
is_first_party
app_type
external_client_id
q

see

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

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

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

Retrieve details for a specified connection along with options that can be used for identity provider configuration.

query parameters

fields
include_fields

deprecated parameters

enabled_clients is deprecated (Auth0 specification: x-release-lifecycle: deprecated); manage the enabled clients with get_connection_clients/3 and update_connection_clients/3 instead.
Some options / strategies are deprecated in the Auth0 specification: the Facebook options allow_context_profile_field, manage_notifications, publish_actions, read_mailbox, read_stream, user_groups, user_managed_groups, user_status (removed Facebook permissions, no replacement); the sms strategy options forward_req_info, from, gateway_authentication, gateway_url, messaging_service_sid, provider, syntax, template, twilio_sid, twilio_token; the SAML options.cert (.der certificate); and the ip, instagram, oauth1, office365 (creation), sharepoint, soundcloud and untappd strategies.

see

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

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

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

Get enabled clients for a connection.

Retrieve all clients that have the specified connection enabled.

query parameters

take
from

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/get-connection-clients

get_connection_directory_provisioning(id, config \\ %Config{})

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

Get a directory provisioning configuration.

Retrieve the directory provisioning configuration of a connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/get-directory-provisioning

get_connection_directory_provisioning_default_mapping(id, config \\ %Config{})

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

Get a connection's default directory provisioning attribute mapping.

Retrieve the directory provisioning default attribute mapping of a connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/get-directory-provisioning-default-mapping

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

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

Get synchronized groups for a directory provisioning configuration.

Retrieve the configured synchronized groups for a connection directory provisioning configuration.

query parameters

from
take
q

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/get-synchronized-groups

get_connection_keys(id, config \\ %Config{})

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

Get connection keys.

Gets the connection keys for the Okta or OIDC connection strategy.

Path parameters are percent-encoded before they are placed in the request path.

see

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

get_connection_profile(id, config \\ %Config{})

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

Retrieve a connection profile by its ID.

see

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

get_connection_profile_template(id, config \\ %Config{})

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

Get Connection Profile Template.

Retrieve a Connection Profile Template.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connection-profiles/get-connection-profile-template

get_connection_profile_templates(config \\ %Config{})

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

Get Connection Profile Templates.

Retrieve a list of Connection Profile Templates.

see

https://auth0.com/docs/api/management/v2/connection-profiles/get-connection-profile-templates

get_connection_profiles(params \\ %{}, config \\ %Config{})

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

Retrieve a list of connection profiles.

query parameters

from
take

see

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

get_connection_scim_configuration(id, config)

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

Retrieves a scim configuration by its connectionId.

see

https://auth0.com/docs/api/management/v2/connections/get-scim-configuration

get_connection_scim_configuration_default_mapping(id, config)

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

Retrieves a scim configuration's default mapping by its connectionId.

see

https://auth0.com/docs/api/management/v2/connections/get-default-mapping

get_connection_scim_configuration_tokens(id, config)

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

Retrieves all scim tokens by its connection id.

see

https://auth0.com/docs/api/management/v2/connections/get-scim-tokens

get_connection_status(id, config \\ %Config{})

@spec get_connection_status(id(), config()) :: {:ok, true} | error()

Returns {:ok, true} when Auth0 answers 200 (the connection is online). Any other answer is returned as an error tuple, e.g. {:error, 404, body}.

see

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

get_connections(params \\ %{}, config \\ %Config{})

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

query parameters

per_page
page
include_totals
from
take
strategy (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated strategy= keys)
name
fields
include_fields

deprecated parameters

Some options / strategies are deprecated in the Auth0 specification: the Facebook options allow_context_profile_field, manage_notifications, publish_actions, read_mailbox, read_stream, user_groups, user_managed_groups, user_status (removed Facebook permissions, no replacement); the sms strategy options forward_req_info, from, gateway_authentication, gateway_url, messaging_service_sid, provider, syntax, template, twilio_sid, twilio_token; the SAML options.cert (.der certificate); and the ip, instagram, oauth1, office365 (creation), sharepoint, soundcloud and untappd strategies.

see

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

get_connections_directory_provisionings(params \\ %{}, config \\ %Config{})

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

Get a list of directory provisioning configurations.

Retrieve a list of directory provisioning configurations of a tenant.

query parameters

from
take

see

https://auth0.com/docs/api/management/v2/connections-directory-provisionings/get-connections-directory-provisionings

get_connections_scim_configurations(params \\ %{}, config \\ %Config{})

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

Get a list of SCIM configurations.

Retrieve a list of SCIM configurations of a tenant.

query parameters

from
take

see

https://auth0.com/docs/api/management/v2/connections-scim-configurations/get-connections-scim-configurations

get_credential(client_id, credential_id, config \\ %Config{})

@spec get_credential(client_id(), credential_id(), config()) :: {:ok, map()} | error()

Get the details of a client credential.

see

https://auth0.com/docs/api/management/v2/clients/get-credentials-by-credential-id

get_custom_domain_configuration(id, config \\ %Config{})

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

Get custom domain configuration.

see

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

get_custom_domain_configurations(config_or_params \\ %Config{})

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

Retrieve details on custom domains.

query parameters

take
from
q
fields
include_fields
sort

Query parameters can be passed as a map: get_custom_domain_configurations(params) or get_custom_domain_configurations(params, config).

see

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

get_custom_domain_configurations(params, config)

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

get_custom_signing_keys(config \\ %Config{})

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

Get custom signing keys.

Get entire jwks representation of custom signing keys.

see

https://auth0.com/docs/api/management/v2/keys/get-custom-signing-keys

get_daily_stats(config_or_params \\ %Config{})

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

Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range.

query parameters

from
to

Query parameters can be passed as a map: get_daily_stats(params) or get_daily_stats(params, config).

see

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

get_daily_stats(params, config)

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

get_default_branding_theme(config \\ %Config{})

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

Retrieve default branding theme.

see

https://auth0.com/docs/api/management/v2/branding/get-default-branding-theme

get_default_custom_domain(config \\ %Config{})

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

Get the default domain.

Retrieve the tenant's default domain.

see

https://auth0.com/docs/api/management/v2/custom-domains/get-default

get_device_credentials(params \\ %{}, config \\ %Config{})

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

Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.

query parameters

page
per_page
include_totals
fields
include_fields
user_id
client_id
type

see

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

get_email_provider(params \\ %{}, config \\ %Config{})

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

Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.

query parameters

fields
include_fields

see

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

get_email_template(template_name, config \\ %Config{})

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

see

https://auth0.com/docs/api/management/v2/email-templates/get-email-templates-by-template-name

get_encryption_key(kid, config)

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

Retrieve details of the encryption key with the given ID.

see

https://auth0.com/docs/api/management/v2/keys/get-encryption-key

get_encryption_keys(params, config)

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

Retrieve details of all the encryption keys associated with your tenant.

query parameters

page
per_page
include_totals

see

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

get_event_stream(id, config \\ %Config{})

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

Retrieve an event stream by its ID.

see

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

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

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

Get this event stream's delivery history.

query parameters

statuses
event_types
date_from
date_to
from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/event-streams/get-event-deliveries

get_event_stream_delivery(id, event_id, config \\ %Config{})

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

Get a specific event's delivery history.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/event-streams/get-deliveries-by-event-id

get_event_streams(params \\ %{}, config \\ %Config{})

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

Retrieve all event streams.

query parameters

from
take

see

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

get_flow(id, params, config)

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

Get a flow.

query parameters

hydrate (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated hydrate= keys)

see

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

get_flow_execution(flow_id, execution_id, params \\ %{}, config \\ %Config{})

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

Get a flow execution.

query parameters

hydrate (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated hydrate= keys)

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/flows/get-flows-executions-by-execution-id

get_flow_executions(flow_id, params \\ %{}, config \\ %Config{})

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

Get flow executions.

query parameters

page
per_page
include_totals
from
take

Path parameters are percent-encoded before they are placed in the request path.

see

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

get_flows(params, config)

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

Get flows.

query parameters

page
per_page
include_totals
hydrate (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated hydrate= keys)
synchronous

see

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

get_flows_vault_connection(id, config \\ %Config{})

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

Get a Flows Vault connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/flows/get-flows-vault-connections-by-id

get_flows_vault_connections(params \\ %{}, config \\ %Config{})

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

Get Flows Vault connection list.

query parameters

page
per_page
include_totals

see

https://auth0.com/docs/api/management/v2/flows/get-flows-vault-connections

get_form(id, params, config)

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

Get a form.

query parameters

hydrate (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated hydrate= keys)

see

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

get_forms(params, config)

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

Get forms.

query parameters

page
per_page
include_totals
hydrate (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated hydrate= keys)

see

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

get_grants(params \\ %{}, config \\ %Config{})

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

Retrieve the grants associated with your account.

query parameters

per_page
page
include_totals
user_id
client_id
audience

see

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

get_group(id, config \\ %Config{})

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

Get a Group.

Retrieve a group by its ID.

Path parameters are percent-encoded before they are placed in the request path.

see

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

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

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

Get Group Members.

List all users that are a member of this group.

query parameters

fields
include_fields
from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/groups/get-group-members

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

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

Get a group's roles.

Lists the roles assigned to a group.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/groups/get-group-roles

get_groups(params \\ %{}, config \\ %Config{})

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

Get all Groups.

List all groups in your tenant.

query parameters

connection_id
name
external_id
search
fields
include_fields
page
per_page
include_totals
from
take

see

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

get_guardian_apns_configuration(config)

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

Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant.

see

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

get_guardian_aws_sns_configuration(config \\ %Config{})

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

Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA.

see

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

get_guardian_duo_settings(config \\ %Config{})

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

Get DUO Configuration.

Retrieves the DUO account and factor configuration.

see

https://auth0.com/docs/api/management/v2/guardian/get-factor-duo-settings

get_guardian_email_settings(config \\ %Config{})

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

Get Email Factor Settings.

TODO: Link this endpoint to relevant documentation when available.

see

https://auth0.com/docs/api/management/v2/guardian/get-email-factor-settings

get_guardian_enrollment(id, config \\ %Config{})

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

Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.

see

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

get_guardian_factors(config \\ %Config{})

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

Retrieve details of all multi-factor authentication factors associated with your tenant.

see

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

get_guardian_notification_provider(config)

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

Retrieve the push notification provider configured for your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/get-pn-providers

get_guardian_phone_configuration(config \\ %Config{})

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

Retrieve details of the multi-factor authentication phone provider configured for your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/get-guardian-phone-providers

get_guardian_phone_factor(config \\ %Config{})

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

Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/get-message-types

get_guardian_phone_settings(config \\ %Config{})

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

Get Phone Factor Settings.

TODO: Link this endpoint to relevant documentation when available.

see

https://auth0.com/docs/api/management/v2/guardian/get-phone-factor-settings

get_guardian_phone_template(config \\ %Config{})

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

Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/get-factor-phone-templates

get_guardian_settings(config \\ %Config{})

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

Get Guardian Settings.

TODO: Link this endpoint to relevant documentation when available.

see

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

get_guardian_twilio_phone_configuration(config \\ %Config{})

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

Retrieve configuration details for a Twilio phone provider that has been set up in your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/get-phone-twilio-factor-provider

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

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Retrieve a hook by its ID. Accepts a list of fields to include in the result.

Deprecated: Auth0 Hooks are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/hooks). Use get_action/2 instead.

query parameters

fields

see

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

get_hook_secrets(id, config \\ %Config{})

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Retrieve a hook's secrets by the ID of the hook.

see

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

get_hooks(params \\ %{}, config \\ %Config{})

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Retrieve all hooks. Accepts a list of fields to include or exclude in the result.

Deprecated: Auth0 Hooks are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/hooks). Use get_actions/2 instead.

query parameters

page
per_page
include_totals
enabled
fields
triggerId

see

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

get_job(id, config \\ %Config{})

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

Retrieves a job. Useful to check its status.

see

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

get_job_error(id, config \\ %Config{})

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

Retrieve error details of a failed job.

see

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

get_log_event(id, config \\ %Config{})

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

Retrieve an individual log event.

see

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

get_log_events(params \\ %{}, config \\ %Config{})

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

Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).

query parameters

page
per_page
sort
fields
include_fields
include_totals (deprecated: Auth0 has deprecated this field for GET /api/v2/logs (Log Search Engine v3); do not rely on it)
from
take
search

see

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

get_log_stream(id, config \\ %Config{})

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

Retrieve a log stream configuration and status.

see

https://auth0.com/docs/api/management/v2#!/Log_Streams/get_log_streams_by_id

get_log_streams(config \\ %Config{})

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

Retrieve details on log streams.

see

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

get_network_acl(id, config \\ %Config{})

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

Retrieve a network ACL by its ID.

see

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

get_network_acl_key(id, config \\ %Config{})

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

Get a Network ACL Key.

Retrieve a specific key used to verify HTTP Message Signatures on Network ACL rules.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/keys/get-keys-network-acls

get_network_acl_keys(config \\ %Config{})

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

Get all Network ACL keys.

Retrieve all keys used to verify HTTP Message Signatures on Network ACL rules, ordered by creation time descending.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/keys/get-all-keys-network-acls

get_network_acls(params \\ %{}, config \\ %Config{})

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

Retrieve a list of network ACLs.

query parameters

page
per_page
include_totals

see

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

get_organization(id, config \\ %Config{})

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

Retrieve details about a single Organization specified by ID.

see

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

get_organization_associated_connection(id, connection_id, config \\ %Config{})

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

Get a specific connection associated with an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-connection

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

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

Get connections associated with an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

page
per_page
include_totals
is_enabled

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-connections

get_organization_by_name(name, config \\ %Config{})

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

Retrieve details about a single Organization specified by name.

see

https://auth0.com/docs/api/management/v2/organizations/get-name-by-name

get_organization_client(id, client_id, config \\ %Config{})

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

Get an organization client association.

Get a specific client association for an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-client

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

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

Get client grants associated to an organization.

query parameters

audience
client_id
grant_ids (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated grant_ids= keys)
page
per_page
include_totals

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-client-grants

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

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

List organization client associations.

List all clients associated with an organization, using checkpoint pagination. Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-clients

get_organization_connection(id, connection_id, config \\ %Config{})

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

see

https://auth0.com/docs/api/management/v2/organizations/get-enabled-connections-by-connection-id

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

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

query parameters

page
per_page
include_totals

see

https://auth0.com/docs/api/management/v2/organizations/get-enabled-connections

get_organization_discovery_domain(id, discovery_domain_id, config \\ %Config{})

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

Retrieve an organization discovery domain by ID.

Retrieve details about a single organization discovery domain specified by ID. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-discovery-domains-by-discovery-domain-id

get_organization_discovery_domain_by_name(id, discovery_domain, config \\ %Config{})

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

Retrieve an organization discovery domain by domain name.

Retrieve details about a single organization discovery domain specified by domain name. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-name-by-discovery-domain

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

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

Retrieve all organization discovery domains.

Retrieve list of all organization discovery domains associated with the specified organization. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-discovery-domains

get_organization_group_roles(organization_id, group_id, params \\ %{}, config \\ %Config{})

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

List the roles assigned to a group in the context of an organization.

Lists the roles assigned to the specified group in the context of an organization.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-group-roles

get_organization_groups(organization_id, params \\ %{}, config \\ %Config{})

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

List the groups that are assigned to the organization.

Lists the groups that are assigned to the specified organization.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-groups

get_organization_invitation(id, invitation_id, params \\ %{}, config \\ %Config{})

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

Get a specific invitation to an Organization

query parameters

fields
include_fields

see

https://auth0.com/docs/api/management/v2/organizations/get-invitations-by-invitation-id

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

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

query parameters

page
per_page
include_totals
fields
include_fields
sort

see

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

get_organization_member_effective_role_group_sources(id, user_id, params \\ %{}, config \\ %Config{})

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

List organization member role group sources.

Lists the groups which grant the org member a given role.

query parameters

from
take
role_id

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-member-role-source-groups

get_organization_member_effective_roles(id, user_id, params \\ %{}, config \\ %Config{})

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

List organization member effective roles.

Lists the roles assigned to an organization member directly or through group membership.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-member-effective-roles

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

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

List organization members.

query parameters

page
per_page
include_totals
from
take
fields
include_fields

see

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

get_organization_role_groups(organization_id, role_id, params \\ %{}, config \\ %Config{})

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

List the groups assigned to a role in the context of an organization.

Retrieve the list of groups assigned to a role in the context of an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-role-groups

get_organization_role_members(id, role_id, params \\ %{}, config \\ %Config{})

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

List the members assigned to a role in the context of an organization.

List the organization members assigned a specific role within the context of an organization. Note: Returns only members with direct role assignments. For groups assigned to this role within the organization, use GET /api/v2/organizations/{organization_id}/roles/{role_id}/groups.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

from
take
fields
include_fields

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-role-members

get_organization_roles(id, user_id, params \\ %{}, config \\ %Config{})

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

Retrieve detailed list of roles assigned to a given user within the context of a specific Organization.

query parameters

page
per_page
include_totals

see

https://auth0.com/docs/api/management/v2/organizations/get-organization-member-roles

get_organizations(params \\ %{}, config \\ %Config{})

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

Retrive detailed list of all Organizations available in your tenant.

query parameters

page
per_page
include_totals
from
take
sort
include_client_association_for (Early Access)

see

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

get_prompt_custom_text(prompt, language, config \\ %Config{})

@spec get_prompt_custom_text(prompt(), language(), config()) :: {:ok, map()} | error()

Retrieve custom text for a specific prompt and language.

see

https://auth0.com/docs/api/management/v2/prompts/get-custom-text-by-language

get_prompt_partials(prompt, config \\ %Config{})

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

Get template partials for a prompt

see

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

get_prompt_rendering(prompt, screen, config \\ %Config{})

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

Get the render settings (rendering configuration) of a single screen.

see

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

get_prompt_renderings(params \\ %{}, config \\ %Config{})

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

Get render setting configurations for all screens.

query parameters

fields
include_fields
page
per_page
include_totals
prompt
screen
rendering_mode

see

https://auth0.com/docs/api/management/v2/prompts/get-all-rendering

get_prompt_setting(config \\ %Config{})

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

Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

see

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

get_rate_limit_policies(params \\ %{}, config \\ %Config{})

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

Get rate limit policies.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

resource
consumer
consumer_selector
take
from

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/get-rate-limit-policies

get_rate_limit_policy(id, config \\ %Config{})

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

Get a rate limit policy.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/get-rate-limit-policies-by-id

get_refresh_token(id, config \\ %Config{})

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

Retrieve refresh token information.

see

https://auth0.com/docs/api/management/v2/refresh-tokens/get-refresh-token

get_refresh_tokens(params \\ %{}, config \\ %Config{})

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

Get refresh tokens.

Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

user_id
client_id
from
take
fields
include_fields

see

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

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

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

Retrieve API details with the given ID.

query parameters

include_fields

see

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

get_resource_servers(params \\ %{}, config \\ %Config{})

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

Retrieve details of all APIs associated with your tenant.

query parameters

identifiers (array: pass a list such as ["a", "b"] to send multiple values; it is sent as repeated identifiers= keys)
page
per_page
include_totals
include_fields

see

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

get_risk_assessment(id, config \\ %Config{})

This function is deprecated. GET /api/v2/risk-assessments/{id} does not exist in the Auth0 Management API. Use get_risk_assessments_settings/1..

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

Retrieve a risk assessment by its ID.

Deprecated: The endpoint is not part of the Auth0 Management API v2 specification any more (GET /api/v2/risk-assessments/{id}). Use get_risk_assessments_settings/1 / get_risk_assessments_new_device_settings/1 instead.

see

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

get_risk_assessments_new_device_settings(config \\ %Config{})

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

Get new device assessor.

Gets the risk assessment settings for the new device assessor

see

https://auth0.com/docs/api/management/v2/risk-assessments/get-new-device

get_risk_assessments_settings(config \\ %Config{})

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

Get risk assessment settings.

Gets the tenant settings for risk assessments

see

https://auth0.com/docs/api/management/v2/risk-assessments/get-risk-assessments-settings

get_role(id, config \\ %Config{})

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

Retrieve details about a specific user role specified by ID.

see

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

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

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

Get a role's groups.

Lists the groups to which the specified role is assigned.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/roles/get-role-groups

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

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

Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.

query parameters

per_page
page
include_totals

see

https://auth0.com/docs/api/management/v2/roles/get-role-permission

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

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

Retrieve list of users associated with a specific role.

query parameters

per_page
page
include_totals
from
take

see

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

get_roles(params \\ %{}, config \\ %Config{})

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

Retrieve detailed list of user roles created in your tenant.

query parameters

per_page
page
include_totals
name_filter
type (Early Access)
owner_id (Early Access)
from (Early Access)
take (Early Access)

see

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

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

This function is deprecated. Auth0 Rules are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Retrieve rule details. Accepts a list of fields to include or exclude in the result.

Deprecated: Auth0 Rules are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/rules). Use get_action/2 instead.

query parameters

fields
include_fields

see

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

get_rules(params \\ %{}, config \\ %Config{})

This function is deprecated. Auth0 Rules are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.

Deprecated: Auth0 Rules are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/rules). Use get_actions/2 instead.

query parameters

page
per_page
include_totals
enabled
fields
include_fields

see

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

get_rules_configs(config \\ %Config{})

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

Retrieve rules config variable keys.

see

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

get_self_service_profile(id, config)

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

Retrieves a self-service profile by Id.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/get-self-service-profiles-by-id

get_self_service_profile_custom_text(id, language, page, config \\ %Config{})

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

Get custom text for a self-service profile.

Retrieves text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/get-self-service-profile-custom-text

get_self_service_profiles(params, config)

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

Retrieves self-service profiles. Currently only one profile can be created per tenant.

query parameters

page
per_page
include_totals

see

https://auth0.com/docs/api/management/v2/self-service-profiles/get-self-service-profiles

get_session(id, config \\ %Config{})

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

Retrieve session information.

see

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

get_signing_key(kid, config \\ %Config{})

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

Retrieve details of the application signing key with the given ID.

see

https://auth0.com/docs/api/management/v2/keys/get-signing-key

get_signing_keys(config \\ %Config{})

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

Retrieve details of all the application signing keys associated with your tenant.

see

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

get_supplemental_signal(id, config \\ %Config{})

This function is deprecated. GET /api/v2/supplemental-signals/{id} does not exist in the Auth0 Management API. Use get_supplemental_signals/1..

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

Retrieve a supplemental signal by its ID.

Deprecated: The endpoint is not part of the Auth0 Management API v2 specification any more (GET /api/v2/supplemental-signals/{id}). Use get_supplemental_signals/1 instead.

see

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

get_supplemental_signals(config \\ %Config{})

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

Get the supplemental signals configuration for a tenant.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

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

get_template_for_universal_login(config \\ %Config{})

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

Get template for New Universal Login Experience

see

https://auth0.com/docs/api/management/v2/branding/get-universal-login

get_tenant_setting(params \\ %{}, config \\ %Config{})

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

Retrieve tenant settings. A list of fields to include or exclude may also be specified.

query parameters

fields
include_fields

see

https://auth0.com/docs/api/management/v2/tenants/tenant-settings-route

get_token_exchange_profile(id, config \\ %Config{})

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

Retrieve a token exchange profile by its ID.

see

https://auth0.com/docs/api/management/v2/token-exchange-profiles/get-token-exchange-profiles-by-id

get_token_exchange_profiles(params \\ %{}, config \\ %Config{})

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

Retrieve a list of token exchange profiles.

query parameters

from
take

see

https://auth0.com/docs/api/management/v2/token-exchange-profiles/get-token-exchange-profiles

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

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

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

query parameters

fields
include_fields

see

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

get_user_attribute_profile(id, config \\ %Config{})

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

Retrieve a user attribute profile by its ID.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/get-user-attribute-profiles-by-id

get_user_attribute_profile_template(id, config \\ %Config{})

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

Get User Attribute Profile Template.

Retrieve a User Attribute Profile Template.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/get-user-attribute-profile-template

get_user_attribute_profile_templates(config \\ %Config{})

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

Get User Attribute Profile Templates.

Retrieve a list of User Attribute Profile Templates.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/get-user-attribute-profile-templates

get_user_attribute_profiles(params \\ %{}, config \\ %Config{})

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

Retrieve a list of user attribute profiles.

query parameters

from
take

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/get-user-attribute-profiles

get_user_authentication_method(id, authentication_method_id, config)

@spec get_user_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_user_block(params \\ %{}, config \\ %Config{})

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

Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).

query parameters

identifier (required)
consider_brute_force_enablement

see

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

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

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

Retrieve details of all Brute-force Protection blocks for the user with the given ID.

query parameters

consider_brute_force_enablement

see

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

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

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

Get a User's Connected Accounts.

Retrieve all connected accounts associated with the user.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

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

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

@spec get_user_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.

query parameters

from
take
resource_server_identifier
permission_name

Path parameters are percent-encoded before they are placed in the request path.

see

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

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

@spec get_user_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.

query parameters

from
take
resource_server_identifier

Path parameters are percent-encoded before they are placed in the request path.

see

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

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

@spec get_user_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.

query parameters

role_id
from
take

Path parameters are percent-encoded before they are placed in the request path.

see

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

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

@spec get_user_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.

query parameters

from
take

Path parameters are percent-encoded before they are placed in the request path.

see

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

get_user_enrollments(id, config \\ %Config{})

@spec get_user_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_user_groups(id, params \\ %{}, config \\ %Config{})

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

Get user's groups.

List all groups to which this user belongs.

query parameters

fields
include_fields
page
per_page
include_totals
from
take

Path parameters are percent-encoded before they are placed in the request path.

see

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

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

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

Retrieve log events for a specific user.

query parameters

page
per_page
sort
include_totals

see

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

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

@spec get_user_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.

query parameters

page
per_page
include_totals
from
take

see

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

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

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

Retrieve all permissions associated with the user.

query parameters

per_page
page
include_totals

see

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

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

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

Retrieve details for a user's refresh tokens.

query parameters

include_totals
from
take

see

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

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

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

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

query parameters

per_page
page
include_totals

see

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

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

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

Retrieve details for a user's sessions.

query parameters

include_totals
from
take

see

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

get_users(params \\ %{}, config \\ %Config{})

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

Retrieve details of users.

query parameters

page
per_page
include_totals
sort
connection
fields
include_fields
q
search_engine
primary_order

see

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

get_users_by_email(params \\ %{}, config \\ %Config{})

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

Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.

query parameters

fields
include_fields
email (required)

see

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

get_verifiable_credential(id, config \\ %Config{})

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

Retrieve a verifiable credential verification template by its ID.

see

https://auth0.com/docs/api/management/v2/verifiable-credentials/get-vc-templates-by-id

get_verifiable_credentials(params \\ %{}, config \\ %Config{})

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

Retrieve the verifiable credential verification templates (GET /api/v2/verifiable-credentials/verification/templates).

see

https://auth0.com/docs/api/management/v2/verifiable-credentials/get-vc-templates

import_encryption_key(kid, params, config)

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

Import wrapped key material and activate encryption key.

see

https://auth0.com/docs/api/management/v2/keys/post-encryption-key

invalidate_user_remembered_browser_for_multifactor(id, config \\ %Config{})

@spec invalidate_user_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_user_identities(id, params \\ %{}, config \\ %Config{})

@spec link_user_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_branding_phone_providers(params, config)

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

Retrieve a list ofphone providers details set for a Tenant. A list of fields to include or exclude may also be specified.

query parameters

disabled

see

https://auth0.com/docs/api/management/v2/branding/get-branding-phone-providers

list_branding_phone_templates(params, config)

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

Get a list of phone notification templates

query parameters

disabled

see

https://auth0.com/docs/api/management/v2/branding/get-phone-templates

list_credentials(client_id, config \\ %Config{})

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

Get the details of a client credential.

see

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

list_guardian_policies(config \\ %Config{})

@spec list_guardian_policies(config()) :: {:ok, list()} | error()

Retrieve the multi-factor authentication (MFA) policies configured for your tenant.

see

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

list_user_authentication_methods(id, params, config)

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

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

query parameters

page
per_page
include_totals

see

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

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

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

Update the details of a specific Organization, such as name and display name, branding options, and metadata.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

is_app_entitlement_active (Early Access)
token_quota (Early Access)

see

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

modify_organization_connection(id, connection_id, params \\ %{}, config \\ %Config{})

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

Modify the details of a specific connection currently enabled for an Organization.

see

https://auth0.com/docs/api/management/v2/organizations/patch-enabled-connections-by-connection-id

patch_email_template(template_name, params \\ %{}, config \\ %Config{})

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

Modify an email template.

see

https://auth0.com/docs/api/management/v2/email-templates/patch-email-templates-by-template-name

patch_guardian_apns_configuration(params, config)

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

Modify configuration details of the multi-factor authentication APNS provider associated with your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/patch-apns

patch_guardian_aws_sns_configuration(params \\ %{}, config \\ %Config{})

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

Configure the AWS SNS push notification provider configuration (subscription required).

see

https://auth0.com/docs/api/management/v2/guardian/patch-sns

patch_guardian_duo_settings(params \\ %{}, config \\ %Config{})

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

Update the DUO Configuration.

see

https://auth0.com/docs/api/management/v2/guardian/patch-factor-duo-settings

patch_guardian_fcm_configuration(params, config)

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

Modify configuration details of the multi-factor authentication FCM provider associated with your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/patch-fcm

patch_guardian_fcmv1_configuration(params, config)

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

Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/patch-fcmv-1

preview_client_cimd_metadata(params \\ %{}, config \\ %Config{})

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

Preview and validate Client ID Metadata Document.

Fetches and validates a Client ID Metadata Document without creating a client. Returns the raw metadata and how it would be mapped to Auth0 client fields. This endpoint is useful for testing metadata URIs before creating CIMD clients.

see

https://auth0.com/docs/api/management/v2/clients/post-clients-cimd-preview

redeliver_event_stream_event(id, event_id, config \\ %Config{})

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

Redeliver a single failed event by ID.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/event-streams/post-redeliver-by-event-id

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

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

Redeliver failed events.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/event-streams/post-redeliver

regenerate_user_recovery_code(id, config \\ %Config{})

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

see

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

register_cimd_client(params \\ %{}, config \\ %Config{})

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

Idempotent registration for Client ID Metadata Document (CIMD) clients. Uses external_client_id as the unique identifier for upsert operations.

see

https://auth0.com/docs/api/management/v2/clients/post-clients-cimd-register

rekey_encryption_key(config)

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

Perform rekeying operation on the key hierarchy.

see

https://auth0.com/docs/api/management/v2/keys/post-encryption-rekey

remove_blocked_ip(ip, config \\ %Config{})

@spec remove_blocked_ip(ip(), config()) :: {:ok, String.t()} | error()

Remove a block imposed by Suspicious IP Throttling for the given IP address.

see

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

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

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

Remove roles from a group.

Unassign one or more roles from a specified group.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/groups/delete-group-roles

remove_organization_group_roles(organization_id, group_id, params \\ %{}, config \\ %Config{})

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

Remove roles assigned to a group in an organization context.

Unassign one or more roles from a specified group in the context of an organization.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/delete-organization-group-roles

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

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

Remove groups from a role.

Unassign one or more groups from a specified role.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/roles/delete-role-groups

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

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

Remove one or more permissions from a specified user role.

see

https://auth0.com/docs/api/management/v2/roles/delete-role-permission-assignment

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

@spec remove_user_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_user_roles(id, params \\ %{}, config \\ %Config{})

@spec remove_user_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

reset_branding_phone_template(id, params, config)

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

Resets a phone notification template values

see

https://auth0.com/docs/api/management/v2/branding/reset-phone-template

revoke_refresh_tokens(params \\ %{}, config \\ %Config{})

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

Revoke refresh tokens.

Revoke refresh tokens in bulk by ID list, user, user+client, or user+client+audience.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/refresh-tokens/revoke-refresh-tokens

revoke_self_service_profile_sso_ticket(profile_id, id, config \\ %Config{})

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

Revoke a Self-Service Enterprise Configuration access ticket.

Revokes a Self-Service Enterprise Configuration access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service Enterprise Configuration session. If any users have already started a session through this ticket, their session will be terminated. Clients should expect a 202 Accepted response upon successful processing, indicating that the request has been acknowledged and that the revocation is underway but may not be fully completed at the ...

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/post-revoke

revoke_session(id, config \\ %Config{})

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

Revokes a session by ID and all associated refresh tokens.

see

https://auth0.com/docs/api/management/v2/sessions/revoke-session

revoke_signing_key(kid, config \\ %Config{})

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

Revoke the application signing key with the given ID.

see

https://auth0.com/docs/api/management/v2/keys/put-signing-keys

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

@spec revoke_user_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

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

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

Rollback an Actions Module to a previous version.

Rolls back an Actions Module's draft to a previously created version. This action copies the code, dependencies, and secrets from the specified version into the current draft.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/actions/post-action-module-rollback

rollback_action_version(action_id, id, params \\ %{}, config \\ %Config{})

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

see

https://auth0.com/docs/api/management/v2/actions/post-deploy-draft-version

rotate_client_secret(id, config \\ %Config{})

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

Rotate a client secret.

see

https://auth0.com/docs/api/management/v2/clients/post-rotate-secret

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

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

Rotate connection keys.

Rotates the connection keys for the Okta or OIDC connection strategies.

Path parameters are percent-encoded before they are placed in the request path.

see

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

rotate_signing_key(config \\ %Config{})

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

Rotate the application signing key of your tenant.

see

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

search_organizations(params \\ %{}, config \\ %Config{})

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

Search organizations.

Retrieve details of organizations matching a search criteria. It is possible to:

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

q
parser
take
from
sort

see

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

search_resource_servers(params \\ %{}, config \\ %Config{})

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

Search resource servers.

Search resource servers using SCIM or Lucene filter syntax with low-latency, eventually consistent results. Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene"). This endpoint provides an alternative to the standard GET /resource-servers endpoint with better performance for complex queries. Results may not reflect recent updates immediately.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

query parameters

q
parser
fields
include_fields
take
from
sort

see

https://auth0.com/docs/api/management/v2/resource-servers/get-resource-servers-search

send_job_verification_email(params \\ %{}, config \\ %Config{}, opts \\ [])

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

Send an email to the specified user that asks them to click a link to verify their email address.

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

https://auth0.com/docs/api/management/v2/jobs/post-verification-email

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

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

Create or replace synchronized group selections for a directory provisioning configuration.

Create or replace the selected groups for a connection directory provisioning configuration.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/put-synchronized-groups

set_custom_signing_keys(params \\ %{}, config \\ %Config{})

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

Create or replace custom signing keys.

Create or replace entire jwks representation of custom signing keys.

see

https://auth0.com/docs/api/management/v2/keys/put-custom-signing-keys

set_default_custom_domain(params \\ %{}, config \\ %Config{})

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

Update the default custom domain for the tenant.

Set the default custom domain for the tenant.

see

https://auth0.com/docs/api/management/v2/custom-domains/patch-default

set_guardian_policies(params \\ %{}, config \\ %Config{})

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

Set multi-factor authentication (MFA) policies for your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-policies

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

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

Update Access Control List.

Update existing access control list for your client.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/network-acls/put-network-acls-by-id

set_prompt_custom_text(prompt, language, params \\ %{}, config \\ %Config{})

@spec set_prompt_custom_text(prompt(), language(), value_params(), config()) ::
  {:ok, String.t()} | error()

Set custom text for a specific prompt. Existing texts will be overwritten.

see

https://auth0.com/docs/api/management/v2/prompts/put-custom-text-by-language

set_prompt_partials(prompt, params \\ %{}, config \\ %Config{})

@spec set_prompt_partials(prompt(), value_params(), config()) ::
  {:ok, String.t()} | error()

Set template partials for a prompt

see

https://auth0.com/docs/api/management/v2/prompts/put-partials

set_rules_config(key, params \\ %{}, config \\ %Config{})

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

Sets a rules config variable.

see

https://auth0.com/docs/api/management/v2/rules-configs/put-rules-configs-by-key

set_self_service_profile_custom_text(id, language, page, params \\ %{}, config \\ %Config{})

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

Set custom text for a self-service profile.

Updates text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/put-self-service-profile-custom-text

set_template_for_universal_login(params \\ %{}, config \\ %Config{})

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

Update the Universal Login branding template.

see

https://auth0.com/docs/api/management/v2/branding/put-universal-login

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

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

Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.

see

https://auth0.com/docs/api/management/v2/actions/post-test-action

test_branding_phone_provider(id, params, config)

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

Send a test phone notification for the configured provider

see

https://auth0.com/docs/api/management/v2/branding/try-phone-provider

test_branding_phone_template(id, params, config, opts \\ [])

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

Send a test phone notification for the configured template

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

https://auth0.com/docs/api/management/v2/branding/try-phone-template

test_custom_domain(id, config \\ %Config{})

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

Test a custom domain.

Run the test process on a custom domain.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/custom-domains/post-test-domain

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

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

Send a test event to an event stream.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/event-streams/post-test-event

unblock_user_block(params \\ %{}, config \\ %Config{})

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

Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).

query parameters

identifier (required)

see

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

unblock_user_block_by_user_id(id, config \\ %Config{})

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

Remove all Brute-force Protection blocks for the user with the given ID.

see

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

unlink_user_identities(id, provider, user_id, config \\ %Config{})

@spec unlink_user_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_action(id, params \\ %{}, config \\ %Config{})

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

Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.

see

https://auth0.com/docs/api/management/v2/actions/patch-action

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

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

Update a specific Actions Module.

Update properties of an existing Actions Module, such as code, dependencies, or secrets.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/actions/patch-action-module

update_action_trigger_bindings(trigger_id, params \\ %{}, config \\ %Config{})

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

see

https://auth0.com/docs/api/management/v2/actions/patch-bindings

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

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

Update an agent.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/agents/patch-agent

update_attack_protection_bot_detection(params \\ %{}, config \\ %Config{})

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

Update the Bot Detection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-bot-detection

update_attack_protection_breached_password_detection(params \\ %{}, config \\ %Config{})

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

Update details of the Breached Password Detection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-breached-password-detection

update_attack_protection_brute_force_protection(params \\ %{}, config \\ %Config{})

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

Update the Brute-force Protection configuration of your tenant.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

form_submission_mode (beta)

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-brute-force-protection

update_attack_protection_captcha(params \\ %{}, config \\ %Config{})

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

Partial Update for CAPTCHA Configuration.

Update existing CAPTCHA configuration for your client.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-captcha

update_attack_protection_phone_provider_protection(params \\ %{}, config \\ %Config{})

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

Update Phone Provider Protection settings.

Update the phone provider protection configuration for a tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-phone-provider-protection

update_attack_protection_suspicious_ip_throttling(params \\ %{}, config \\ %Config{})

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

Update the details of the Suspicious IP Throttling configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-suspicious-ip-throttling

update_branding(params \\ %{}, config \\ %Config{})

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

Update branding settings.

see

https://auth0.com/docs/api/management/v2/branding/patch-branding

update_branding_phone_provider(id, params, config)

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

Update an phone provider.

see

https://auth0.com/docs/api/management/v2/branding/update-phone-provider

update_branding_phone_template(id, params, config)

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

Update a phone notification template

see

https://auth0.com/docs/api/management/v2/branding/update-phone-template

update_branding_theme(theme_id, params \\ %{}, config \\ %Config{})

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

Update branding theme.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

identifiers (Early Access)

see

https://auth0.com/docs/api/management/v2/branding/patch-branding-theme

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

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

Updates a client's settings

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

anonymous_sessions (Early Access)
b2b_integration_configuration (Early Access)
fedcm_login (Early Access)
identity_assertion_authorization_grant (Early Access)
my_organization_configuration (Early Access)
organization_discovery_methods (Early Access)
token_quota (Early Access)
token_vault_privileged_access (Early Access)

deprecated parameters

The body property oidc_backchannel_logout is deprecated (Auth0 specification: x-release-lifecycle: deprecated); use oidc_logout instead.

see

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

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

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

Update a client grant.

see

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

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

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

Update details for a specific connection, including option properties for identity provider configuration.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

cross_app_access_requesting_app (Early Access)
cross_app_access_resource_app (Early Access)
enabled_clients (deprecated)

deprecated parameters

enabled_clients is deprecated (Auth0 specification: x-release-lifecycle: deprecated); manage the enabled clients with get_connection_clients/3 and update_connection_clients/3 instead.
Some options / strategies are deprecated in the Auth0 specification: the Facebook options allow_context_profile_field, manage_notifications, publish_actions, read_mailbox, read_stream, user_groups, user_managed_groups, user_status (removed Facebook permissions, no replacement); the sms strategy options forward_req_info, from, gateway_authentication, gateway_url, messaging_service_sid, provider, syntax, template, twilio_sid, twilio_token; the SAML options.cert (.der certificate); and the ip, instagram, oauth1, office365 (creation), sharepoint, soundcloud and untappd strategies.

see

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

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

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

Update enabled clients for a connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/patch-clients

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

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

Patch a directory provisioning configuration.

Update the directory provisioning configuration of a connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/connections/patch-directory-provisioning

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

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

Update a connection profile.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

cross_app_access_resource_app (Early Access)

see

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

update_connection_scim_configuration(id, params, config)

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

Update a scim configuration by its connectionId.

see

https://auth0.com/docs/api/management/v2/connections/patch-scim-configuration

update_credential(client_id, credential_id, params, config \\ %Config{})

@spec update_credential(client_id(), credential_id(), map(), config()) ::
  {:ok, map()} | error()

Change a client credential you previously created. May be enabled or disabled.

see

https://auth0.com/docs/api/management/v2/clients/patch-credentials-by-credential-id

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

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

Update a custom domain.

see

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

update_email_provider(params \\ %{}, config \\ %Config{})

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

Update an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property):

see

https://auth0.com/docs/api/management/v2/emails/patch-provider

update_email_template(template_name, params \\ %{}, config \\ %Config{})

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

Update an email template.

see

https://auth0.com/docs/api/management/v2/email-templates/put-email-templates-by-template-name

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

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

Update an event stream.

see

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

update_flow(id, params, config)

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

Update a flow.

see

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

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

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

Update a Flows Vault connection.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/flows/patch-flows-vault-connections-by-id

update_form(id, params, config)

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

Update a form.

see

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

update_guardian_apns_configuration(params, config)

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

Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-apns

update_guardian_aws_sns_configuration(params \\ %{}, config \\ %Config{})

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

Configure the AWS SNS push notification provider configuration (subscription required).

see

https://auth0.com/docs/api/management/v2/guardian/put-sns

update_guardian_duo_settings(params \\ %{}, config \\ %Config{})

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

Set the DUO Configuration.

Set the DUO account configuration and other properties specific to this factor.

see

https://auth0.com/docs/api/management/v2/guardian/put-factor-duo-settings

update_guardian_email_settings(params \\ %{}, config \\ %Config{})

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

Set the Email Factor Settings.

TODO: Link this endpoint to relevant documentation when available.

see

https://auth0.com/docs/api/management/v2/guardian/set-email-factor-settings

update_guardian_factor(name, params \\ %{}, config \\ %Config{})

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

Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.

see

https://auth0.com/docs/api/management/v2/guardian/put-factors-by-name

update_guardian_fcm_configuration(params, config)

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

Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-fcm

update_guardian_fcmv1_configuration(params, config)

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

Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-fcmv-1

update_guardian_notification_provider(params, config)

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

Modify the push notification provider configured for your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-pn-providers

update_guardian_phone_configuration(params \\ %{}, config \\ %Config{})

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

Update phone provider configuration

see

https://auth0.com/docs/api/management/v2/guardian/put-phone-providers

update_guardian_phone_factor(params \\ %{}, config \\ %Config{})

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

Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-message-types

update_guardian_phone_settings(params \\ %{}, config \\ %Config{})

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

Set the Phone Factor Settings.

TODO: Link this endpoint to relevant documentation when available.

see

https://auth0.com/docs/api/management/v2/guardian/set-phone-factor-settings

update_guardian_phone_template(params \\ %{}, config \\ %Config{})

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

Customize the messages sent to complete phone enrollment and verification (subscription required).

see

https://auth0.com/docs/api/management/v2/guardian/put-factor-phone-templates

update_guardian_settings(params \\ %{}, config \\ %Config{})

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

Set the Guardian Settings.

Update a tenant's guardian settings such as Remember Me

see

https://auth0.com/docs/api/management/v2/guardian/set-guardian-settings

update_guardian_twilio_phone_configuration(params \\ %{}, config \\ %Config{})

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

Update the configuration of a Twilio phone provider that has been set up in your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-twilio

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

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Update an existing hook.

Deprecated: Auth0 Hooks are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/hooks). Use update_action/3 instead.

see

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

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

This function is deprecated. Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions..

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

Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.

see

https://auth0.com/docs/api/management/v2/hooks/patch-secrets

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

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

Update a log stream.

see

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

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

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

Update a network ACL.

see

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

update_organization_associated_connection(id, connection_id, params \\ %{}, config \\ %Config{})

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

Update a connection for an organization.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/patch-organization-connection

update_organization_client(id, client_id, params \\ %{}, config \\ %Config{})

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

Update an organization client association.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/patch-organization-client

update_organization_discovery_domain(id, discovery_domain_id, params \\ %{}, config \\ %Config{})

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

Update an organization discovery domain.

Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The status field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/organizations/patch-discovery-domains-by-discovery-domain-id

update_prompt_rendering(prompt, screen, params \\ %{}, config \\ %Config{})

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

Update the render settings (rendering configuration) of a single screen.

see

https://auth0.com/docs/api/management/v2/prompts/patch-rendering

update_prompt_setting(params \\ %{}, config \\ %Config{})

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

Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

see

https://auth0.com/docs/api/management/v2/prompts/patch-prompts

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

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

Update a rate limit policy.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

Path parameters are percent-encoded before they are placed in the request path.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/patch-rate-limit-policies-by-id

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

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

Update a refresh token.

Update a refresh token by its ID.

Path parameters are percent-encoded before they are placed in the request path.

see

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

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

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

Change an existing API setting by resource server ID.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

access_token (Early Access)
authorization_policy (Early Access)
require_consent_non_repudiation (Early Access)
token_lifetime_for_anonymous_access_tokens (Early Access)

see

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

update_risk_assessments_new_device_settings(params \\ %{}, config \\ %Config{})

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

Update new device assessor.

Updates the risk assessment settings for the new device assessor

see

https://auth0.com/docs/api/management/v2/risk-assessments/patch-new-device

update_risk_assessments_settings(params \\ %{}, config \\ %Config{})

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

Update risk assessment settings.

Updates the tenant settings for risk assessments

see

https://auth0.com/docs/api/management/v2/risk-assessments/patch-risk-assessments-settings

update_role(id, params \\ %{}, config \\ %Config{})

@spec update_role(id(), map(), config()) :: {:ok, map()} | error()

Modify the details of a specific user role specified by ID.

see

https://auth0.com/docs/api/management/v2/roles/patch-roles-by-id

update_rule(id, params \\ %{}, config \\ %Config{})

This function is deprecated. Auth0 Rules are deprecated (end of life announced by Auth0). Migrate to Actions..

@spec update_rule(id(), map(), config()) :: {:ok, map()} | error()

Update an existing rule.

Deprecated: Auth0 Rules are deprecated: Auth0 has announced the end of life of Rules and Hooks; migrate to Actions (https://auth0.com/docs/customize/rules). Use update_action/3 instead.

see

https://auth0.com/docs/api/management/v2/rules/patch-rules-by-id

update_self_service_profile(id, params, config)

@spec update_self_service_profile(id(), map(), config()) :: {:ok, map()} | error()

Updates a self-service profile.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

user_attribute_profile_id (Early Access)

see

https://auth0.com/docs/api/management/v2/self-service-profiles/patch-self-service-profiles-by-id

update_session(id, params \\ %{}, config \\ %Config{})

@spec update_session(id(), map(), config()) :: {:ok, map()} | error()

Update session information.

see

https://auth0.com/docs/api/management/v2/sessions/patch-sessions-by-id

update_supplemental_signals(params \\ %{}, config \\ %Config{})

@spec update_supplemental_signals(map(), config()) :: {:ok, map()} | error()

Update the supplemental signals configuration for a tenant.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/supplemental-signals/patch-supplemental-signals

update_tenant_setting(params \\ %{}, config \\ %Config{})

@spec update_tenant_setting(map(), config()) :: {:ok, map()} | error()

Update settings for a tenant.

body properties to note

The request body is sent as given. These properties have a non-GA lifecycle in the Auth0 specification:

access_token (Early Access)
client_id_metadata_document_supported (Early Access)
default_token_quota (Early Access)
include_session_metadata_in_tenant_logs (Early Access)

see

https://auth0.com/docs/api/management/v2/tenants/patch-settings

update_token_exchange_profile(id, params \\ %{}, config \\ %Config{})

@spec update_token_exchange_profile(id(), map(), config()) ::
  {:ok, map() | String.t()} | error()

Update a token exchange profile.

see

https://auth0.com/docs/api/management/v2/token-exchange-profiles/patch-token-exchange-profiles-by-id

update_user(id, params \\ %{}, config \\ %Config{}, opts \\ [])

@spec update_user(id(), map(), config(), request_opts()) :: {:ok, map()} | error()

Update a user.

options

:custom_domain - sent as the auth0-custom-domain header so that Auth0 uses this custom domain (host name, optionally with a port) for links it generates. An invalid value raises ArgumentError.

see

https://auth0.com/docs/api/management/v2/users/patch-users-by-id

update_user_attribute_profile(id, params \\ %{}, config \\ %Config{})

@spec update_user_attribute_profile(id(), map(), config()) :: {:ok, map()} | error()

Update a user attribute profile.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/patch-user-attribute-profiles-by-id

update_user_authentication_method(id, authentication_method_id, params, config)

@spec update_user_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_user_authentication_methods(id, params, config)

@spec update_user_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

update_verifiable_credential(id, params \\ %{}, config \\ %Config{})

@spec update_verifiable_credential(id(), map(), config()) :: {:ok, map()} | error()

Update a verifiable credential verification template.

see

https://auth0.com/docs/api/management/v2/verifiable-credentials/patch-vc-templates-by-id

verify_custom_domain(id, config \\ %Config{})

@spec verify_custom_domain(id(), config()) :: {:ok, map()} | error()

Run the verification process on a custom domain.

see

https://auth0.com/docs/api/management/v2/custom-domains/post-verify