Auth0.Config (Auth0Api v1.4.0) View Source

Documentation for Auth0 Configuration.

properties

  • :domain - Auth0 domain
  • :api_token - API token
  • :client_id - Client ID. This value is ignored when API token is provided.
  • :client_secret - Client Secret. This value is ignored when API token is3 provided.
  • :max_request_retry_count - Max retry count of request when rate limit is exceeded.
  • :correlation_id - Correlation ID
  • :token_cache_disabled - disable token cache
  • :clear_token_cache - clear token cache

available environment

  • AUTH0_DOMAIN - This value is used when %Config{domain: nil}.
  • AUTH0_API_TOKEN - This value is used when %Config{api_token: nil}.
  • AUTH0_CLIENT_ID - This value is used when %Config{client_id: nil}.
  • AUTH0_CLIENT_SECRET - This value is used when %Config{client_secret: nil}.
  • AUTH0_MAX_REQUEST_RETRY_COUNT - This value is used when %Config{max_request_retry_count: nil}.

Link to this section Summary

Functions

get API token.

get Client ID..

get Client Secret.

get Auth0 domain.

get max retry count of request.

Link to this section Types

Specs

config() :: t()

Specs

t() :: %Auth0.Config{
  api_token: String.t(),
  clear_token_cache: boolean(),
  client_id: String.t(),
  client_secret: String.t(),
  correlation_id: String.t(),
  domain: String.t(),
  max_request_retry_count: integer(),
  token_cache_disabled: boolean()
}

Link to this section Functions

Specs

get_api_token(config()) :: String.t() | nil

get API token.

Specs

get_client_id(config()) :: String.t() | nil

get Client ID..

Link to this function

get_client_secret(config)

View Source

Specs

get_client_secret(config()) :: String.t() | nil

get Client Secret.

Specs

get_domain(config()) :: String.t() | nil

get Auth0 domain.

Link to this function

get_max_request_retry_count(config)

View Source

Specs

get_max_request_retry_count(config()) :: integer()

get max retry count of request.