Guardian
extends ManagementEndpoint
in package
implements
GuardianInterface
Class Guardian.
Handles requests to the Guardian endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- GuardianInterface
- Interface GuardianInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- deleteEnrollment() : ResponseInterface
- Delete an enrollment to allow the user to enroll with multi-factor authentication again.
- getEnrollment() : ResponseInterface
- Retrieve an enrollment (including its status and type).
- getFactors() : ResponseInterface
- Retrieve all multi-factor authentication configurations.
- getHttpClient() : HttpClient
- Get the injected HttpClient instance.
- getLastRequest() : HttpRequest|null
- Return an instance of HttpRequest representing the last issued request.
- getResponsePaginator() : HttpResponsePaginator
- Return a ResponsePaginator instance configured for the last HttpRequest.
- instance() : static
Properties
$httpClient
private
HttpClient
$httpClient
Methods
__construct()
ManagementEndpoint constructor.
public
final __construct(HttpClient $httpClient) : mixed
Parameters
- $httpClient : HttpClient
-
httpClient instance to use
Return values
mixed —deleteEnrollment()
Delete an enrollment to allow the user to enroll with multi-factor authentication again.
public
deleteEnrollment(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: delete:guardian_enrollments.
Parameters
- $id : string
-
enrollment (by it's ID) to be deleted
- $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.)
Return values
ResponseInterface —getEnrollment()
Retrieve an enrollment (including its status and type).
public
getEnrollment(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:guardian_enrollments.
Parameters
- $id : string
-
enrollment (by it's ID) to query
- $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.)
Return values
ResponseInterface —getFactors()
Retrieve all multi-factor authentication configurations.
public
getFactors([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:guardian_factors.
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.)
Return values
ResponseInterface —getHttpClient()
Get the injected HttpClient instance.
public
final getHttpClient() : HttpClient
Return values
HttpClient —getLastRequest()
Return an instance of HttpRequest representing the last issued request.
public
final getLastRequest() : HttpRequest|null
Return values
HttpRequest|null —getResponsePaginator()
Return a ResponsePaginator instance configured for the last HttpRequest.
public
final getResponsePaginator() : HttpResponsePaginator
Return values
HttpResponsePaginator —instance()
public
static instance(HttpClient $httpClient) : static
Parameters
- $httpClient : HttpClient