Class GuardianClient

Index

Accessors

enrollments factors policies

Constructors

Methods

Properties

_options _enrollments _factors _policies

Accessors

enrollments

get enrollments(): EnrollmentsClient

Returns EnrollmentsClient

factors

get factors(): FactorsClient

Returns FactorsClient

policies

get policies(): PoliciesClient

Returns PoliciesClient

Constructors

constructor

new GuardianClient(options: BaseClientOptions): GuardianClient
Parameters
- options: BaseClientOptions
Returns GuardianClient

Methods

get

get(
requestOptions?: GuardianClient.RequestOptions,
): HttpResponsePromise<GetGuardianSettingsResponseContent>
TODO: Link this endpoint to relevant documentation when available.
Parameters
- OptionalrequestOptions: GuardianClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianSettingsResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.guardian.get()
```

set

set(
request: SetGuardianSettingsRequestContent,
requestOptions?: GuardianClient.RequestOptions,
): HttpResponsePromise<SetGuardianSettingsResponseContent>
Update a tenant's guardian settings such as Remember Me
Parameters
- request: SetGuardianSettingsRequestContent
- OptionalrequestOptions: GuardianClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetGuardianSettingsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.guardian.set({
        display_remember_me_checkbox: true,
        remember_me_default_value: true,
        mfa_session_inactivity_timeout: 1,
        mfa_session_overall_timeout: 1
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_enrollments

_enrollments: EnrollmentsClient | undefined

`Protected`_factors

_factors: FactorsClient | undefined

`Protected`_policies

_policies: PoliciesClient | undefined