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

Documentation for Auth0 Simple Management API.

Link to this section Summary

Functions

Add connections to an organization.

Add members to an organization.

Assign users to a role.

Assign Permissions to a User.

Assign roles to a user.

Associate permissions with a role.

Blacklist a token.

Check if an IP address is blocked.

Configure a new custom domain.

Configure the email provider.

Create an action.

Create branding theme.

Create a connection.

Create a device public key credential.

Create an email template.

Create an email verification ticket.

Create a multi-factor authentication enrollment ticket.

Create export users job.

Create import users job.

Create a log stream.

Create an Organization.

Create invitations to organization.

Create a password change ticket.

Create a resource server.

Delete a client.

Delete client grant.

Delete a connection.

Delete custom domain configuration.

Delete a device credential.

Delete the email provider.

Delete a grant.

Delete a multi-factor authentication enrollment.

Delete a hook.

Delete log stream.

Delete organization.

Delete connections from an organization.

Delete an invitation to organization.

Delete members from an organization.

Delete members from an organization.

Delete a resource server.

Delete a role.

Delete a rule.

Delete rules config for a given key.

Delete template for New Universal Login Experience.

Delete a User.

Delete a User's Multi-factor Provider.

Deploy an action.

Get an action.

Get actions service status.

Get a specific version of an action.

Get active users count.

Get breached password detection settings.

Get the brute force configuration.

Get the suspicious IP throttling configuration.

Get blacklisted tokens.

Get branding settings.

Check connection status.

Get all connections.

Get custom domain configuration.

Get custom domains configurations.

Get daily stats.

Retrieve default branding theme.

Retrieve device credentials.

Get the email provider.

Retrieve AWS SNS push notification configuration.

Retrieve a multi-factor authentication enrollment.

Retrieve Factors and their Status.

Retrieve phone configuration (one of auth0|twilio|phone-message-hook).

Retrieve the Enabled Phone Factors.

Retrieve Enrollment and Verification Phone Templates.

Retrieve SMS configuration (one of auth0|twilio|phone-message-hook).

Retrieve SMS Enrollment and Verification Templates.

Retrieve Twilio phone configuration.

Retrieve Twilio SMS configuration.

Get hook secrets.

Get a job.

Get job error details.

Get a log event by id.

Search log events.

Get log stream by ID.

Get log streams.

Get organization.

Get organization by name.

Get an enabled connection for an organization.

Get connections enabled for an organization.

Get invitations to organization.

Get members who belong to an organization.

Get the roles assigned to an organization member.

Get custom text for a prompt.

Get prompts settings.

Get resource servers.

Get a role.

Get permissions granted by role.

Retrieve config variable keys for rules (get_rules-configs).

Get an Application Signing Key by its key id.

Get all Application Signing Keys.

Get template for New Universal Login Experience.

Get tenant settings.

Get blocks by identifier.

Get the First Confirmed Multi-factor Authentication Enrollment.

Get user's log events.

List user's organizations.

Get a User's Permissions.

List or Search Users.

Search Users by Email.

Invalidate All Remembered Browsers for Multi-factor Authentication.

Get the Multi-factor Authentication policies.

Modify an Organization.

Update SNS configuration for push notifications.

Generate New Multi-factor Authentication Recovery Code.

Remove the blocked IP address.

Remove permissions from a role.

Remove Permissions from a User.

Removes roles from a user.

Revoke an Application Signing Key by its key id.

Roll back to a previous action version.

Rotate a client secret.

Rotate the Application Signing Key.

Send an email address verification email.

Set the Multi-factor Authentication policies.

Set custom text for a specific prompt.

Set rules config for a given key.

Set template for New Universal Login Experience.

Unblock by identifier.

Update breached password detection settings.

Update the suspicious IP throttling configuration.

Update branding settings.

Update custom domain configuration.

Update the email provider.

Update AWS SNS push notification configuration.

Update a Multi-factor Authentication Factor.

Update phone configuration (one of auth0|twilio|phone-message-hook).

Update the Enabled Phone Factors.

Update Enrollment and Verification Phone Templates.

Update SMS configuration (one of auth0|twilio|phone-message-hook).

Update SMS Enrollment and Verification Templates.

Update prompts settings.

Update a resource server.

Update tenant settings.

Verify a custom domain.

Link to this section Types

Specs

action_id() :: String.t()

Specs

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

Specs

connection_id() :: String.t()

Specs

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

Specs

id() :: String.t()

Specs

invitation_id() :: String.t()

Specs

ip() :: String.t()

Specs

key() :: String.t()

Specs

kid() :: String.t()

Specs

language() :: String.t()

Specs

name() :: String.t()

Specs

prompt() :: String.t()

Specs

provider() :: String.t()

Specs

response_body() :: String.t()

Specs

template_name() :: String.t()

Specs

theme_id() :: String.t()

Specs

trigger_id() :: String.t()

Specs

user_id() :: String.t()

Link to this section Functions

Link to this function

add_hook_secrets(id, params, config)

View Source

Specs

add_hook_secrets(id(), map(), config()) :: {:ok, map()} | error()

Add hook secrets.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/post_secrets

Link to this function

add_organization_connection(id, params, config)

View Source

Specs

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

Add connections to an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_enabled_connections

Link to this function

add_organization_members(id, params, config)

View Source

Specs

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

