View Source Auth0Api

Management API for Auth0

Installation

The package can be installed by adding auth0_api to your list of dependencies in mix.exs:

def deps do
  [
    {:auth0_api, "~> 2.2.0"}
  ]
end

Basic Usage

1. Set Domain, Client ID and Client Secret:

config = %Auth0.Config{
  domain: "xxx.auth0.com",
  client_id: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  client_secret: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
# or API Token instead
config = %Auth0.Config{
  domain: "xxx.auth0.com",
  api_token: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

or You can use environment variable with keys below:

• AUTH0_DOMAIN
• AUTH0_CLIENT_ID
• AUTH0_CLIENT_SECRET
• AUTH0_API_TOKEN

2. Call Management API.

Normal Usage

params = %{
  include_totals: true
}
Auth0.Api.Management.get_users(params, config)

Raw Usage

body = %{}
headers = %{}
Auth0.Common.Management.Http.raw_request(:get, "/api/v2/users?include_totals=true", body, headers, config)

Rate Limiting

The library handles Auth0's rate limiting automatically. When a 429 Too Many Requests response is received, it checks the Retry-After header and waits for the specified duration before retrying. If the header is missing, it falls back to an exponential backoff strategy.

Deprecations

• Rules & Hooks: Auth0 has announced the End-of-Life for Rules and Hooks. These modules (Auth0.Management.Rules, Auth0.Management.Hooks) are now marked as deprecated. Please migrate to Auth0 Actions.

Release Notes

2.3.0

• ✨ Support Retry-After header for rate limiting
• ✨ Add Bot Detection Management endpoints
• ✨ Add Prompts Rendering & Partials endpoints
• ✨ Add Session Update endpoint
• ✨ Add Client Secret Rotation endpoint
• ✨ Add Connection Status endpoint
• ✨ Add Connection Profiles management endpoints
• ✨ Add Event Streams management endpoints
• ✨ Add Network ACLs management endpoints
• ✨ Add User Attribute Profiles management endpoints
• ✨ Add Token Exchange Profiles management endpoints
• ✨ Add Verifiable Credentials management endpoints
• ✨ Add Risk Assessments management endpoints
• ✨ Add Supplemental Signals management endpoints
• ⚠️ Deprecate Rules and Hooks APIs

2.2.0

• ✨ create api for forms
• ✨ create api for flows
• ✨ create api for self service profiles
• ✨ add api for keys
• ✨ add api for users
• ✨ add api for sessions
• 📝 fix doc comment

2.1.0

• ✨ add api for branding
• ✨ add api for connection
• ✨ add api for guardian
• ✨ add api for prompts
• ✨ add api for users
• 🐛 fix spec type
• ♻️ move guardian module path
• 🗑️ remove deprecated api
• 💥 not to use Params struct and move endpoint consistent
• 📝 mix docs for each module
• 💡 update api comment
• ⬆️ upgrade ex_doc

The docs can be found at https://hexdocs.pm/auth0_api.