Class SecurityService

Index

Constructors

constructor

Methods

getSecurityConfiguration postSecurityForgotPassword postSecurityForgotPasswordReset postSecurityForgotPasswordVerify

Constructors

constructor

new SecurityService(): SecurityService
Returns SecurityService

Methods

`Static`getSecurityConfiguration

getSecurityConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetSecurityConfigurationData, ThrowOnError, unknown>,
): RequestResult<
    GetSecurityConfigurationResponses,
    GetSecurityConfigurationErrors,
    ThrowOnError,
    "fields",
>
Gets the security configuration.

Gets the configuration settings for security.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetSecurityConfigurationData, ThrowOnError, unknown>
Returns RequestResult<
    GetSecurityConfigurationResponses,
    GetSecurityConfigurationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5645

`Static`postSecurityForgotPassword

postSecurityForgotPassword<ThrowOnError extends boolean = true>(
    options: Options<PostSecurityForgotPasswordData, ThrowOnError>,
): RequestResult<
    PostSecurityForgotPasswordResponses,
    PostSecurityForgotPasswordErrors,
    ThrowOnError,
    "fields",
>
Requests a password reset.

Initiates a password reset process by sending a reset link to the specified email address.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostSecurityForgotPasswordData, ThrowOnError>
Returns RequestResult<
    PostSecurityForgotPasswordResponses,
    PostSecurityForgotPasswordErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5658

`Static`postSecurityForgotPasswordReset

postSecurityForgotPasswordReset<ThrowOnError extends boolean = true>(
    options: Options<PostSecurityForgotPasswordResetData, ThrowOnError>,
): RequestResult<
    PostSecurityForgotPasswordResetResponses,
    PostSecurityForgotPasswordResetErrors,
    ThrowOnError,
    "fields",
>
Initiates password reset.

Initiates a password reset process for the user with the provided email.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostSecurityForgotPasswordResetData, ThrowOnError>
Returns RequestResult<
    PostSecurityForgotPasswordResetResponses,
    PostSecurityForgotPasswordResetErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5675

`Static`postSecurityForgotPasswordVerify

postSecurityForgotPasswordVerify<ThrowOnError extends boolean = true>(
    options: Options<PostSecurityForgotPasswordVerifyData, ThrowOnError>,
): RequestResult<
    PostSecurityForgotPasswordVerifyResponses,
    PostSecurityForgotPasswordVerifyErrors,
    ThrowOnError,
    "fields",
>
Verifies a password reset token.

Verifies the provided password reset token for the specified user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostSecurityForgotPasswordVerifyData, ThrowOnError>
Returns RequestResult<
    PostSecurityForgotPasswordVerifyResponses,
    PostSecurityForgotPasswordVerifyErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5692

Class SecurityService

Index

Constructors

Methods

Constructors

constructor

Returns SecurityService

Methods

`Static`getSecurityConfiguration

Type Parameters

Parameters

Returns RequestResult<
    GetSecurityConfigurationResponses,
    GetSecurityConfigurationErrors,
    ThrowOnError,
    "fields",
>

`Static`postSecurityForgotPassword

Type Parameters

Parameters

Returns RequestResult<
    PostSecurityForgotPasswordResponses,
    PostSecurityForgotPasswordErrors,
    ThrowOnError,
    "fields",
>

`Static`postSecurityForgotPasswordReset

Type Parameters

Parameters

Returns RequestResult<
    PostSecurityForgotPasswordResetResponses,
    PostSecurityForgotPasswordResetErrors,
    ThrowOnError,
    "fields",
>

`Static`postSecurityForgotPasswordVerify

Type Parameters

Parameters

Returns RequestResult<
    PostSecurityForgotPasswordVerifyResponses,
    PostSecurityForgotPasswordVerifyErrors,
    ThrowOnError,
    "fields",
>

Settings

On This Page

Class SecurityService

Index

Constructors

Methods

Constructors

constructor

Returns SecurityService

Methods

StaticgetSecurityConfiguration

Type Parameters

Parameters

Returns RequestResult< GetSecurityConfigurationResponses, GetSecurityConfigurationErrors, ThrowOnError, "fields",>

StaticpostSecurityForgotPassword

Type Parameters

Parameters

Returns RequestResult< PostSecurityForgotPasswordResponses, PostSecurityForgotPasswordErrors, ThrowOnError, "fields",>

StaticpostSecurityForgotPasswordReset

Type Parameters

Parameters

Returns RequestResult< PostSecurityForgotPasswordResetResponses, PostSecurityForgotPasswordResetErrors, ThrowOnError, "fields",>

StaticpostSecurityForgotPasswordVerify

Type Parameters

Parameters

Returns RequestResult< PostSecurityForgotPasswordVerifyResponses, PostSecurityForgotPasswordVerifyErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`getSecurityConfiguration

Returns RequestResult<
GetSecurityConfigurationResponses,
GetSecurityConfigurationErrors,
ThrowOnError,
"fields",
>

`Static`postSecurityForgotPassword

Returns RequestResult<
PostSecurityForgotPasswordResponses,
PostSecurityForgotPasswordErrors,
ThrowOnError,
"fields",
>

`Static`postSecurityForgotPasswordReset

Returns RequestResult<
PostSecurityForgotPasswordResetResponses,
PostSecurityForgotPasswordResetErrors,
ThrowOnError,
"fields",
>

`Static`postSecurityForgotPasswordVerify

Returns RequestResult<
PostSecurityForgotPasswordVerifyResponses,
PostSecurityForgotPasswordVerifyErrors,
ThrowOnError,
"fields",
>