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

Facade for the Auth0 Management API Risk Assessments endpoints.

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

Summary

Types

config()

error()

id()

Functions

create(params, config)

Create a risk assessment.

get(id, config)

Retrieve a risk assessment by its ID.

get_new_device_settings(config)

Get new device assessor.

get_settings(config)

Get risk assessment settings.

update_new_device_settings(params, config)

Update new device assessor.

update_settings(params, config)

Update risk assessment settings.

Types

config()

@type config() :: Auth0.Config.t()

error()

@type error() :: {:error, integer(), term()} | {:error, term()}

id()

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

Functions

create(params, config)

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

Create a risk assessment.

Deprecated: POST /api/v2/risk-assessments / GET /api/v2/risk-assessments/{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/risk-assessments/post-risk-assessments

get(id, config)

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

Retrieve a risk assessment by its ID.

Deprecated: POST /api/v2/risk-assessments / GET /api/v2/risk-assessments/{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/risk-assessments/get-risk-assessments-by-id

get_new_device_settings(config)

@spec get_new_device_settings(config()) :: {:ok, map()} | error()

Get new device assessor.

Gets the risk assessment settings for the new device assessor

see

https://auth0.com/docs/api/management/v2/risk-assessments/get-new-device

get_settings(config)

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

Get risk assessment settings.

Gets the tenant settings for risk assessments

see

https://auth0.com/docs/api/management/v2/risk-assessments/get-risk-assessments-settings

update_new_device_settings(params, config)

@spec update_new_device_settings(map(), config()) :: {:ok, map()} | error()

Update new device assessor.

Updates the risk assessment settings for the new device assessor

see

https://auth0.com/docs/api/management/v2/risk-assessments/patch-new-device

update_settings(params, config)

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

Update risk assessment settings.

Updates the tenant settings for risk assessments

see

https://auth0.com/docs/api/management/v2/risk-assessments/patch-risk-assessments-settings