Auth0Api v1.4.0

Auth0.Management.Tenants (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of Tenants.

endpoint

  • /api/v2/tenants/settings

Link to this section Summary

Types

config()
error()
response_body()

Functions

get_setting(params, config)

Get tenant settings.

update_setting(params, config)

Update tenant settings.

Link to this section Types

Link to this type

config()

View Source

Specs

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

error()

View Source

Specs

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

response_body()

View Source

Specs

response_body() :: String.t()

Link to this section Functions

Link to this function

get_setting(params, config)

View Source

Specs

get_setting(Auth0.Management.Tenants.Settings.Get.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.TenantSetting.t(), response_body()} | error()

Get tenant settings.

see

https://auth0.com/docs/api/management/v2/#!/Tenants/tenant_settings_route

Link to this function

update_setting(params, config)

View Source

Specs

update_setting(
  Auth0.Management.Tenants.Settings.Patch.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.TenantSetting.t(), response_body()} | error()

Update tenant settings.

see

https://auth0.com/docs/api/management/v2/#!/Tenants/patch_settings