Add members to an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_members

Link to this function

assign_organization_roles(id, user_id, params, config)

View Source

Specs

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

Add members to an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_members

Link to this function

assign_role_users(id, params, config)

View Source

Specs

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

Assign users to a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/post_role_users

Link to this function

assign_user_permissions(id, params, config)

View Source

Specs

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

Link to this function

assign_user_roles(id, params, config)

View Source

Specs

assign_user_roles(id(), map(), config()) :: {:ok, String.t()} | error()

Assign roles to a user.

see

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

Link to this function

associate_role_permissions(id, params, config)

View Source

Specs

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

Associate permissions with a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/post_role_permission_assignment

Link to this function

blacklist_token(params, config)

View Source

Specs

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

Blacklist a token.

see

https://auth0.com/docs/api/management/v2/#!/Blacklists/post_tokens

Link to this function

check_ip_blocked(ip, config)

View Source

Specs

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

Check if an IP address is blocked.

see

https://auth0.com/docs/api/management/v2/#!/Anomaly/get_ips_by_id

Link to this function

configure_custom_domain(params, config)

View Source

Specs

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

Configure a new custom domain.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/post_custom_domains

Link to this function

configure_email_provider(params, config)

View Source

Specs

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

Configure the email provider.

see

https://auth0.com/docs/api/management/v2/#!/Emails/post_provider

Link to this function

create_action(params, config)

View Source

Specs

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

Create an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/post_action

Link to this function

create_branding_theme(params, config)

View Source

Specs

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

Create branding theme.

see

https://auth0.com/docs/api/management/v2#!/Branding/post_branding_theme

Link to this function

create_client(params, config)

View Source

Specs

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

Create a client.

see

https://auth0.com/docs/api/management/v2/#!/Clients/post_clients

Link to this function

create_client_grant(params, config)

View Source

Specs

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

Create client grant.

see

https://auth0.com/docs/api/management/v2/#!/Client_Grants/post_client_grants

Link to this function

create_connection(params, config)

View Source

Specs

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

Create a connection.

see

https://auth0.com/docs/api/management/v2/#!/Connections/post_connections

Link to this function

create_device_credential(params, config)

View Source

Specs

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

Create a device public key credential.

see

https://auth0.com/docs/api/management/v2/#!/Device_Credentials/post_device_credentials

Link to this function

create_email_template(params, config)

View Source

Specs

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

Link to this function

create_email_verification_ticket(params, config)

View Source

Specs

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

Create an email verification ticket.

see

https://auth0.com/docs/api/management/v2/#!/Tickets/post_email_verification

Link to this function

create_guardian_enrollment_ticket(params, config)

View Source

Specs

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

Create a multi-factor authentication enrollment ticket.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/post_ticket

Link to this function

create_hook(params, config)

View Source

Specs

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

Create a hook.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/post_hooks

Link to this function

create_job_users_exports(params, config)

View Source

Specs

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

Create export users job.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/post_users_exports

Link to this function

create_job_users_imports(params, config)

View Source

Specs

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

Create import users job.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/post_users_imports

Link to this function

create_log_stream(params, config)

View Source

Specs

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

Link to this function

create_organization(params, config)

View Source

Specs

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

Create an Organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_organizations

Link to this function

create_organization_invitation(id, params, config)

View Source

Specs

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

Create invitations to organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_invitations

Link to this function

create_password_change_ticket(params, config)

View Source

Specs

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

Create a password change ticket.

see

https://auth0.com/docs/api/management/v2/#!/Tickets/post_password_change

Link to this function

create_resource_server(params, config)

View Source

Specs

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

Create a resource server.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/post_resource_servers

Link to this function

create_role(params, config)

View Source

Specs

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

Create a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/post_roles

Link to this function

create_rule(params, config)

View Source

Specs

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

Create a rule.

see

https://auth0.com/docs/api/management/v2/#!/Rules/post_rules

Link to this function

create_user(params, config)

View Source

Specs

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

Create a User.

see

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

Link to this function

delete_action(id, params, config)

View Source

Specs

delete_action(id(), map(), config()) :: {:ok, String.t()} | error()

Delete an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/delete_action

Link to this function

delete_branding_theme(theme_id, config)

View Source

Specs

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

Link to this function

delete_client(id, config)

View Source

Specs

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

Delete a client.

see

https://auth0.com/docs/api/management/v2/#!/Clients/delete_clients_by_id

Link to this function

delete_client_grant(id, config)

View Source

Specs

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

Delete client grant.

see

https://auth0.com/docs/api/management/v2/#!/Client_Grants/delete_client_grants_by_id

Link to this function

delete_connection(id, config)

View Source

Specs

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

Delete a connection.

see

https://auth0.com/docs/api/management/v2/#!/Connections/delete_connections_by_id

Link to this function

delete_connection_users(id, params, config)

View Source

Specs

delete_connection_users(id(), map(), config()) :: {:ok, String.t()} | error()

Delete a connection user.

see

https://auth0.com/docs/api/management/v2/#!/Connections/delete_users_by_email

Link to this function

delete_custom_domain_configuration(id, config)

View Source

Specs

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

Delete custom domain configuration.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/delete_custom_domains_by_id

Link to this function

delete_device_credential(id, config)

View Source

Specs

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

Delete a device credential.

see

