Skip to content

Latest commit

 

History

History
71 lines (54 loc) · 1.27 KB

README.md

File metadata and controls

71 lines (54 loc) · 1.27 KB

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, "~> 1.4.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
  1. Call Management API.

simple version

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

structured version

params = %Auth0.Management.Users.List.Params{
  include_totals: true
}
Auth0.Management.get_users(params, config)
# or
Auth0.Management.Users.list(params, config)

raw version

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

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