docs/classes/management.SDK.AuthenticationMethodsClient.html
listcreatesetdeleteAllgetdeleteupdate
new AuthenticationMethodsClient(
options: BaseClientOptions,
): AuthenticationMethodsClient
list(
id: string,
request?: ListUserAuthenticationMethodsRequestParameters,
requestOptions?: AuthenticationMethodsClient.RequestOptions,
): Promise<
Page<
UserAuthenticationMethod,
ListUserAuthenticationMethodsOffsetPaginatedResponseContent,
>,
>
Retrieve detailed list of authentication methods associated with a specified user.
The ID of the user in question.
OptionalrequestOptions: AuthenticationMethodsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.authenticationMethods.list("id", { page: 1, per_page: 1, include_totals: true })Copy
create(
id: string,
request: CreateUserAuthenticationMethodRequestContent,
requestOptions?: AuthenticationMethodsClient.RequestOptions,
): HttpResponsePromise<CreateUserAuthenticationMethodResponseContent>
Create an authentication method. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.
The ID of the user to whom the new authentication method will be assigned.
OptionalrequestOptions: AuthenticationMethodsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.authenticationMethods.create("id", { type: "phone" })Copy
set(
id: string,
request: SetUserAuthenticationMethodsRequestContent,
requestOptions?: AuthenticationMethodsClient.RequestOptions,
): HttpResponsePromise<SetUserAuthenticationMethodResponseContent[]>
Replace the specified user authentication methods with supplied values.
<b>Note</b>: Authentication methods supplied through this action do not iterate on existing methods. Instead, any methods passed will overwrite the user’s existing settings.
The ID of the user in question.
OptionalrequestOptions: AuthenticationMethodsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.authenticationMethods.set("id", [{ type: "phone" }])Copy
deleteAll(
id: string,
requestOptions?: AuthenticationMethodsClient.RequestOptions,
): HttpResponsePromise<void>
Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action cannot be undone.
The ID of the user in question.
OptionalrequestOptions: AuthenticationMethodsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.authenticationMethods.deleteAll("id")Copy
get(
id: string,
authentication_method_id: string,
requestOptions?: AuthenticationMethodsClient.RequestOptions,
): HttpResponsePromise<GetUserAuthenticationMethodResponseContent>
The ID of the user in question.
The ID of the authentication methods in question.
OptionalrequestOptions: AuthenticationMethodsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.authenticationMethods.get("id", "authentication_method_id")Copy
delete(
id: string,
authentication_method_id: string,
requestOptions?: AuthenticationMethodsClient.RequestOptions,
): HttpResponsePromise<void>
Remove the authentication method with the given ID from the specified user. For more information, review Manage Authentication Methods with Management API.
The ID of the user in question.
The ID of the authentication method to delete.
OptionalrequestOptions: AuthenticationMethodsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.authenticationMethods.delete("id", "authentication_method_id")Copy
update(
id: string,
authentication_method_id: string,
request?: UpdateUserAuthenticationMethodRequestContent,
requestOptions?: AuthenticationMethodsClient.RequestOptions,
): HttpResponsePromise<UpdateUserAuthenticationMethodResponseContent>
Modify the authentication method with the given ID from the specified user. For more information, review Manage Authentication Methods with Management API.
The ID of the user in question.
The ID of the authentication method to update.
OptionalrequestOptions: AuthenticationMethodsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.users.authenticationMethods.update("id", "authentication_method_id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listcreatesetdeleteAllgetdeleteupdate Properties _options