https://auth0.com/docs/api/management/v2/#!/Device_Credentials/delete_device_credentials_by_id

Link to this function

delete_email_provider(config)

View Source

Specs

delete_email_provider(config()) :: {:ok, String.t()} | error()

Delete the email provider.

see

https://auth0.com/docs/api/management/v2/#!/Emails/delete_provider

Link to this function

delete_grant(id, config)

View Source

Specs

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

Delete a grant.

see

https://auth0.com/docs/api/management/v2/#!/Grants/delete_grants_by_id

Link to this function

delete_guardian_enrollment(id, config)

View Source

Specs

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

Delete a multi-factor authentication enrollment.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/delete_enrollments_by_id

Specs

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

Delete a hook.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/delete_hooks_by_id

Link to this function

delete_hook_secrets(id, params, config)

View Source

Specs

delete_hook_secrets(id(), map(), config()) :: {:ok, String.t()} | error()

Delete hook secrets.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/delete_secrets

Link to this function

delete_log_stream(id, config)

View Source

Specs

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

Delete log stream.

see

https://auth0.com/docs/api/management/v2/#!/Log_Streams/delete_log_streams_by_id

Link to this function

delete_organization(id, config)

View Source

Specs

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

Delete organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_organizations_by_id

Link to this function

delete_organization_connection(id, connection_id, config)

View Source

Specs

delete_organization_connection(id(), connection_id(), config()) ::
  {:ok, String.t()} | error()

Delete connections from an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_enabled_connections_by_connectionId

Link to this function

delete_organization_invitation(id, invitation_id, config)

View Source

Specs

delete_organization_invitation(id(), invitation_id(), config()) ::
  {:ok, String.t()} | error()

Delete an invitation to organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_invitations_by_invitation_id

Link to this function

delete_organization_members(id, params, config)

View Source

Specs

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

Link to this function

delete_organization_roles(id, user_id, params, config)

View Source

Specs

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

Delete members from an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_members

Link to this function

delete_resource_server(id, config)

View Source

Specs

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

Delete a resource server.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/delete_resource_servers_by_id

Specs

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

Delete a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/delete_roles_by_id

Specs

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

Delete a rule.

see

https://auth0.com/docs/api/management/v2/#!/Rules/delete_rules_by_id

Link to this function

delete_rules_config(key, config)

View Source

Specs

delete_rules_config(key(), config()) :: {:ok, String.t()} | error()

Delete rules config for a given key.

see

https://auth0.com/docs/api/management/v2/#!/Rules_Configs/delete_rules_configs_by_key

Link to this function

delete_template_for_universal_login(config)

View Source

Specs

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

Specs

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

Delete a User.

see

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

Link to this function

delete_user_multifactor(id, params, config)

View Source

Specs

delete_user_multifactor(id(), map(), config()) :: {:ok, String.t()} | error()

Delete a User's Multi-factor Provider.

see

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

Link to this function

deploy_action(id, config)

View Source

Specs

deploy_action(id(), config()) :: {:ok, map()} | error()

Deploy an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/post_deploy_action

Specs

get_action(id(), config()) :: {:ok, map()} | error()

Get an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_action

Link to this function

get_action_execution(id, config)

View Source

Specs

get_action_execution(id(), config()) :: {:ok, map()} | error()

Get an execution.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_execution

Link to this function

get_action_status(config)

View Source

Specs

get_action_status(config()) :: {:ok, map()} | error()

Get actions service status.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_service_status

Link to this function

get_action_trigger_bindings(trigger_id, params, config)

View Source

Specs

get_action_trigger_bindings(trigger_id(), map(), config()) ::
  {:ok, map()} | error()

Get triggers.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_triggers

Link to this function

get_action_version(action_id, id, config)

View Source

Specs

get_action_version(action_id(), id(), config()) :: {:ok, map()} | error()

Get a specific version of an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_action_version

Link to this function

get_action_versions(action_id, params, config)

View Source

Specs

get_action_versions(action_id(), map(), config()) :: {:ok, map()} | error()

Get an action's versions.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_action_versions

Link to this function

get_actions(params, config)

View Source

Specs

get_actions(map(), config()) :: {:ok, map()} | error()

Get actions.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_actions

Link to this function

get_active_users_count(config)

View Source

Specs

get_active_users_count(config()) :: {:ok, integer()} | error()

Get active users count.

see

https://auth0.com/docs/api/management/v2/#!/Stats/get_active_users

Link to this function

get_attack_protection_breached_password_detection(config)

View Source

Specs

get_attack_protection_breached_password_detection(config()) ::
  {:ok, map()} | error()

Get breached password detection settings.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/get_breached_password_detection

Link to this function

get_attack_protection_brute_force_protection(config)

View Source

Specs

get_attack_protection_brute_force_protection(config()) :: {:ok, map()} | error()

Get the brute force configuration.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/get_brute_force_protection

Link to this function

get_attack_protection_suspicious_ip_throttling(config)

View Source

Specs

get_attack_protection_suspicious_ip_throttling(config()) ::
  {:ok, map()} | error()

Get the suspicious IP throttling configuration.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/get_suspicious_ip_throttling

Link to this function

get_blacklisted_tokens(params, config)

View Source

Specs

get_blacklisted_tokens(map(), config()) :: {:ok, map()} | error()

Get blacklisted tokens.

see

