Auth0.Management (Auth0Api v1.4.0) View Source
Documentation for Auth0 Management API.
Link to this section Summary
Functions
Add hook secrets.
Add connections to an organization.
Add members 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 client.
Create client grant.
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 a hook.
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.
Create a role.
Create a rule.
Create a User.
Delete an action.
Delete branding theme.
Delete a client.
Delete client grant.
Delete a connection.
Delete a connection user.
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 hook secrets.
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 an execution.
Get actions service status.
Get triggers.
Get a specific version of an action.
Get an action's versions.
Get actions.
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.
Get branding theme.
Get a client.
Get client grants.
Get clients.
Get a connection.
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.
Get an email template.
Get grants.
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 a hook.
Get hook secrets.
Get hooks.
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 an invitation to organization.
Get invitations to organization.
Get members who belong to an organization.
Get the roles assigned to an organization member.
Get organizations.
Get custom text for a prompt.
Get prompts settings.
Get a resource server.
Get resource servers.
Get a role.
Get permissions granted by role.
Get a role's users.
Get roles.
Get a rule.
Get rules.
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 a User.
Get blocks by identifier.
Get a user's blocks.
Get the First Confirmed Multi-factor Authentication Enrollment.
Get user's log events.
List user's organizations.
Get a User's Permissions.
Get a user's roles.
List or Search Users.
Search Users by Email.
Invalidate All Remembered Browsers for Multi-factor Authentication.
Link a User Account.
Get the Multi-factor Authentication policies.
Modify an Organization.
Modify an Organizations Connection.
Patch an email template.
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.
Test an Action.
Unblock by identifier.
Unblock a user.
Unlink a User Identity.
Update an action.
Update trigger bindings.
Update breached password detection settings.
Update the brute force configuration.
Update the suspicious IP throttling configuration.
Update branding settings.
Update branding theme.
Update a client.
Update client grant.
Update a connection.
Update custom domain configuration.
Update the email provider.
Update an email template.
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 Twilio phone configuration.
Update Twilio SMS configuration.
Update a hook.
Update hook secrets.
Update a log stream.
Update prompts settings.
Update a resource server.
Update a role.
Update a rule.
Update tenant settings.
Update a User.
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
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
Specs
add_hook_secrets(id(), Auth0.Management.Hooks.Secrets.Add.Params.t(), config()) :: {:ok, map(), response_body()} | error()
Add hook secrets.
see
https://auth0.com/docs/api/management/v2/#!/Hooks/post_secrets
Specs
add_organization_connection( id(), Auth0.Management.Organizations.EnabledConnections.Create.Params.t(), config() ) :: {:ok, Auth0.Entity.EnabledConnection.t(), response_body()} | error()
Add connections to an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/post_enabled_connections
Specs
add_organization_members( id(), Auth0.Management.Organizations.Members.Add.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Add members to an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/post_members
Specs
assign_organization_roles( id(), user_id(), Auth0.Management.Organizations.Members.Roles.Add.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Add members to an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/post_members
Specs
assign_role_users( id(), Auth0.Management.Roles.Users.Assign.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Assign users to a role.
see
https://auth0.com/docs/api/management/v2/#!/Roles/post_role_users
Specs
assign_user_permissions( id(), Auth0.Management.Users.Permissions.Assign.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Assign Permissions to a User.
see
https://auth0.com/docs/api/management/v2/#!/Users/post_permissions
Specs
assign_user_roles( id(), Auth0.Management.Users.Roles.Assign.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Assign roles to a user.
see
https://auth0.com/docs/api/management/v2/#!/Users/post_user_roles
Specs
associate_role_permissions( id(), Auth0.Management.Roles.Permissions.Associate.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Associate permissions with a role.
see
https://auth0.com/docs/api/management/v2/#!/Roles/post_role_permission_assignment
Specs
blacklist_token(Auth0.Management.Blacklist.Tokens.Add.Params.t(), config()) :: {:ok, String.t(), response_body()} | error()
Blacklist a token.
see
https://auth0.com/docs/api/management/v2/#!/Blacklists/post_tokens
Specs
check_ip_blocked(ip(), config()) :: {:ok, boolean(), response_body()} | error()
Check if an IP address is blocked.
see
https://auth0.com/docs/api/management/v2/#!/Anomaly/get_ips_by_id
Specs
configure_custom_domain( Auth0.Management.CustomDomains.Configure.Params.t(), config() ) :: {:ok, Auth0.Entity.CustomDomain.t(), response_body()} | error()
Configure a new custom domain.
see
https://auth0.com/docs/api/management/v2/#!/Custom_Domains/post_custom_domains
Specs
configure_email_provider( Auth0.Management.Emails.Provider.Configure.Params.t(), config() ) :: {:ok, Auth0.Entity.EmailProvider.t(), response_body()} | error()
Configure the email provider.
see
https://auth0.com/docs/api/management/v2/#!/Emails/post_provider
Specs
create_action(Auth0.Management.Actions.Create.Params.t(), config()) :: {:ok, Auth0.Entity.Action.t(), response_body()} | error()
Create an action.
see
https://auth0.com/docs/api/management/v2/#!/Actions/post_action
Specs
create_branding_theme( Auth0.Management.Branding.Themes.Create.Params.t(), config() ) :: {:ok, Auth0.Entity.Theme.t(), response_body()} | error()
Create branding theme.
see
https://auth0.com/docs/api/management/v2#!/Branding/post_branding_theme
Specs
create_client(Auth0.Management.Clients.Create.Params.t(), config()) :: {:ok, Auth0.Entity.Client.t(), response_body()} | error()
Create a client.
see
https://auth0.com/docs/api/management/v2/#!/Clients/post_clients
Specs
create_client_grant(Auth0.Management.ClientGrants.Create.Params.t(), config()) :: {:ok, Auth0.Entity.ClientGrant.t(), response_body()} | error()
Create client grant.
see
https://auth0.com/docs/api/management/v2/#!/Client_Grants/post_client_grants
Specs
create_connection(Auth0.Management.Connections.Create.Params.t(), config()) :: {:ok, Auth0.Entity.Connection.t(), response_body()} | error()
Create a connection.
see
https://auth0.com/docs/api/management/v2/#!/Connections/post_connections
Specs
create_device_credential( Auth0.Management.DeviceCredentials.Create.Params.t(), config() ) :: {:ok, Auth0.Entity.DeviceCredential.t(), response_body()} | error()
Create a device public key credential.
see
https://auth0.com/docs/api/management/v2/#!/Device_Credentials/post_device_credentials
Specs
create_email_template( Auth0.Management.EmailTemplates.Create.Params.t(), config() ) :: {:ok, Auth0.Entity.EmailTemplate.t(), response_body()} | error()
Create an email template.
see
https://auth0.com/docs/api/management/v2/#!/Email_Templates/post_email_templates
Specs
create_email_verification_ticket( Auth0.Management.Tickets.EmailVerification.Create.Params.t(), config() ) :: {:ok, Auth0.Entity.Ticket.t(), response_body()} | error()
Create an email verification ticket.
see
https://auth0.com/docs/api/management/v2/#!/Tickets/post_email_verification
Specs
create_guardian_enrollment_ticket( Auth0.Management.Guardian.Enrollments.Ticket.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianEnrollmentTicket.t(), response_body()} | error()
Create a multi-factor authentication enrollment ticket.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/post_ticket
Specs
create_hook(Auth0.Management.Hooks.Create.Params.t(), config()) :: {:ok, Auth0.Entity.Hook.t(), response_body()} | error()
Create a hook.
see
https://auth0.com/docs/api/management/v2/#!/Hooks/post_hooks
Specs
create_job_users_exports(Auth0.Management.Jobs.UsersExport.Params.t(), config()) :: {:ok, Auth0.Entity.JobsUsersExport.t(), response_body()} | error()
Create export users job.
see
https://auth0.com/docs/api/management/v2/#!/Jobs/post_users_exports
Specs
create_job_users_imports(Auth0.Management.Jobs.UsersImport.Params.t(), config()) :: {:ok, Auth0.Entity.JobsUsersImport.t(), response_body()} | error()
Create import users job.
see
https://auth0.com/docs/api/management/v2/#!/Jobs/post_users_imports
Specs
create_log_stream(Auth0.Management.LogStreams.Create.Params.t(), config()) :: {:ok, Auth0.Entity.LogStream.t(), response_body()} | error()
Create a log stream.
see
https://auth0.com/docs/api/management/v2/#!/Log_Streams/post_log_streams
Specs
create_organization(Auth0.Management.Organizations.Create.Params.t(), config()) :: {:ok, Auth0.Entity.Organization.t(), response_body()} | error()
Create an Organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/post_organizations
Specs
create_organization_invitation( id(), Auth0.Management.Organizations.Invitations.Create.Params.t(), config() ) :: {:ok, Auth0.Entity.Invitation.t(), response_body()} | error()
Create invitations to organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/post_invitations
Specs
create_password_change_ticket( Auth0.Management.Tickets.PasswordChange.Create.Params.t(), config() ) :: {:ok, Auth0.Entity.Ticket.t(), response_body()} | error()
Create a password change ticket.
see
https://auth0.com/docs/api/management/v2/#!/Tickets/post_password_change
Specs
create_resource_server( Auth0.Management.ResourceServers.Create.Params.t(), config() ) :: {:ok, Auth0.Entity.ResourceServer.t(), response_body()} | error()
Create a resource server.
see
https://auth0.com/docs/api/management/v2/#!/Resource_Servers/post_resource_servers
Specs
create_role(Auth0.Management.Roles.Create.Params.t(), config()) :: {:ok, Auth0.Entity.Role.t(), response_body()} | error()
Create a role.
see
https://auth0.com/docs/api/management/v2/#!/Roles/post_roles
Specs
create_rule(Auth0.Management.Rules.Create.Params.t(), config()) :: {:ok, Auth0.Entity.Rule.t(), response_body()} | error()
Create a rule.
see
https://auth0.com/docs/api/management/v2/#!/Rules/post_rules
Specs
create_user(Auth0.Management.Users.Create.Params.t(), config()) :: {:ok, Auth0.Entity.User.t(), response_body()} | error()
Create a User.
see
https://auth0.com/docs/api/management/v2/#!/Users/post_users
Specs
delete_action(id(), Auth0.Management.Actions.Delete.Params.t(), config()) :: {:ok, String.t(), response_body()} | error()
Delete an action.
see
https://auth0.com/docs/api/management/v2/#!/Actions/delete_action
Specs
delete_branding_theme(theme_id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete branding theme.
see
https://auth0.com/docs/api/management/v2#!/Branding/delete_branding_theme
Specs
delete_client(id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete a client.
see
https://auth0.com/docs/api/management/v2/#!/Clients/delete_clients_by_id
Specs
delete_client_grant(id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete client grant.
see
https://auth0.com/docs/api/management/v2/#!/Client_Grants/delete_client_grants_by_id
Specs
delete_connection(id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete a connection.
see
https://auth0.com/docs/api/management/v2/#!/Connections/delete_connections_by_id
Specs
delete_connection_users( id(), Auth0.Management.Connections.Users.Delete.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Delete a connection user.
see
https://auth0.com/docs/api/management/v2/#!/Connections/delete_users_by_email
Specs
delete_custom_domain_configuration(id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete custom domain configuration.
see
https://auth0.com/docs/api/management/v2/#!/Custom_Domains/delete_custom_domains_by_id
Specs
delete_device_credential(id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete a device credential.
see
https://auth0.com/docs/api/management/v2/#!/Device_Credentials/delete_device_credentials_by_id
Specs
delete_email_provider(config()) :: {:ok, String.t(), response_body()} | error()
Delete the email provider.
see
https://auth0.com/docs/api/management/v2/#!/Emails/delete_provider
Specs
delete_grant(id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete a grant.
see
https://auth0.com/docs/api/management/v2/#!/Grants/delete_grants_by_id
Specs
delete_guardian_enrollment(id(), config()) :: {:ok, String.t(), response_body()} | 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
Specs
delete_hook_secrets( id(), Auth0.Management.Hooks.Secrets.Delete.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Delete hook secrets.
see
https://auth0.com/docs/api/management/v2/#!/Hooks/delete_secrets
Specs
delete_log_stream(id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete log stream.
see
https://auth0.com/docs/api/management/v2/#!/Log_Streams/delete_log_streams_by_id
Specs
delete_organization(id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/delete_organizations_by_id
Specs
delete_organization_connection(id(), connection_id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete connections from an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/delete_enabled_connections_by_connectionId
Specs
delete_organization_invitation(id(), invitation_id(), config()) :: {:ok, String.t(), response_body()} | error()
Delete an invitation to organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/delete_invitations_by_invitation_id
Specs
delete_organization_members( id(), Auth0.Management.Organizations.Members.Delete.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Delete members from an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/delete_members
Specs
delete_organization_roles( id(), user_id(), Auth0.Management.Organizations.Members.Roles.Delete.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Delete members from an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/delete_members
Specs
delete_resource_server(id(), config()) :: {:ok, String.t(), response_body()} | 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(), response_body()} | 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(), response_body()} | error()
Delete a rule.
see
https://auth0.com/docs/api/management/v2/#!/Rules/delete_rules_by_id
Specs
delete_rules_config(key(), config()) :: {:ok, String.t(), response_body()} | error()
Delete rules config for a given key.
see
https://auth0.com/docs/api/management/v2/#!/Rules_Configs/delete_rules_configs_by_key
Specs
delete_template_for_universal_login(config()) :: {:ok, String.t(), response_body()} | 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(), response_body()} | error()
Delete a User.
see
https://auth0.com/docs/api/management/v2/#!/Users/delete_users_by_id
Specs
delete_user_multifactor( id(), Auth0.Management.Users.Multifactor.Delete.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Delete a User's Multi-factor Provider.
see
https://auth0.com/docs/api/management/v2/#!/Users/delete_multifactor_by_provider
Specs
deploy_action(id(), config()) :: {:ok, Auth0.Entity.ActionVersion.t(), response_body()} | error()
Deploy an action.
see
https://auth0.com/docs/api/management/v2/#!/Actions/post_deploy_action
Specs
get_action(id(), config()) :: {:ok, Auth0.Entity.Action.t(), response_body()} | error()
Get an action.
see
https://auth0.com/docs/api/management/v2/#!/Actions/get_action
Specs
get_action_execution(id(), config()) :: {:ok, Auth0.Entity.ActionExecution.t(), response_body()} | error()
Get an execution.
see
https://auth0.com/docs/api/management/v2/#!/Actions/get_execution
Specs
get_action_status(config()) :: {:ok, Auth0.Entity.ActionStatus.t(), response_body()} | error()
Get actions service status.
see
https://auth0.com/docs/api/management/v2/#!/Actions/get_service_status
Specs
get_action_trigger_bindings( trigger_id(), Auth0.Management.Actions.Triggers.Bindings.List.Params.t(), config() ) :: {:ok, Auth0.Entity.ActionTriggerBindings.t(), response_body()} | error()
Get triggers.
see
https://auth0.com/docs/api/management/v2/#!/Actions/get_triggers
Specs
get_action_version(action_id(), id(), config()) :: {:ok, Auth0.Entity.ActionVersions.t(), response_body()} | error()
Get a specific version of an action.
see
https://auth0.com/docs/api/management/v2/#!/Actions/get_action_version
Specs
get_action_versions( action_id(), Auth0.Management.Actions.Versions.List.Params.t(), config() ) :: {:ok, Auth0.Entity.ActionVersions.t(), response_body()} | error()
Get an action's versions.
see
https://auth0.com/docs/api/management/v2/#!/Actions/get_action_versions
Specs
get_actions(Auth0.Management.Actions.List.Params.t(), config()) :: {:ok, Auth0.Entity.Actions.t(), response_body()} | error()
Get actions.
see
https://auth0.com/docs/api/management/v2/#!/Actions/get_actions
Specs
get_active_users_count(config()) :: {:ok, integer(), response_body()} | error()
Get active users count.
see
https://auth0.com/docs/api/management/v2/#!/Stats/get_active_users
Specs
get_attack_protection_breached_password_detection(config()) :: {:ok, Auth0.Entity.AttackProtectionBreachedPasswordDetection.t(), response_body()} | error()
Get breached password detection settings.
see
https://auth0.com/docs/api/management/v2/#!/Attack_Protection/get_breached_password_detection
Specs
get_attack_protection_brute_force_protection(config()) :: {:ok, Auth0.Entity.AttackProtectionBruteForceProtection.t(), response_body()} | error()
Get the brute force configuration.
see
https://auth0.com/docs/api/management/v2/#!/Attack_Protection/get_brute_force_protection
Specs
get_attack_protection_suspicious_ip_throttling(config()) :: {:ok, Auth0.Entity.AttackProtectionSuspiciousIpThrottling.t(), response_body()} | error()
Get the suspicious IP throttling configuration.
see
https://auth0.com/docs/api/management/v2/#!/Attack_Protection/get_suspicious_ip_throttling
Specs
get_blacklisted_tokens( Auth0.Management.Blacklist.Tokens.List.Params.t(), config() ) :: {:ok, Auth0.Entity.BlacklistTokens.t(), response_body()} | error()
Get blacklisted tokens.
see
https://auth0.com/docs/api/management/v2/#!/Blacklists/get_tokens
Specs
get_branding(config()) :: {:ok, Auth0.Entity.Branding.t(), response_body()} | error()
Get branding settings.
see
https://auth0.com/docs/api/management/v2/#!/Branding/get_branding
Specs
get_branding_theme(theme_id(), config()) :: {:ok, Auth0.Entity.Theme.t(), response_body()} | error()
Get branding theme.
see
https://auth0.com/docs/api/management/v2#!/Branding/get_branding_theme
Specs
get_client(id(), Auth0.Management.Clients.Get.Params.t(), config()) :: {:ok, Auth0.Entity.Client.t(), response_body()} | error()
Get a client.
see
https://auth0.com/docs/api/management/v2/#!/Clients/get_clients_by_id
Specs
get_client_grants(Auth0.Management.ClientGrants.List.Params.t(), config()) :: {:ok, Auth0.Entity.ClientGrants.t(), response_body()} | error()
Get client grants.
see
https://auth0.com/docs/api/management/v2/#!/Client_Grants/get_client_grants
Specs
get_clients(Auth0.Management.Clients.List.Params.t(), config()) :: {:ok, Auth0.Entity.Clients.t(), response_body()} | error()
Get clients.
see
https://auth0.com/docs/api/management/v2/#!/Clients/get_clients
Specs
get_connection(id(), Auth0.Management.Connections.Get.Params.t(), config()) :: {:ok, Auth0.Entity.Connection.t(), response_body()} | error()
Get a connection.
see
https://auth0.com/docs/api/management/v2/#!/Connections/get_connections_by_id
Specs
get_connection_status(id(), config()) :: {:ok, boolean(), response_body()} | error()
Check connection status.
see
https://auth0.com/docs/api/management/v2/#!/Connections/get_status
Specs
get_connections(Auth0.Management.Connections.List.Params.t(), config()) :: {:ok, Auth0.Entity.Connections.t(), response_body()} | error()
Get all connections.
see
https://auth0.com/docs/api/management/v2/#!/Connections/get_connections
Specs
get_custom_domain_configuration(id(), config()) :: {:ok, Auth0.Entity.CustomDomain.t(), response_body()} | error()
Get custom domain configuration.
see
https://auth0.com/docs/api/management/v2/#!/Custom_Domains/get_custom_domains_by_id
Specs
get_custom_domain_configurations(config()) :: {:ok, Auth0.Entity.CustomDomains.t(), response_body()} | error()
Get custom domains configurations.
see
https://auth0.com/docs/api/management/v2/#!/Custom_Domains/get_custom_domains
Specs
get_daily_stats(config()) :: {:ok, Auth0.Entity.DailyStats.t(), response_body()} | error()
Get daily stats.
see
https://auth0.com/docs/api/management/v2/#!/Stats/get_daily
Specs
get_default_branding_theme(config()) :: {:ok, Auth0.Entity.Theme.t(), response_body()} | error()
Retrieve default branding theme.
see
https://auth0.com/docs/api/management/v2#!/Branding/get_default_branding_theme
Specs
get_device_credentials( Auth0.Management.DeviceCredentials.List.Params.t(), config() ) :: {:ok, Auth0.Entity.DeviceCredentials.t(), response_body()} | error()
Retrieve device credentials.
see
https://auth0.com/docs/api/management/v2/#!/Device_Credentials/get_device_credentials
Specs
get_email_provider(Auth0.Management.Emails.Provider.Get.Params.t(), config()) :: {:ok, Auth0.Entity.EmailProvider.t(), response_body()} | error()
Get the email provider.
see
https://auth0.com/docs/api/management/v2/#!/Emails/get_provider
Specs
get_email_template(template_name(), config()) :: {:ok, Auth0.Entity.EmailTemplate.t(), response_body()} | error()
Get an email template.
see
https://auth0.com/docs/api/management/v2/#!/Email_Templates/get_email_templates_by_templateName
Specs
get_grants(Auth0.Management.Grants.List.Params.t(), config()) :: {:ok, Auth0.Entity.Grants.t(), response_body()} | error()
Get grants.
see
https://auth0.com/docs/api/management/v2/#!/Grants/get_grants
Specs
get_guardian_aws_sns_configuration(config()) :: {:ok, Auth0.Entity.GuardianAwsSnsConfiguration.t(), response_body()} | error()
Retrieve AWS SNS push notification configuration.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_sns
Specs
get_guardian_enrollment(id(), config()) :: {:ok, Auth0.Entity.GuardianEnrollment.t(), response_body()} | error()
Retrieve a multi-factor authentication enrollment.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_enrollments_by_id
Specs
get_guardian_factors(config()) :: {:ok, Auth0.Entity.GuardianFactors.t(), response_body()} | error()
Retrieve Factors and their Status.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_factors
Specs
get_guardian_phone_configuration(config()) :: {:ok, Auth0.Entity.GuardianPhoneConfiguration.t(), response_body()} | error()
Retrieve phone configuration (one of auth0|twilio|phone-message-hook).
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_selected_provider
Specs
get_guardian_phone_factor(config()) :: {:ok, Auth0.Entity.GuardianPhoneFactor.t(), response_body()} | error()
Retrieve the Enabled Phone Factors.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_message_types
Specs
get_guardian_phone_template(config()) :: {:ok, Auth0.Entity.GuardianPhoneTemplate.t(), response_body()} | error()
Retrieve Enrollment and Verification Phone Templates.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_templates
Specs
get_guardian_sms_configuration(config()) :: {:ok, Auth0.Entity.GuardianSmsConfiguration.t(), response_body()} | error()
Retrieve SMS configuration (one of auth0|twilio|phone-message-hook).
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_selected_provider_0
Specs
get_guardian_sms_template(config()) :: {:ok, Auth0.Entity.GuardianSmsTemplate.t(), response_body()} | error()
Retrieve SMS Enrollment and Verification Templates.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_templates_0
Specs
get_guardian_twilio_phone_configuration(config()) :: {:ok, Auth0.Entity.GuardianTwilioConfiguration.t(), response_body()} | error()
Retrieve Twilio phone configuration.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio
Specs
get_guardian_twilio_sms_configuration(config()) :: {:ok, Auth0.Entity.GuardianTwilioConfiguration.t(), response_body()} | error()
Retrieve Twilio SMS configuration.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio_0
Specs
get_hook(id(), Auth0.Management.Hooks.Get.Params.t(), config()) :: {:ok, Auth0.Entity.Hook.t(), response_body()} | error()
Get a hook.
see
https://auth0.com/docs/api/management/v2/#!/Hooks/get_hooks_by_id
Specs
get_hook_secrets(id(), config()) :: {:ok, Auth0.Entity.HookSecret.t(), response_body()} | error()
Get hook secrets.
see
https://auth0.com/docs/api/management/v2/#!/Hooks/get_secrets
Specs
get_hooks(Auth0.Management.Hooks.List.Params.t(), config()) :: {:ok, Auth0.Entity.Hooks.t(), response_body()} | error()
Get hooks.
see
https://auth0.com/docs/api/management/v2/#!/Hooks/get_hooks
Specs
get_job(id(), config()) :: {:ok, Auth0.Entity.Jobs.t(), response_body()} | error()
Get a job.
see
https://auth0.com/docs/api/management/v2/#!/Jobs/get_jobs_by_id
Specs
get_job_error(id(), config()) :: {:ok, Auth0.Entity.JobsErrors.t(), response_body()} | error()
Get job error details.
see
https://auth0.com/docs/api/management/v2/#!/Jobs/get_errors
Specs
get_log_event(id(), config()) :: {:ok, Auth0.Entity.Log.t(), response_body()} | error()
Get a log event by id.
see
https://auth0.com/docs/api/management/v2/#!/Logs/get_logs_by_id
Specs
get_log_events(Auth0.Management.Logs.List.Params.t(), config()) :: {:ok, Auth0.Entity.Logs.t(), response_body()} | error()
Search log events.
see
https://auth0.com/docs/api/management/v2/#!/Logs/get_logs
Specs
get_log_stream(id(), config()) :: {:ok, Auth0.Entity.LogStream.t(), response_body()} | 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
Specs
get_organization(id(), config()) :: {:ok, Auth0.Entity.Organization.t(), response_body()} | error()
Get organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations_by_id
Specs
get_organization_by_name(name(), config()) :: {:ok, Auth0.Entity.Organization.t(), response_body()} | error()
Get organization by name.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_name_by_name
Specs
get_organization_connection(id(), connection_id(), config()) :: {:ok, Auth0.Entity.EnabledConnection.t(), response_body()} | error()
Get an enabled connection for an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_enabled_connections_by_connectionId
Specs
get_organization_connections( id(), Auth0.Management.Organizations.EnabledConnections.List.Params.t(), config() ) :: {:ok, Auth0.Entity.EnabledConnections.t(), response_body()} | error()
Get connections enabled for an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_enabled_connections
Specs
get_organization_invitation( id(), invitation_id(), Auth0.Management.Organizations.Invitations.Get.Params.t(), config() ) :: {:ok, Auth0.Entity.Invitation.t(), response_body()} | error()
Get an invitation to organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_invitations_by_invitation_id
Specs
get_organization_invitations( id(), Auth0.Management.Organizations.Invitations.List.Params.t(), config() ) :: {:ok, Auth0.Entity.Invitations.t(), response_body()} | error()
Get invitations to organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_invitations
Specs
get_organization_members( id(), Auth0.Management.Organizations.Members.List.Params.t(), config() ) :: {:ok, Auth0.Entity.Members.t(), response_body()} | error()
Get members who belong to an organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_members
Specs
get_organization_roles( id(), user_id(), Auth0.Management.Organizations.Members.Roles.List.Params.t(), config() ) :: {:ok, Auth0.Entity.Roles.t(), response_body()} | error()
Get the roles assigned to an organization member.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_organization_member_roles
Specs
get_organizations(Auth0.Management.Organizations.List.Params.t(), config()) :: {:ok, Auth0.Entity.Organizations.t(), response_body()} | error()
Get organizations.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations
Specs
get_prompt_custom_text(prompt(), language(), config()) :: {:ok, Auth0.Entity.CustomText.t(), response_body()} | error()
Get custom text for a prompt.
see
https://auth0.com/docs/api/management/v2/#!/Prompts/get_custom_text_by_language
Specs
get_prompt_setting(config()) :: {:ok, Auth0.Entity.Prompt.t(), response_body()} | error()
Get prompts settings.
see
https://auth0.com/docs/api/management/v2/#!/Prompts/get_prompts
Specs
get_resource_server( id(), Auth0.Management.ResourceServers.Get.Params.t(), config() ) :: {:ok, Auth0.Entity.ResourceServer.t(), response_body()} | error()
Get a resource server.
see
https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers_by_id
Specs
get_resource_servers(Auth0.Management.ResourceServers.List.Params.t(), config()) :: {:ok, Auth0.Entity.ResourceServers.t(), response_body()} | error()
Get resource servers.
see
https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers
Specs
get_role(id(), config()) :: {:ok, Auth0.Entity.Role.t(), response_body()} | error()
Get a role.
see
https://auth0.com/docs/api/management/v2/#!/Roles/get_roles_by_id
Specs
get_role_permissions( id(), Auth0.Management.Roles.Permissions.List.Params.t(), config() ) :: {:ok, Auth0.Entity.Permissions.t(), response_body()} | error()
Get permissions granted by role.
see
https://auth0.com/docs/api/management/v2/#!/Roles/get_role_permission
Specs
get_role_users(id(), Auth0.Management.Roles.Users.List.Params.t(), config()) :: {:ok, Auth0.Entity.Users.t(), response_body()} | error()
Get a role's users.
see
https://auth0.com/docs/api/management/v2/#!/Roles/get_role_user
Specs
get_roles(Auth0.Management.Roles.List.Params.t(), config()) :: {:ok, Auth0.Entity.Roles.t(), response_body()} | error()
Get roles.
see
https://auth0.com/docs/api/management/v2/#!/Roles/get_roles
Specs
get_rule(id(), Auth0.Management.Rules.Get.Params.t(), config()) :: {:ok, Auth0.Entity.Rule.t(), response_body()} | error()
Get a rule.
see
https://auth0.com/docs/api/management/v2/#!/Rules/get_rules_by_id
Specs
get_rules(Auth0.Management.Rules.List.Params.t(), config()) :: {:ok, Auth0.Entity.Rules.t(), response_body()} | error()
Get rules.
see
https://auth0.com/docs/api/management/v2/#!/Rules/get_rules
Specs
get_rules_configs(config()) :: {:ok, Auth0.Entity.RulesConfigs.t(), response_body()} | error()
Retrieve config variable keys for rules (get_rules-configs).
see
https://auth0.com/docs/api/management/v2/#!/Rules_Configs/get_rules_configs
Specs
get_signing_key(kid(), config()) :: {:ok, Auth0.Entity.SigningKey.t(), response_body()} | error()
Get an Application Signing Key by its key id.
see
https://auth0.com/docs/api/management/v2/#!/Keys/get_signing_key
Specs
get_signing_keys(config()) :: {:ok, Auth0.Entity.SigningKeys.t(), response_body()} | error()
Get all Application Signing Keys.
see
https://auth0.com/docs/api/management/v2/#!/Keys/get_signing_keys
Specs
get_template_for_universal_login(config()) :: {:ok, Auth0.Entity.UniversalLogin.t(), response_body()} | error()
Get template for New Universal Login Experience.
see
https://auth0.com/docs/api/management/v2/#!/Branding/get_universal_login
Specs
get_tenant_setting(Auth0.Management.Tenants.Settings.Get.Params.t(), config()) :: {:ok, Auth0.Entity.TenantSetting.t(), response_body()} | error()
Get tenant settings.
see
https://auth0.com/docs/api/management/v2/#!/Tenants/tenant_settings_route
Specs
get_user(id(), Auth0.Management.Users.Get.Params.t(), config()) :: {:ok, Auth0.Entity.User.t(), response_body()} | error()
Get a User.
see
https://auth0.com/docs/api/management/v2/#!/Users/get_users_by_id
Specs
get_user_block(Auth0.Management.UserBlocks.Get.Params.t(), config()) :: {:ok, Auth0.Entity.UserBlocks.t(), response_body()} | error()
Get blocks by identifier.
see
https://auth0.com/docs/api/management/v2/#!/User_Blocks/get_user_blocks
Specs
get_user_block_by_user_id( id(), Auth0.Management.UserBlocks.Users.Get.Params.t(), config() ) :: {:ok, Auth0.Entity.UserBlocks.t(), response_body()} | error()
Get a user's blocks.
see
https://auth0.com/docs/api/management/v2/#!/User_Blocks/get_user_blocks_by_id
Specs
get_user_enrollments(id(), config()) :: {:ok, Auth0.Entity.Enrollments.t(), response_body()} | error()
Get the First Confirmed Multi-factor Authentication Enrollment.
see
https://auth0.com/docs/api/management/v2/#!/Users/get_enrollments
Specs
get_user_logs(id(), Auth0.Management.Users.Logs.List.Params.t(), config()) :: {:ok, Auth0.Entity.Logs.t(), response_body()} | error()
Get user's log events.
see
https://auth0.com/docs/api/management/v2/#!/Users/get_logs_by_user
Specs
get_user_organizations( id(), Auth0.Management.Users.Organizations.List.Params.t(), config() ) :: {:ok, Auth0.Entity.Organizations.t(), response_body()} | error()
List user's organizations.
see
https://auth0.com/docs/api/management/v2/#!/Users/get_user_organizations
Specs
get_user_permissions( id(), Auth0.Management.Users.Permissions.List.Params.t(), config() ) :: {:ok, Auth0.Entity.Permissions.t(), response_body()} | error()
Get a User's Permissions.
see
https://auth0.com/docs/api/management/v2/#!/Users/get_permissions
Specs
get_user_roles(id(), Auth0.Management.Users.Roles.List.Params.t(), config()) :: {:ok, Auth0.Entity.Roles.t(), response_body()} | error()
Get a user's roles.
see
https://auth0.com/docs/api/management/v2/#!/Users/get_user_roles
Specs
get_users(Auth0.Management.Users.List.Params.t(), config()) :: {:ok, Auth0.Entity.Users.t(), response_body()} | error()
List or Search Users.
see
https://auth0.com/docs/api/management/v2/#!/Users/get_users
Specs
get_users_by_email(Auth0.Management.UsersByEmail.List.Params.t(), config()) :: {:ok, Auth0.Entity.Users.t(), response_body()} | error()
Search Users by Email.
see
https://auth0.com/docs/api/management/v2/#!/Users_By_Email/get_users_by_email
Specs
invalidate_user_remembered_browser_for_multifactor(id(), config()) :: {:ok, String.t(), response_body()} | error()
Invalidate All Remembered Browsers for Multi-factor Authentication.
see
https://auth0.com/docs/api/management/v2/#!/Users/post_invalidate_remember_browser
Specs
link_user_identities( id(), Auth0.Management.Users.Identities.Link.Params.t(), config() ) :: {:ok, Auth0.Entity.Identities.t(), response_body()} | error()
Link a User Account.
see
https://auth0.com/docs/api/management/v2/#!/Users/post_identities
Specs
list_guardian_policies(config()) :: {:ok, [map()], response_body()} | error()
Get the Multi-factor Authentication policies.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/get_policies
Specs
modify_organization( id(), Auth0.Management.Organizations.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.Organization.t(), response_body()} | error()
Modify an Organization.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/patch_organizations_by_id
Specs
modify_organization_connection( id(), connection_id(), Auth0.Management.Organizations.EnabledConnections.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.EnabledConnection.t(), response_body()} | error()
Modify an Organizations Connection.
see
https://auth0.com/docs/api/management/v2/#!/Organizations/patch_enabled_connections_by_connectionId
Specs
patch_email_template( template_name(), Auth0.Management.EmailTemplates.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.EmailTemplate.t(), response_body()} | error()
Patch an email template.
see
https://auth0.com/docs/api/management/v2/#!/Email_Templates/patch_email_templates_by_templateName
Specs
patch_guardian_aws_sns_configuration( Auth0.Management.Guardian.AwsSns.Configuration.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianAwsSnsConfiguration.t(), response_body()} | error()
Update SNS configuration for push notifications.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/patch_sns
Specs
regenerate_user_recovery_code(id(), config()) :: {:ok, Auth0.Entity.RecoveryCodeRegeneration.t(), response_body()} | error()
Generate New Multi-factor Authentication Recovery Code.
see
https://auth0.com/docs/api/management/v2/#!/Users/post_recovery_code_regeneration
Specs
remove_blocked_ip(ip(), config()) :: {:ok, String.t(), response_body()} | error()
Remove the blocked IP address.
see
https://auth0.com/docs/api/management/v2/#!/Anomaly/delete_ips_by_id
Specs
remove_role_permissions( id(), Auth0.Management.Roles.Permissions.Remove.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Remove permissions from a role.
see
https://auth0.com/docs/api/management/v2/#!/Roles/delete_role_permission_assignment
Specs
remove_user_permissions( id(), Auth0.Management.Users.Permissions.Remove.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Remove Permissions from a User.
see
https://auth0.com/docs/api/management/v2/#!/Users/delete_permissions
Specs
remove_user_roles( id(), Auth0.Management.Users.Roles.Remove.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Removes roles from a user.
see
https://auth0.com/docs/api/management/v2/#!/Users/delete_user_roles
Specs
revoke_signing_key(kid(), config()) :: {:ok, Auth0.Entity.SigningKey.t(), response_body()} | error()
Revoke an Application Signing Key by its key id.
see
https://auth0.com/docs/api/management/v2/#!/Keys/put_signing_keys
Specs
rollback_action_version( action_id(), id(), Auth0.Management.Actions.Versions.Rollback.Params.t(), config() ) :: {:ok, Auth0.Entity.ActionVersion.t(), response_body()} | error()
Roll back to a previous action version.
see
https://auth0.com/docs/api/management/v2/#!/Actions/post_deploy_draft_version
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
Specs
rotate_signing_key(config()) :: {:ok, Auth0.Entity.SigningKey.t(), response_body()} | error()
Rotate the Application Signing Key.
see
https://auth0.com/docs/api/management/v2/#!/Keys/post_signing_keys
Specs
send_job_verification_email( Auth0.Management.Jobs.VerificationEmail.Params.t(), config() ) :: {:ok, Auth0.Entity.JobsVerificationEmail.t(), response_body()} | error()
Send an email address verification email.
see
https://auth0.com/docs/api/management/v2/#!/Jobs/post_verification_email
Specs
set_guardian_policies(map(), config()) :: {:ok, [map()], response_body()} | error()
Set the Multi-factor Authentication policies.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_policies
Specs
set_prompt_custom_text( prompt(), language(), Auth0.Management.Prompts.CustomText.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.CustomText.t(), response_body()} | error()
Set custom text for a specific prompt.
see
https://auth0.com/docs/api/management/v2/#!/Prompts/put_custom_text_by_language
Specs
set_rules_config(key(), Auth0.Management.RulesConfigs.Put.Params.t(), config()) :: {:ok, Auth0.Entity.RulesConfig.t(), response_body()} | error()
Set rules config for a given key.
see
https://auth0.com/docs/api/management/v2/#!/Rules_Configs/put_rules_configs_by_key
Specs
set_template_for_universal_login( Auth0.Management.Branding.Templates.UniversalLogin.Put.Params.t(), config() ) :: {:ok, String.t(), response_body()} | error()
Set template for New Universal Login Experience.
see
https://auth0.com/docs/api/management/v2/#!/Branding/put_universal_login
Specs
test_action(id(), Auth0.Management.Actions.Test.Params.t(), config()) :: {:ok, Auth0.Entity.ActionTest.t(), response_body()} | error()
Test an Action.
see
https://auth0.com/docs/api/management/v2/#!/Actions/post_test_action
Specs
unblock_user_block(Auth0.Management.UserBlocks.Unblock.Params.t(), config()) :: {:ok, String.t(), response_body()} | error()
Unblock by identifier.
see
https://auth0.com/docs/api/management/v2/#!/User_Blocks/delete_user_blocks
Specs
unblock_user_block_by_user_id(id(), config()) :: {:ok, String.t(), response_body()} | error()
Unblock a user.
see
https://auth0.com/docs/api/management/v2/#!/User_Blocks/delete_user_blocks_by_id
Specs
unlink_user_identities(id(), provider(), user_id(), config()) :: {:ok, Auth0.Entity.Identities.t(), response_body()} | error()
Unlink a User Identity.
see
https://auth0.com/docs/api/management/v2/#!/Users/delete_user_identity_by_user_id
Specs
update_action(id(), Auth0.Management.Actions.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.Action.t(), response_body()} | error()
Update an action.
see
https://auth0.com/docs/api/management/v2/#!/Actions/patch_action
Specs
update_action_trigger_bindings( trigger_id(), Auth0.Management.Actions.Triggers.Bindings.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.ActionTriggerBindings.t(), response_body()} | error()
Update trigger bindings.
see
https://auth0.com/docs/api/management/v2/#!/Actions/patch_bindings
update_attack_protection_breached_password_detection(params, config)
View SourceSpecs
update_attack_protection_breached_password_detection( Auth0.Management.AttackProtection.BreachedPasswordDetection.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.AttackProtectionBreachedPasswordDetection.t(), response_body()} | error()
Update breached password detection settings.
see
https://auth0.com/docs/api/management/v2/#!/Attack_Protection/patch_breached_password_detection
Specs
update_attack_protection_brute_force_protection( Auth0.Management.AttackProtection.BruteForceProtection.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.AttackProtectionBruteForceProtection.t(), response_body()} | error()
Update the brute force configuration.
see
https://auth0.com/docs/api/management/v2/#!/Attack_Protection/patch_brute_force_protection
Specs
update_attack_protection_suspicious_ip_throttling( Auth0.Management.AttackProtection.SuspiciousIpThrottling.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.AttackProtectionSuspiciousIpThrottling.t(), response_body()} | error()
Update the suspicious IP throttling configuration.
see
https://auth0.com/docs/api/management/v2/#!/Attack_Protection/patch_suspicious_ip_throttling
Specs
update_branding(Auth0.Management.Branding.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.Branding.t(), response_body()} | error()
Update branding settings.
see
https://auth0.com/docs/api/management/v2/#!/Branding/patch_branding
Specs
update_branding_theme( theme_id(), Auth0.Management.Branding.Themes.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.Theme.t(), response_body()} | error()
Update branding theme.
see
https://auth0.com/docs/api/management/v2#!/Branding/patch_branding_theme
Specs
update_client(id(), Auth0.Management.Clients.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.Client.t(), response_body()} | error()
Update a client.
see
https://auth0.com/docs/api/management/v2/#!/Clients/patch_clients_by_id
Specs
update_client_grant( id(), Auth0.Management.ClientGrants.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.ClientGrant.t(), response_body()} | error()
Update client grant.
see
https://auth0.com/docs/api/management/v2/#!/Client_Grants/patch_client_grants_by_id
Specs
update_connection(id(), Auth0.Management.Connections.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.Connection.t(), response_body()} | error()
Update a connection.
see
https://auth0.com/docs/api/management/v2/#!/Connections/patch_connections_by_id
Specs
update_custom_domain_configuration( id(), Auth0.Management.CustomDomains.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.CustomDomain.t(), response_body()} | error()
Update custom domain configuration.
see
https://auth0.com/docs/api/management/v2/#!/Custom_Domains/patch_custom_domains_by_id
Specs
update_email_provider( Auth0.Management.Emails.Provider.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.EmailProvider.t(), response_body()} | error()
Update the email provider.
see
https://auth0.com/docs/api/management/v2/#!/Emails/patch_provider
Specs
update_email_template( template_name(), Auth0.Management.EmailTemplates.Update.Params.t(), config() ) :: {:ok, Auth0.Entity.EmailTemplate.t(), response_body()} | error()
Update an email template.
see
https://auth0.com/docs/api/management/v2/#!/Email_Templates/put_email_templates_by_templateName
Specs
update_guardian_aws_sns_configuration( Auth0.Management.Guardian.AwsSns.Configuration.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianAwsSnsConfiguration.t(), response_body()} | error()
Update AWS SNS push notification configuration.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_sns
Specs
update_guardian_factor( name(), Auth0.Management.Guardian.Factors.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianFactor.t(), response_body()} | error()
Update a Multi-factor Authentication Factor.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_factors_by_name
Specs
update_guardian_phone_configuration( Auth0.Management.Guardian.Phone.Configuration.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianPhoneConfiguration.t(), response_body()} | error()
Update phone configuration (one of auth0|twilio|phone-message-hook).
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_selected_provider
Specs
update_guardian_phone_factor( Auth0.Management.Guardian.Phone.Factor.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianPhoneFactor.t(), response_body()} | error()
Update the Enabled Phone Factors.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_message_types
Specs
update_guardian_phone_template( Auth0.Management.Guardian.Phone.Template.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianPhoneTemplate.t(), response_body()} | error()
Update Enrollment and Verification Phone Templates.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_templates
Specs
update_guardian_sms_configuration( Auth0.Management.Guardian.Sms.Configuration.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianSmsConfiguration.t(), response_body()} | error()
Update SMS configuration (one of auth0|twilio|phone-message-hook).
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_selected_provider_0
Specs
update_guardian_sms_template( Auth0.Management.Guardian.Sms.Template.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianSmsTemplate.t(), response_body()} | error()
Update SMS Enrollment and Verification Templates.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_templates_0
Specs
update_guardian_twilio_phone_configuration( Auth0.Management.Guardian.Twilio.Phone.Configuration.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianTwilioConfiguration.t(), response_body()} | error()
Update Twilio phone configuration.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_twilio
Specs
update_guardian_twilio_sms_configuration( Auth0.Management.Guardian.Twilio.Sms.Configuration.Put.Params.t(), config() ) :: {:ok, Auth0.Entity.GuardianTwilioConfiguration.t(), response_body()} | error()
Update Twilio SMS configuration.
see
https://auth0.com/docs/api/management/v2/#!/Guardian/put_twilio_0
Specs
update_hook(id(), Auth0.Management.Hooks.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.Hook.t(), response_body()} | error()
Update a hook.
see
https://auth0.com/docs/api/management/v2/#!/Hooks/patch_hooks_by_id
Specs
update_hook_secrets( id(), Auth0.Management.Hooks.Secrets.Patch.Params.t(), config() ) :: {:ok, map(), response_body()} | error()
Update hook secrets.
see
https://auth0.com/docs/api/management/v2/#!/Hooks/patch_hooks_by_id
Specs
update_log_stream(id(), Auth0.Management.LogStreams.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.LogStream.t(), response_body()} | error()
Update a log stream.
see
https://auth0.com/docs/api/management/v2/#!/Log_Streams/patch_log_streams_by_id
Specs
update_prompt_setting(Auth0.Management.Prompts.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.Prompt.t(), response_body()} | error()
Update prompts settings.
see
https://auth0.com/docs/api/management/v2/#!/Prompts/patch_prompts
Specs
update_resource_server( id(), Auth0.Management.ResourceServers.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.ResourceServer.t(), response_body()} | error()
Update a resource server.
see
https://auth0.com/docs/api/management/v2/#!/Resource_Servers/get_resource_servers_by_id
Specs
update_role(id(), Auth0.Management.Roles.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.Role.t(), response_body()} | error()
Update a role.
see
https://auth0.com/docs/api/management/v2/#!/Roles/patch_roles_by_id
Specs
update_rule(id(), Auth0.Management.Rules.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.Rule.t(), response_body()} | error()
Update a rule.
see
https://auth0.com/docs/api/management/v2/#!/Rules/patch_rules_by_id
Specs
update_tenant_setting( Auth0.Management.Tenants.Settings.Patch.Params.t(), config() ) :: {:ok, Auth0.Entity.TenantSetting.t(), response_body()} | error()
Update tenant settings.
see
https://auth0.com/docs/api/management/v2/#!/Tenants/patch_settings
Specs
update_user(id(), Auth0.Management.Users.Patch.Params.t(), config()) :: {:ok, Auth0.Entity.User.t(), response_body()} | error()
Update a User.
see
https://auth0.com/docs/api/management/v2/#!/Users/patch_users_by_id
Specs
verify_custom_domain(id(), config()) :: {:ok, Auth0.Entity.CustomDomain.t(), response_body()} | error()
Verify a custom domain.
see
https://auth0.com/docs/api/management/v2/#!/Custom_Domains/post_verify