Auth0-PHP

TenantsInterface
in

Interface TenantsInterface.

Table of Contents

getSettings()  : ResponseInterface
Return all tenant settings.
updateSettings()  : ResponseInterface
Update tenant settings.

Methods

getSettings()

Return all tenant settings.

public getSettings([RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:tenant_settings.

Parameters
$options : RequestOptions|null = null

Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)

Tags
throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Tenants/tenant_settings_route
Return values
ResponseInterface

updateSettings()

Update tenant settings.

public updateSettings(array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: update:tenant_settings.

Parameters
$body : array<string|int, mixed>

Updated settings to send to the API. See @see for supported options.

$options : RequestOptions|null = null

Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)

Tags
throws
ArgumentException

when an invalid body is provided

throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Tenants/patch_settings
Return values
ResponseInterface

Search results