https://auth0.com/docs/api/management/v2/#!/Blacklists/get_tokens

Specs

get_branding(config()) :: {:ok, map()} | error()

Get branding settings.

see

https://auth0.com/docs/api/management/v2/#!/Branding/get_branding

Link to this function

get_branding_theme(theme_id, config)

View Source

Specs

get_branding_theme(theme_id(), config()) :: {:ok, map()} | error()

Get branding theme.

see

https://auth0.com/docs/api/management/v2#!/Branding/get_branding_theme

Link to this function

get_client(id, params, config)

View Source

Specs

get_client(id(), map(), config()) :: {:ok, map()} | error()

Get a client.

see

https://auth0.com/docs/api/management/v2/#!/Clients/get_clients_by_id

Link to this function

get_client_grants(params, config)

View Source

Specs

get_client_grants(map(), config()) :: {:ok, map()} | error()

Get client grants.

see

https://auth0.com/docs/api/management/v2/#!/Client_Grants/get_client_grants

Link to this function

get_clients(params, config)

View Source

Specs

get_clients(map(), config()) :: {:ok, map()} | error()

Get clients.

see

https://auth0.com/docs/api/management/v2/#!/Clients/get_clients

Link to this function

get_connection(id, params, config)

View Source

Specs

get_connection(id(), map(), config()) :: {:ok, map()} | error()

Get a connection.

see

https://auth0.com/docs/api/management/v2/#!/Connections/get_connections_by_id

Link to this function

get_connection_status(id, config)

View Source

Specs

get_connection_status(id(), config()) :: {:ok, boolean()} | error()

Check connection status.

see

https://auth0.com/docs/api/management/v2/#!/Connections/get_status

Link to this function

get_connections(params, config)

View Source

Specs

get_connections(map(), config()) :: {:ok, map()} | error()

Get all connections.

see

https://auth0.com/docs/api/management/v2/#!/Connections/get_connections

Link to this function

get_custom_domain_configuration(id, config)

View Source

Specs

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

Link to this function

get_custom_domain_configurations(config)

View Source

Specs

get_custom_domain_configurations(config()) :: {:ok, map()} | error()

Get custom domains configurations.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/get_custom_domains

Specs

get_daily_stats(config()) :: {:ok, map()} | error()

Get daily stats.

see

https://auth0.com/docs/api/management/v2/#!/Stats/get_daily

Link to this function

get_default_branding_theme(config)

View Source

Specs

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

Link to this function

get_device_credentials(params, config)

View Source

Specs

get_device_credentials(map(), config()) :: {:ok, map()} | error()

Retrieve device credentials.

see

https://auth0.com/docs/api/management/v2/#!/Device_Credentials/get_device_credentials

Link to this function

get_email_provider(params, config)

View Source

Specs

get_email_provider(map(), config()) :: {:ok, map()} | error()

Get the email provider.

see

https://auth0.com/docs/api/management/v2/#!/Emails/get_provider

Link to this function

get_email_template(template_name, config)

View Source

Specs

get_email_template(template_name(), config()) :: {:ok, map()} | error()

Get an email template.

see

https://auth0.com/docs/api/management/v2/#!/Email_Templates/get_email_templates_by_templateName

Link to this function

get_grants(params, config)

View Source

Specs

get_grants(map(), config()) :: {:ok, map()} | error()

Get grants.

see

https://auth0.com/docs/api/management/v2/#!/Grants/get_grants

Link to this function

get_guardian_aws_sns_configuration(config)

View Source

Specs

get_guardian_aws_sns_configuration(config()) :: {:ok, map()} | error()

Retrieve AWS SNS push notification configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_sns

Link to this function

get_guardian_enrollment(id, config)

View Source

Specs

get_guardian_enrollment(id(), config()) :: {:ok, map()} | error()

Retrieve a multi-factor authentication enrollment.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_enrollments_by_id

Link to this function

get_guardian_factors(config)

View Source

Specs

get_guardian_factors(config()) :: {:ok, map()} | error()

Retrieve Factors and their Status.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_factors

Link to this function

get_guardian_phone_configuration(config)

View Source

Specs

get_guardian_phone_configuration(config()) :: {:ok, map()} | error()

Retrieve phone configuration (one of auth0|twilio|phone-message-hook).

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_selected_provider

Link to this function

get_guardian_phone_factor(config)

View Source

Specs

get_guardian_phone_factor(config()) :: {:ok, map()} | error()

Retrieve the Enabled Phone Factors.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_message_types

Link to this function

get_guardian_phone_template(config)

View Source

Specs

get_guardian_phone_template(config()) :: {:ok, map()} | error()

Retrieve Enrollment and Verification Phone Templates.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_templates

Link to this function

get_guardian_sms_configuration(config)

View Source

Specs

get_guardian_sms_configuration(config()) :: {:ok, map()} | error()

Retrieve SMS configuration (one of auth0|twilio|phone-message-hook).

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_selected_provider_0

Link to this function

get_guardian_sms_template(config)

View Source

Specs

get_guardian_sms_template(config()) :: {:ok, map()} | error()

Retrieve SMS Enrollment and Verification Templates.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_templates_0

Link to this function

get_guardian_twilio_phone_configuration(config)

View Source

Specs

get_guardian_twilio_phone_configuration(config()) :: {:ok, map()} | error()

Retrieve Twilio phone configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio

