Auth0Client.Management.Tenant (auth0_client v1.1.0)

Copy Markdown View Source

A module representing tenant settings on Auth0.

These are the settings that apply to the whole tenant rather than to one application — the friendly name and logo, the default audience and directory, session lifetimes, and the hosted error and password-change pages.

https://auth0.com/docs/api/management/v2/tenants

Summary

Functions

Gets the tenant's settings.

Updates the tenant's settings.

Functions

settings(params \\ %{})

Gets the tenant's settings.

Narrow the response with fields and include_fields.

iex> Auth0Client.Management.Tenant.settings()
iex> Auth0Client.Management.Tenant.settings(fields: "friendly_name,support_email")

update_settings(body)

Updates the tenant's settings.

This changes behaviour for every application in the tenant

default_audience, default_directory, flags and the hosted pages affect every login immediately. Read settings/0 first and keep the result, so a change can be put back.

Only the keys you send are changed; the rest are left alone.

iex> Auth0Client.Management.Tenant.update_settings(%{friendly_name: "Acme"})
iex> Auth0Client.Management.Tenant.update_settings(%{support_email: "help@example.com"})