View Source Auth0.Management.SupplementalSignals (Auth0Api v2.5.1)

Facade for the Auth0 Management API Supplemental Signals endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Types

config()
error()
id()

Functions

create(params, config)

Create a supplemental signal.

get(id, config)

Retrieve a supplemental signal by its ID.

get_settings(config)

Get the supplemental signals configuration for a tenant.

update_settings(params, config)

Update the supplemental signals configuration for a tenant.

Types

Link to this type

config()

View Source 
@type config() :: Auth0.Config.t()
Link to this type

error()

View Source 
@type error() :: {:error, integer(), term()} | {:error, term()}
Link to this type

id()

View Source 
@type id() :: String.t()

Functions

Link to this function

create(params, config)

View Source 
@spec create(map(), config()) :: {:ok, map()} | error()

Create a supplemental signal.

Deprecated: POST /api/v2/supplemental-signals / GET /api/v2/supplemental-signals/{id} are not part of the Auth0 Management API v2 specification. Use get_settings/1 / update_settings/2 instead.

see

https://auth0.com/docs/api/management/v2/supplemental-signals/post-supplemental-signals

Link to this function

get(id, config)

View Source 
@spec get(id(), config()) :: {:ok, map()} | error()

Retrieve a supplemental signal by its ID.

Deprecated: POST /api/v2/supplemental-signals / GET /api/v2/supplemental-signals/{id} are not part of the Auth0 Management API v2 specification. Use get_settings/1 / update_settings/2 instead.

see

https://auth0.com/docs/api/management/v2/supplemental-signals/get-supplemental-signals-by-id

Link to this function

get_settings(config)

View Source 
@spec get_settings(config()) :: {:ok, map()} | error()

Get the supplemental signals configuration for a tenant.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/supplemental-signals/get-supplemental-signals

Link to this function

update_settings(params, config)

View Source 
@spec update_settings(map(), config()) :: {:ok, map()} | error()

Update the supplemental signals configuration for a tenant.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/supplemental-signals/patch-supplemental-signals