Link to this function

get_guardian_twilio_sms_configuration(config)

View Source

Specs

get_guardian_twilio_sms_configuration(config()) :: {:ok, map()} | error()

Retrieve Twilio SMS configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio_0

Link to this function

get_hook(id, params, config)

View Source

Specs

get_hook(id(), map(), config()) :: {:ok, map()} | error()

Get a hook.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/get_hooks_by_id

Link to this function

get_hook_secrets(id, config)

View Source

Specs

get_hook_secrets(id(), config()) :: {:ok, map()} | error()

Get hook secrets.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/get_secrets

Link to this function

get_hooks(params, config)

View Source

Specs

get_hooks(map(), config()) :: {:ok, map()} | error()

Get hooks.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/get_hooks

Specs

get_job(id(), config()) :: {:ok, map()} | error()

Get a job.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/get_jobs_by_id

Link to this function

get_job_error(id, config)

View Source

Specs

get_job_error(id(), config()) :: {:ok, map()} | error()

Get job error details.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/get_errors

Link to this function

get_log_event(id, config)

View Source

Specs

get_log_event(id(), config()) :: {:ok, map()} | error()

Get a log event by id.

see

https://auth0.com/docs/api/management/v2/#!/Logs/get_logs_by_id

Link to this function

get_log_events(params, config)

View Source

Specs

get_log_events(map(), config()) :: {:ok, map()} | error()

Search log events.

see

https://auth0.com/docs/api/management/v2/#!/Logs/get_logs

Link to this function

get_log_stream(id, config)

View Source

Specs

get_log_stream(id(), config()) :: {:ok, map()} | error()

Get log stream by ID.

see

https://auth0.com/docs/api/management/v2/#!/Log_Streams/get_log_streams_by_id

Specs

get_log_streams(config()) ::
  {:ok, Auth0.Entity.LogStreams.t(), response_body()} | error()

Get log streams.

see

https://auth0.com/docs/api/management/v2/#!/Log_Streams/get_log_streams

Link to this function

get_organization(id, config)

View Source

Specs

get_organization(id(), config()) :: {:ok, map()} | error()

Get organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations_by_id

Link to this function

get_organization_by_name(name, config)

View Source

Specs

get_organization_by_name(name(), config()) :: {:ok, map()} | error()

Get organization by name.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_name_by_name

Link to this function

get_organization_connection(id, connection_id, config)

View Source

Specs

get_organization_connection(id(), connection_id(), config()) ::
  {:ok, map()} | error()

Get an enabled connection for an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_enabled_connections_by_connectionId

Link to this function

get_organization_connections(id, params, config)

View Source

Specs

get_organization_connections(id(), map(), config()) :: {:ok, map()} | error()

Get connections enabled for an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_enabled_connections

Link to this function

get_organization_invitation(id, invitation_id, params, config)

View Source

Specs

get_organization_invitation(
  id(),
  invitation_id(),
  map(),
  config()
) :: {:ok, map()} | error()

Get an invitation to organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_invitations_by_invitation_id

Link to this function

get_organization_invitations(id, params, config)

View Source

Specs

get_organization_invitations(id(), map(), config()) :: {:ok, map()} | error()

Get invitations to organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_invitations

Link to this function

get_organization_members(id, params, config)

View Source

Specs

get_organization_members(id(), map(), config()) :: {:ok, map()} | error()

Get members who belong to an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_members

Link to this function

get_organization_roles(id, user_id, params, config)

View Source

Specs

get_organization_roles(id(), user_id(), map(), config()) ::
  {:ok, map()} | error()

Get the roles assigned to an organization member.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_organization_member_roles

Link to this function

get_organizations(params, config)

View Source

Specs

get_organizations(map(), config()) :: {:ok, map()} | error()

Get organizations.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations

Link to this function

get_prompt_custom_text(prompt, language, config)

View Source

Specs

get_prompt_custom_text(prompt(), language(), config()) :: {:ok, map()} | error()

Get custom text for a prompt.

see

https://auth0.com/docs/api/management/v2/#!/Prompts/get_custom_text_by_language

Link to this function

get_prompt_setting(config)

View Source

Specs

get_prompt_setting(config()) :: {:ok, map()} | error()

Get prompts settings.

see

https://auth0.com/docs/api/management/v2/#!/Prompts/get_prompts

Link to this function

get_resource_server(id, params, config)

View Source

Specs

get_resource_server(id(), map(), config()) :: {:ok, map()} | error()

Get a resource server.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers_by_id

Link to this function

get_resource_servers(params, config)

View Source

Specs

get_resource_servers(map(), config()) :: {:ok, map()} | error()

Get resource servers.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers

Specs

get_role(id(), config()) :: {:ok, map()} | error()

Get a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/get_roles_by_id

Link to this function

get_role_permissions(id, params, config)

View Source

Specs

get_role_permissions(id(), map(), config()) :: {:ok, map()} | error()

Get permissions granted by role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/get_role_permission

Link to this function

get_role_users(id, params, config)

View Source

Specs

get_role_users(id(), map(), config()) :: {:ok, map()} | error()

Get a role's users.

see

https://auth0.com/docs/api/management/v2/#!/Roles/get_role_user

Link to this function

get_roles(params, config)

View Source

Specs

get_roles(map(), config()) :: {:ok, map()} | error()

