Auth0-PHP

Management
in package
implements ManagementInterface

Class Management.

Interfaces, Classes, Traits and Enums

ManagementInterface
Interface ManagementInterface.

Table of Contents

$configuration  : SdkConfiguration|array<string|int, mixed>
$httpClient  : HttpClient|null
Instance of Auth0\SDK\API\Utility\HttpClient.
$validatedConfiguration  : SdkConfiguration|null
Instance of SdkConfiguration, for shared configuration across classes.
__construct()  : mixed
Management constructor.
actions()  : ActionsInterface
attackProtection()  : AttackProtectionInterface
blacklists()  : BlacklistsInterface
clientGrants()  : ClientGrantsInterface
clients()  : ClientsInterface
connections()  : ConnectionsInterface
deviceCredentials()  : DeviceCredentialsInterface
emails()  : EmailsInterface
emailTemplates()  : EmailTemplatesInterface
getConfiguration()  : SdkConfiguration
getHttpClient()  : HttpClient
Return the HttpClient instance being used for management API requests.
getLastRequest()  : HttpRequest|null
Return an instance of HttpRequest representing the last issued request.
getResponsePaginator()  : HttpResponsePaginator
Return a ResponsePaginator instance configured for the last HttpRequest.
grants()  : GrantsInterface
guardian()  : GuardianInterface
jobs()  : JobsInterface
logs()  : LogsInterface
logStreams()  : LogStreamsInterface
organizations()  : OrganizationsInterface
resourceServers()  : ResourceServersInterface
roles()  : RolesInterface
rules()  : RulesInterface
stats()  : StatsInterface
tenants()  : TenantsInterface
tickets()  : TicketsInterface
userBlocks()  : UserBlocksInterface
users()  : UsersInterface
usersByEmail()  : UsersByEmailInterface

Properties

$httpClient

Instance of Auth0\SDK\API\Utility\HttpClient.

private HttpClient|null $httpClient = null

$validatedConfiguration

Instance of SdkConfiguration, for shared configuration across classes.

private SdkConfiguration|null $validatedConfiguration = null

Methods

__construct()

Management constructor.

public __construct(array<string|int, mixed>|SdkConfiguration $configuration) : mixed
Parameters
$configuration : array<string|int, mixed>|SdkConfiguration

Required. Base configuration options for the SDK. See the SdkConfiguration class constructor for options.

Tags
throws
ConfigurationException

when an invalidation configuration is provided

psalm-suppress

DocblockTypeContradiction

Return values
mixed

getHttpClient()

Return the HttpClient instance being used for management API requests.

public getHttpClient([Authentication|null $authentication = null ]) : HttpClient
Parameters
$authentication : Authentication|null = null

Optional. An Instance of Authentication for use during client credential exchange. One will be created, when necessary, if not provided.

Return values
HttpClient

getLastRequest()

Return an instance of HttpRequest representing the last issued request.

public getLastRequest() : HttpRequest|null
Return values
HttpRequest|null

Search results