GuardianInterface
in
Interface GuardianInterface.
Table of Contents
- 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.
Methods
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.)
Tags
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.)
Tags
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.)