Get roles.

see

https://auth0.com/docs/api/management/v2/#!/Roles/get_roles

Link to this function

get_rule(id, params, config)

View Source

Specs

get_rule(id(), map(), config()) :: {:ok, map()} | error()

Get a rule.

see

https://auth0.com/docs/api/management/v2/#!/Rules/get_rules_by_id

Link to this function

get_rules(params, config)

View Source

Specs

get_rules(map(), config()) :: {:ok, map()} | error()

Get rules.

see

https://auth0.com/docs/api/management/v2/#!/Rules/get_rules

Link to this function

get_rules_configs(config)

View Source

Specs

get_rules_configs(config()) :: {:ok, map()} | error()

Retrieve config variable keys for rules (get_rules-configs).

see

https://auth0.com/docs/api/management/v2/#!/Rules_Configs/get_rules_configs

Link to this function

get_signing_key(kid, config)

View Source

Specs

get_signing_key(kid(), config()) :: {:ok, map()} | error()

Get an Application Signing Key by its key id.

see

https://auth0.com/docs/api/management/v2/#!/Keys/get_signing_key

Link to this function

get_signing_keys(config)

View Source

Specs

get_signing_keys(config()) :: {:ok, map()} | error()

Get all Application Signing Keys.

see

https://auth0.com/docs/api/management/v2/#!/Keys/get_signing_keys

Link to this function

get_template_for_universal_login(config)

View Source

Specs

get_template_for_universal_login(config()) :: {:ok, map()} | error()

Get template for New Universal Login Experience.

see

https://auth0.com/docs/api/management/v2/#!/Branding/get_universal_login

Link to this function

get_tenant_setting(params, config)

View Source

Specs

get_tenant_setting(map(), config()) :: {:ok, map()} | error()

Get tenant settings.

see

https://auth0.com/docs/api/management/v2/#!/Tenants/tenant_settings_route

Link to this function

get_user(id, params, config)

View Source

Specs

get_user(id(), map(), config()) :: {:ok, map()} | error()

Get a User.

see

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

Link to this function

get_user_block(params, config)

View Source

Specs

get_user_block(map(), config()) :: {:ok, map()} | error()

Get blocks by identifier.

see

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

Link to this function

get_user_block_by_user_id(id, params, config)

View Source

Specs

get_user_block_by_user_id(id(), map(), config()) :: {:ok, map()} | error()

Get a user's blocks.

see

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

Link to this function

get_user_enrollments(id, config)

View Source

Specs

get_user_enrollments(id(), config()) :: {:ok, map()} | error()

Get the First Confirmed Multi-factor Authentication Enrollment.

see

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

Link to this function

get_user_logs(id, params, config)

View Source

Specs

get_user_logs(id(), map(), config()) :: {:ok, map()} | error()

Get user's log events.

see

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

Link to this function

get_user_organizations(id, params, config)

View Source

Specs

get_user_organizations(id(), map(), config()) :: {:ok, map()} | error()

List user's organizations.

see

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

Link to this function

get_user_permissions(id, params, config)

View Source

Specs

get_user_permissions(id(), map(), config()) :: {:ok, map()} | error()

Get a User's Permissions.

see

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

Link to this function

get_user_roles(id, params, config)

View Source

Specs

get_user_roles(id(), map(), config()) :: {:ok, map()} | error()

Get a user's roles.

see

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

Link to this function

get_users(params, config)

View Source

Specs

get_users(map(), config()) :: {:ok, map()} | error()

List or Search Users.

see

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

Link to this function

get_users_by_email(params, config)

View Source

Specs

get_users_by_email(map(), config()) :: {:ok, map()} | error()

Search Users by Email.

see

https://auth0.com/docs/api/management/v2/#!/Users_By_Email/get_users_by_email

Link to this function

invalidate_user_remembered_browser_for_multifactor(id, config)

View Source

Specs

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

Invalidate All Remembered Browsers for Multi-factor Authentication.

see

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

Link to this function

list_guardian_policies(config)

View Source

Specs

list_guardian_policies(config()) :: {:ok, [map()]} | error()

Get the Multi-factor Authentication policies.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_policies

Link to this function

modify_organization(id, params, config)

View Source

Specs

modify_organization(id(), map(), config()) :: {:ok, map()} | error()

Modify an Organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/patch_organizations_by_id

Link to this function

modify_organization_connection(id, connection_id, params, config)

View Source

Specs

modify_organization_connection(
  id(),
  connection_id(),
  map(),
  config()
) :: {:ok, map()} | error()

Modify an Organizations Connection.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/patch_enabled_connections_by_connectionId

Link to this function

patch_email_template(template_name, params, config)

View Source

Specs

patch_email_template(template_name(), map(), config()) :: {:ok, map()} | error()

Patch an email template.

see

https://auth0.com/docs/api/management/v2/#!/Email_Templates/patch_email_templates_by_templateName

Link to this function

patch_guardian_aws_sns_configuration(params, config)

View Source

Specs

patch_guardian_aws_sns_configuration(
  map(),
  config()
) :: {:ok, map()} | error()

Update SNS configuration for push notifications.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/patch_sns

Link to this function

regenerate_user_recovery_code(id, config)

View Source

Specs

regenerate_user_recovery_code(id(), config()) :: {:ok, map()} | error()

Generate New Multi-factor Authentication Recovery Code.

see

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

Link to this function

remove_blocked_ip(ip, config)

View Source

Specs

remove_blocked_ip(ip(), config()) :: {:ok, String.t()} | error()

Remove the blocked IP address.

see

https://auth0.com/docs/api/management/v2/#!/Anomaly/delete_ips_by_id

Link to this function

remove_role_permissions(id, params, config)

View Source

Specs

remove_role_permissions(id(), map(), config()) :: {:ok, String.t()} | error()

Remove permissions from a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/delete_role_permission_assignment

Link to this function

remove_user_permissions(id, params, config)

View Source

Specs

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

Link to this function

remove_user_roles(id, params, config)

View Source

Specs

remove_user_roles(id(), map(), config()) :: {:ok, String.t()} | error()

Removes roles from a user.

see

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

Link to this function

revoke_signing_key(kid, config)

View Source

Specs

revoke_signing_key(kid(), config()) :: {:ok, map()} | error()

Revoke an Application Signing Key by its key id.

see

https://auth0.com/docs/api/management/v2/#!/Keys/put_signing_keys

Link to this function

rollback_action_version(action_id, id, params, config)

View Source

Specs

rollback_action_version(action_id(), id(), map(), config()) ::
  {:ok, map()} | error()

Roll back to a previous action version.

see

https://auth0.com/docs/api/management/v2/#!/Actions/post_deploy_draft_version

Link to this function

rotate_client_secret(id, config)

View Source

Specs

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

Rotate a client secret.

see

https://auth0.com/docs/api/management/v2/#!/Clients/post_rotate_secret

Link to this function

rotate_signing_key(config)

View Source

Specs

rotate_signing_key(config()) :: {:ok, map()} | error()

Rotate the Application Signing Key.

see

https://auth0.com/docs/api/management/v2/#!/Keys/post_signing_keys

Link to this function

send_job_verification_email(params, config)

View Source

Specs

send_job_verification_email(map(), config()) :: {:ok, map()} | error()

Send an email address verification email.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/post_verification_email

Link to this function

set_guardian_policies(params, config)

View Source

Specs

set_guardian_policies(map(), config()) :: {:ok, [map()]} | error()

Set the Multi-factor Authentication policies.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_policies

Link to this function

set_prompt_custom_text(prompt, language, params, config)

View Source

Specs

set_prompt_custom_text(prompt(), language(), map(), config()) ::
  {:ok, map()} | error()

Set custom text for a specific prompt.

see

https://auth0.com/docs/api/management/v2/#!/Prompts/put_custom_text_by_language

Link to this function

set_rules_config(key, params, config)

View Source

Specs

set_rules_config(key(), map(), config()) :: {:ok, map()} | error()

Set rules config for a given key.

see

https://auth0.com/docs/api/management/v2/#!/Rules_Configs/put_rules_configs_by_key

Link to this function

set_template_for_universal_login(params, config)

View Source

Specs

set_template_for_universal_login(map(), config()) :: {:ok, String.t()} | error()

Set template for New Universal Login Experience.

see

https://auth0.com/docs/api/management/v2/#!/Branding/put_universal_login

Link to this function

test_action(id, params, config)

View Source

Specs

test_action(id(), map(), config()) :: {:ok, map()} | error()

Test an Action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/post_test_action

Link to this function

unblock_user_block(params, config)

View Source

Specs

unblock_user_block(map(), config()) :: {:ok, String.t()} | error()

Unblock by identifier.

see

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

Link to this function

unblock_user_block_by_user_id(id, config)

View Source

Specs

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

Unblock a user.

see

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

Link to this function

update_action(id, params, config)

View Source

Specs

update_action(id(), map(), config()) :: {:ok, map()} | error()

Update an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/patch_action

Link to this function

update_action_trigger_bindings(trigger_id, params, config)

View Source

Specs

update_action_trigger_bindings(
  trigger_id(),
  map(),
  config()
) :: {:ok, map()} | error()

Update trigger bindings.

see

https://auth0.com/docs/api/management/v2/#!/Actions/patch_bindings

Link to this function

update_attack_protection_breached_password_detection(params, config)

View Source

Specs

update_attack_protection_breached_password_detection(
  map(),
  config()
) :: {:ok, map()} | error()

Update breached password detection settings.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/patch_breached_password_detection

Link to this function

update_attack_protection_brute_force_protection(params, config)

View Source

Specs

update_attack_protection_brute_force_protection(
  map(),
  config()
) :: {:ok, map(), response_body()} | error()

Update the brute force configuration.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/patch_brute_force_protection

Link to this function

update_attack_protection_suspicious_ip_throttling(params, config)

View Source

Specs

update_attack_protection_suspicious_ip_throttling(
  map(),
  config()
) :: {:ok, map()} | error()

Update the suspicious IP throttling configuration.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/patch_suspicious_ip_throttling

Link to this function

update_branding(params, config)

View Source

Specs

update_branding(map(), config()) :: {:ok, map()} | error()

Update branding settings.

see

https://auth0.com/docs/api/management/v2/#!/Branding/patch_branding

Link to this function

update_branding_theme(theme_id, params, config)

View Source

Specs

update_branding_theme(theme_id(), map(), config()) :: {:ok, map()} | error()

Update branding theme.

see

https://auth0.com/docs/api/management/v2#!/Branding/patch_branding_theme

Link to this function

update_client(id, params, config)

View Source

Specs

update_client(id(), map(), config()) :: {:ok, map()} | error()

Update a client.

see

https://auth0.com/docs/api/management/v2/#!/Clients/patch_clients_by_id

Link to this function

update_client_grant(id, params, config)

View Source

Specs

update_client_grant(id(), map(), config()) :: {:ok, map()} | error()

Update client grant.

see

https://auth0.com/docs/api/management/v2/#!/Client_Grants/patch_client_grants_by_id

Link to this function

update_connection(id, params, config)

View Source

Specs

update_connection(id(), map(), config()) :: {:ok, map()} | error()

Update a connection.

see

https://auth0.com/docs/api/management/v2/#!/Connections/patch_connections_by_id

Link to this function

update_custom_domain_configuration(id, params, config)

View Source

Specs

update_custom_domain_configuration(id(), map(), config()) ::
  {:ok, map()} | error()

Update custom domain configuration.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/patch_custom_domains_by_id

Link to this function

update_email_provider(params, config)

View Source

Specs

update_email_provider(map(), config()) :: {:ok, map()} | error()

Update the email provider.

see

https://auth0.com/docs/api/management/v2/#!/Emails/patch_provider

Link to this function

update_email_template(template_name, params, config)

View Source

Specs

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_templateName

Link to this function

update_guardian_aws_sns_configuration(params, config)

View Source

Specs

update_guardian_aws_sns_configuration(
  map(),
  config()
) :: {:ok, map()} | error()

Update AWS SNS push notification configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_sns

Link to this function

update_guardian_factor(name, params, config)

View Source

Specs

update_guardian_factor(name(), map(), config()) :: {:ok, map()} | error()

Update a Multi-factor Authentication Factor.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_factors_by_name

Link to this function

update_guardian_phone_configuration(params, config)

View Source

Specs

update_guardian_phone_configuration(map(), config()) :: {:ok, map()} | error()

Update phone configuration (one of auth0|twilio|phone-message-hook).

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_selected_provider

Link to this function

update_guardian_phone_factor(params, config)

View Source

Specs

update_guardian_phone_factor(map(), config()) :: {:ok, map()} | error()

Update the Enabled Phone Factors.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_message_types

Link to this function

update_guardian_phone_template(params, config)

View Source

Specs

update_guardian_phone_template(map(), config()) :: {:ok, map()} | error()

Update Enrollment and Verification Phone Templates.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_templates

Link to this function

update_guardian_sms_configuration(params, config)

View Source

Specs

update_guardian_sms_configuration(map(), config()) :: {:ok, map()} | error()

Update SMS configuration (one of auth0|twilio|phone-message-hook).

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_selected_provider_0

Link to this function

update_guardian_sms_template(params, config)

View Source

Specs

update_guardian_sms_template(map(), config()) :: {:ok, map()} | error()

Update SMS Enrollment and Verification Templates.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_templates_0

Link to this function

update_guardian_twilio_phone_configuration(params, config)

View Source

Specs

update_guardian_twilio_phone_configuration(
  map(),
  config()
) :: {:ok, map()} | error()

Update Twilio phone configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_twilio

Link to this function

update_guardian_twilio_sms_configuration(params, config)

View Source

Specs

update_guardian_twilio_sms_configuration(
  map(),
  config()
) :: {:ok, map()} | error()

Update Twilio SMS configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_twilio_0

Link to this function

update_hook(id, params, config)

View Source

Specs

update_hook(id(), map(), config()) :: {:ok, map()} | error()

Update a hook.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/patch_hooks_by_id

Link to this function

update_hook_secrets(id, params, config)

View Source

Specs

update_hook_secrets(id(), map(), config()) :: {:ok, map()} | error()

Update hook secrets.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/patch_hooks_by_id

Link to this function

update_log_stream(id, params, config)

View Source

Specs

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

Link to this function

update_prompt_setting(params, config)

View Source

Specs

update_prompt_setting(map(), config()) :: {:ok, map()} | error()

Update prompts settings.

see

https://auth0.com/docs/api/management/v2/#!/Prompts/patch_prompts

Link to this function

update_resource_server(id, params, config)

View Source

Specs

update_resource_server(id(), map(), config()) :: {:ok, map()} | error()

Update a resource server.

see

https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers_by_id

Link to this function

update_role(id, params, config)

View Source

Specs

update_role(id(), map(), config()) :: {:ok, map()} | error()

Update a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/patch_roles_by_id

Link to this function

update_rule(id, params, config)

View Source

Specs

update_rule(id(), map(), config()) :: {:ok, map()} | error()

Update a rule.

see

https://auth0.com/docs/api/management/v2/#!/Rules/patch_rules_by_id

Link to this function

update_tenant_setting(params, config)

View Source

Specs

update_tenant_setting(map(), config()) :: {:ok, map()} | error()

Update tenant settings.

see

https://auth0.com/docs/api/management/v2/#!/Tenants/patch_settings

Link to this function

update_user(id, params, config)

View Source

Specs

update_user(id(), map(), config()) :: {:ok, map()} | error()

Update a User.

see

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

Link to this function

verify_custom_domain(id, config)

View Source

Specs

verify_custom_domain(id(), config()) :: {:ok, map()} | error()

Verify a custom domain.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/post_verify