@zitadel/sdk 4.1.0-beta.10

package/dist/apis/user-service-api.d.ts

@@ -0,0 +1,770 @@
+/**
+ * Zitadel SDK
+ * The Zitadel SDK is a convenience wrapper around the Zitadel APIs to assist you in integrating with your Zitadel environment. This SDK enables you to handle resources, settings, and configurations within the Zitadel platform.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import type { UserServiceAddHumanUserRequest, UserServiceAddHumanUserResponse, UserServiceAddIDPLinkRequest, UserServiceAddIDPLinkResponse, UserServiceAddKeyRequest, UserServiceAddKeyResponse, UserServiceAddOTPEmailRequest, UserServiceAddOTPEmailResponse, UserServiceAddOTPSMSRequest, UserServiceAddOTPSMSResponse, UserServiceAddPersonalAccessTokenRequest, UserServiceAddPersonalAccessTokenResponse, UserServiceAddSecretRequest, UserServiceAddSecretResponse, UserServiceCreateInviteCodeRequest, UserServiceCreateInviteCodeResponse, UserServiceCreatePasskeyRegistrationLinkRequest, UserServiceCreatePasskeyRegistrationLinkResponse, UserServiceCreateUserRequest, UserServiceCreateUserResponse, UserServiceDeactivateUserRequest, UserServiceDeactivateUserResponse, UserServiceDeleteUserMetadataRequest, UserServiceDeleteUserMetadataResponse, UserServiceDeleteUserRequest, UserServiceDeleteUserResponse, UserServiceGetUserByIDRequest, UserServiceGetUserByIDResponse, UserServiceHumanMFAInitSkippedRequest, UserServiceHumanMFAInitSkippedResponse, UserServiceListAuthenticationFactorsRequest, UserServiceListAuthenticationFactorsResponse, UserServiceListAuthenticationMethodTypesRequest, UserServiceListAuthenticationMethodTypesResponse, UserServiceListIDPLinksRequest, UserServiceListIDPLinksResponse, UserServiceListKeysRequest, UserServiceListKeysResponse, UserServiceListPasskeysRequest, UserServiceListPasskeysResponse, UserServiceListPersonalAccessTokensRequest, UserServiceListPersonalAccessTokensResponse, UserServiceListUserMetadataRequest, UserServiceListUserMetadataResponse, UserServiceListUsersRequest, UserServiceListUsersResponse, UserServiceLockUserRequest, UserServiceLockUserResponse, UserServicePasswordResetRequest, UserServicePasswordResetResponse, UserServiceReactivateUserRequest, UserServiceReactivateUserResponse, UserServiceRegisterPasskeyRequest, UserServiceRegisterPasskeyResponse, UserServiceRegisterTOTPRequest, UserServiceRegisterTOTPResponse, UserServiceRegisterU2FRequest, UserServiceRegisterU2FResponse, UserServiceRemoveIDPLinkRequest, UserServiceRemoveIDPLinkResponse, UserServiceRemoveKeyRequest, UserServiceRemoveKeyResponse, UserServiceRemoveOTPEmailRequest, UserServiceRemoveOTPEmailResponse, UserServiceRemoveOTPSMSRequest, UserServiceRemoveOTPSMSResponse, UserServiceRemovePasskeyRequest, UserServiceRemovePasskeyResponse, UserServiceRemovePersonalAccessTokenRequest, UserServiceRemovePersonalAccessTokenResponse, UserServiceRemovePhoneRequest, UserServiceRemovePhoneResponse, UserServiceRemoveSecretRequest, UserServiceRemoveSecretResponse, UserServiceRemoveTOTPRequest, UserServiceRemoveTOTPResponse, UserServiceRemoveU2FRequest, UserServiceRemoveU2FResponse, UserServiceResendEmailCodeRequest, UserServiceResendEmailCodeResponse, UserServiceResendInviteCodeRequest, UserServiceResendInviteCodeResponse, UserServiceResendPhoneCodeRequest, UserServiceResendPhoneCodeResponse, UserServiceRetrieveIdentityProviderIntentRequest, UserServiceRetrieveIdentityProviderIntentResponse, UserServiceSendEmailCodeRequest, UserServiceSendEmailCodeResponse, UserServiceSetEmailRequest, UserServiceSetEmailResponse, UserServiceSetPasswordRequest, UserServiceSetPasswordResponse, UserServiceSetPhoneRequest, UserServiceSetPhoneResponse, UserServiceSetUserMetadataRequest, UserServiceSetUserMetadataResponse, UserServiceStartIdentityProviderIntentRequest, UserServiceStartIdentityProviderIntentResponse, UserServiceUnlockUserRequest, UserServiceUnlockUserResponse, UserServiceUpdateHumanUserRequest, UserServiceUpdateHumanUserResponse, UserServiceUpdateUserRequest, UserServiceUpdateUserResponse, UserServiceVerifyEmailRequest, UserServiceVerifyEmailResponse, UserServiceVerifyInviteCodeRequest, UserServiceVerifyInviteCodeResponse, UserServiceVerifyPasskeyRegistrationRequest, UserServiceVerifyPasskeyRegistrationResponse, UserServiceVerifyPhoneRequest, UserServiceVerifyPhoneResponse, UserServiceVerifyTOTPRegistrationRequest, UserServiceVerifyTOTPRegistrationResponse, UserServiceVerifyU2FRegistrationRequest, UserServiceVerifyU2FRegistrationResponse } from '../models/index.js';
+export interface UserServiceApiAddHumanUserRequest {
+    userServiceAddHumanUserRequest: UserServiceAddHumanUserRequest;
+}
+export interface UserServiceApiAddIDPLinkRequest {
+    userServiceAddIDPLinkRequest: UserServiceAddIDPLinkRequest;
+}
+export interface UserServiceApiAddKeyRequest {
+    userServiceAddKeyRequest: UserServiceAddKeyRequest;
+}
+export interface UserServiceApiAddOTPEmailRequest {
+    userServiceAddOTPEmailRequest: UserServiceAddOTPEmailRequest;
+}
+export interface UserServiceApiAddOTPSMSRequest {
+    userServiceAddOTPSMSRequest: UserServiceAddOTPSMSRequest;
+}
+export interface UserServiceApiAddPersonalAccessTokenRequest {
+    userServiceAddPersonalAccessTokenRequest: UserServiceAddPersonalAccessTokenRequest;
+}
+export interface UserServiceApiAddSecretRequest {
+    userServiceAddSecretRequest: UserServiceAddSecretRequest;
+}
+export interface UserServiceApiCreateInviteCodeRequest {
+    userServiceCreateInviteCodeRequest: UserServiceCreateInviteCodeRequest;
+}
+export interface UserServiceApiCreatePasskeyRegistrationLinkRequest {
+    userServiceCreatePasskeyRegistrationLinkRequest: UserServiceCreatePasskeyRegistrationLinkRequest;
+}
+export interface UserServiceApiCreateUserRequest {
+    userServiceCreateUserRequest: UserServiceCreateUserRequest;
+}
+export interface UserServiceApiDeactivateUserRequest {
+    userServiceDeactivateUserRequest: UserServiceDeactivateUserRequest;
+}
+export interface UserServiceApiDeleteUserRequest {
+    userServiceDeleteUserRequest: UserServiceDeleteUserRequest;
+}
+export interface UserServiceApiDeleteUserMetadataRequest {
+    userServiceDeleteUserMetadataRequest: UserServiceDeleteUserMetadataRequest;
+}
+export interface UserServiceApiGetUserByIDRequest {
+    userServiceGetUserByIDRequest: UserServiceGetUserByIDRequest;
+}
+export interface UserServiceApiHumanMFAInitSkippedRequest {
+    userServiceHumanMFAInitSkippedRequest: UserServiceHumanMFAInitSkippedRequest;
+}
+export interface UserServiceApiListAuthenticationFactorsRequest {
+    userServiceListAuthenticationFactorsRequest: UserServiceListAuthenticationFactorsRequest;
+}
+export interface UserServiceApiListAuthenticationMethodTypesRequest {
+    userServiceListAuthenticationMethodTypesRequest: UserServiceListAuthenticationMethodTypesRequest;
+}
+export interface UserServiceApiListIDPLinksRequest {
+    userServiceListIDPLinksRequest: UserServiceListIDPLinksRequest;
+}
+export interface UserServiceApiListKeysRequest {
+    userServiceListKeysRequest: UserServiceListKeysRequest;
+}
+export interface UserServiceApiListPasskeysRequest {
+    userServiceListPasskeysRequest: UserServiceListPasskeysRequest;
+}
+export interface UserServiceApiListPersonalAccessTokensRequest {
+    userServiceListPersonalAccessTokensRequest: UserServiceListPersonalAccessTokensRequest;
+}
+export interface UserServiceApiListUserMetadataRequest {
+    userServiceListUserMetadataRequest: UserServiceListUserMetadataRequest;
+}
+export interface UserServiceApiListUsersRequest {
+    userServiceListUsersRequest: UserServiceListUsersRequest;
+}
+export interface UserServiceApiLockUserRequest {
+    userServiceLockUserRequest: UserServiceLockUserRequest;
+}
+export interface UserServiceApiPasswordResetRequest {
+    userServicePasswordResetRequest: UserServicePasswordResetRequest;
+}
+export interface UserServiceApiReactivateUserRequest {
+    userServiceReactivateUserRequest: UserServiceReactivateUserRequest;
+}
+export interface UserServiceApiRegisterPasskeyRequest {
+    userServiceRegisterPasskeyRequest: UserServiceRegisterPasskeyRequest;
+}
+export interface UserServiceApiRegisterTOTPRequest {
+    userServiceRegisterTOTPRequest: UserServiceRegisterTOTPRequest;
+}
+export interface UserServiceApiRegisterU2FRequest {
+    userServiceRegisterU2FRequest: UserServiceRegisterU2FRequest;
+}
+export interface UserServiceApiRemoveIDPLinkRequest {
+    userServiceRemoveIDPLinkRequest: UserServiceRemoveIDPLinkRequest;
+}
+export interface UserServiceApiRemoveKeyRequest {
+    userServiceRemoveKeyRequest: UserServiceRemoveKeyRequest;
+}
+export interface UserServiceApiRemoveOTPEmailRequest {
+    userServiceRemoveOTPEmailRequest: UserServiceRemoveOTPEmailRequest;
+}
+export interface UserServiceApiRemoveOTPSMSRequest {
+    userServiceRemoveOTPSMSRequest: UserServiceRemoveOTPSMSRequest;
+}
+export interface UserServiceApiRemovePasskeyRequest {
+    userServiceRemovePasskeyRequest: UserServiceRemovePasskeyRequest;
+}
+export interface UserServiceApiRemovePersonalAccessTokenRequest {
+    userServiceRemovePersonalAccessTokenRequest: UserServiceRemovePersonalAccessTokenRequest;
+}
+export interface UserServiceApiRemovePhoneRequest {
+    userServiceRemovePhoneRequest: UserServiceRemovePhoneRequest;
+}
+export interface UserServiceApiRemoveSecretRequest {
+    userServiceRemoveSecretRequest: UserServiceRemoveSecretRequest;
+}
+export interface UserServiceApiRemoveTOTPRequest {
+    userServiceRemoveTOTPRequest: UserServiceRemoveTOTPRequest;
+}
+export interface UserServiceApiRemoveU2FRequest {
+    userServiceRemoveU2FRequest: UserServiceRemoveU2FRequest;
+}
+export interface UserServiceApiResendEmailCodeRequest {
+    userServiceResendEmailCodeRequest: UserServiceResendEmailCodeRequest;
+}
+export interface UserServiceApiResendInviteCodeRequest {
+    userServiceResendInviteCodeRequest: UserServiceResendInviteCodeRequest;
+}
+export interface UserServiceApiResendPhoneCodeRequest {
+    userServiceResendPhoneCodeRequest: UserServiceResendPhoneCodeRequest;
+}
+export interface UserServiceApiRetrieveIdentityProviderIntentRequest {
+    userServiceRetrieveIdentityProviderIntentRequest: UserServiceRetrieveIdentityProviderIntentRequest;
+}
+export interface UserServiceApiSendEmailCodeRequest {
+    userServiceSendEmailCodeRequest: UserServiceSendEmailCodeRequest;
+}
+export interface UserServiceApiSetEmailRequest {
+    userServiceSetEmailRequest: UserServiceSetEmailRequest;
+}
+export interface UserServiceApiSetPasswordRequest {
+    userServiceSetPasswordRequest: UserServiceSetPasswordRequest;
+}
+export interface UserServiceApiSetPhoneRequest {
+    userServiceSetPhoneRequest: UserServiceSetPhoneRequest;
+}
+export interface UserServiceApiSetUserMetadataRequest {
+    userServiceSetUserMetadataRequest: UserServiceSetUserMetadataRequest;
+}
+export interface UserServiceApiStartIdentityProviderIntentRequest {
+    userServiceStartIdentityProviderIntentRequest: UserServiceStartIdentityProviderIntentRequest;
+}
+export interface UserServiceApiUnlockUserRequest {
+    userServiceUnlockUserRequest: UserServiceUnlockUserRequest;
+}
+export interface UserServiceApiUpdateHumanUserRequest {
+    userServiceUpdateHumanUserRequest: UserServiceUpdateHumanUserRequest;
+}
+export interface UserServiceApiUpdateUserRequest {
+    userServiceUpdateUserRequest: UserServiceUpdateUserRequest;
+}
+export interface UserServiceApiVerifyEmailRequest {
+    userServiceVerifyEmailRequest: UserServiceVerifyEmailRequest;
+}
+export interface UserServiceApiVerifyInviteCodeRequest {
+    userServiceVerifyInviteCodeRequest: UserServiceVerifyInviteCodeRequest;
+}
+export interface UserServiceApiVerifyPasskeyRegistrationRequest {
+    userServiceVerifyPasskeyRegistrationRequest: UserServiceVerifyPasskeyRegistrationRequest;
+}
+export interface UserServiceApiVerifyPhoneRequest {
+    userServiceVerifyPhoneRequest: UserServiceVerifyPhoneRequest;
+}
+export interface UserServiceApiVerifyTOTPRegistrationRequest {
+    userServiceVerifyTOTPRegistrationRequest: UserServiceVerifyTOTPRegistrationRequest;
+}
+export interface UserServiceApiVerifyU2FRegistrationRequest {
+    userServiceVerifyU2FRegistrationRequest: UserServiceVerifyU2FRegistrationRequest;
+}
+/**
+ *
+ */
+export declare class UserServiceApi extends runtime.BaseAPI {
+    /**
+     * Deprecated: Use [CreateUser](apis/resources/user_service_v2/user-service-create-user.api.mdx) to create a new user of type human instead.   Create/import a new user with the type human. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
+     * Create a new human user
+     */
+    private addHumanUserRaw;
+    /**
+     * Deprecated: Use [CreateUser](apis/resources/user_service_v2/user-service-create-user.api.mdx) to create a new user of type human instead.   Create/import a new user with the type human. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
+     * Create a new human user
+     */
+    addHumanUser(requestParameters: UserServiceApiAddHumanUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceAddHumanUserResponse>;
+    /**
+     * Add link to an identity provider to an user..
+     * Add link to an identity provider to an user
+     */
+    private addIDPLinkRaw;
+    /**
+     * Add link to an identity provider to an user..
+     * Add link to an identity provider to an user
+     */
+    addIDPLink(requestParameters: UserServiceApiAddIDPLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceAddIDPLinkResponse>;
+    /**
+     * Add a keys that can be used to securely authenticate at the Zitadel APIs using JWT profile authentication using short-lived tokens.  Make sure you store the returned key safely, as you won\'t be able to read it from the Zitadel API anymore.  Only users of type machine can have keys.   Required permission:    - user.write
+     * Add a Key
+     */
+    private addKeyRaw;
+    /**
+     * Add a keys that can be used to securely authenticate at the Zitadel APIs using JWT profile authentication using short-lived tokens.  Make sure you store the returned key safely, as you won\'t be able to read it from the Zitadel API anymore.  Only users of type machine can have keys.   Required permission:    - user.write
+     * Add a Key
+     */
+    addKey(requestParameters: UserServiceApiAddKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceAddKeyResponse>;
+    /**
+     * Add a new One-Time Password (OTP) Email factor to the authenticated user. OTP Email will enable the user to verify a OTP with the latest verified email. The email has to be verified to add the second factor..
+     * Add OTP Email for a user
+     */
+    private addOTPEmailRaw;
+    /**
+     * Add a new One-Time Password (OTP) Email factor to the authenticated user. OTP Email will enable the user to verify a OTP with the latest verified email. The email has to be verified to add the second factor..
+     * Add OTP Email for a user
+     */
+    addOTPEmail(requestParameters: UserServiceApiAddOTPEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceAddOTPEmailResponse>;
+    /**
+     * Add a new One-Time Password (OTP) SMS factor to the authenticated user. OTP SMS will enable the user to verify a OTP with the latest verified phone number. The phone number has to be verified to add the second factor..
+     * Add OTP SMS for a user
+     */
+    private addOTPSMSRaw;
+    /**
+     * Add a new One-Time Password (OTP) SMS factor to the authenticated user. OTP SMS will enable the user to verify a OTP with the latest verified phone number. The phone number has to be verified to add the second factor..
+     * Add OTP SMS for a user
+     */
+    addOTPSMS(requestParameters: UserServiceApiAddOTPSMSRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceAddOTPSMSResponse>;
+    /**
+     * Personal access tokens (PAT) are the easiest way to authenticate to the Zitadel APIs.  Make sure you store the returned PAT safely, as you won\'t be able to read it from the Zitadel API anymore.  Only users of type machine can have personal access tokens.   Required permission:    - user.write
+     * Add a Personal Access Token
+     */
+    private addPersonalAccessTokenRaw;
+    /**
+     * Personal access tokens (PAT) are the easiest way to authenticate to the Zitadel APIs.  Make sure you store the returned PAT safely, as you won\'t be able to read it from the Zitadel API anymore.  Only users of type machine can have personal access tokens.   Required permission:    - user.write
+     * Add a Personal Access Token
+     */
+    addPersonalAccessToken(requestParameters: UserServiceApiAddPersonalAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceAddPersonalAccessTokenResponse>;
+    /**
+     * Generates a client secret for the user.  The client id is the users username.  If the user already has a secret, it is overwritten.  Only users of type machine can have a secret.   Required permission:    - user.write
+     * Add a Users Secret
+     */
+    private addSecretRaw;
+    /**
+     * Generates a client secret for the user.  The client id is the users username.  If the user already has a secret, it is overwritten.  Only users of type machine can have a secret.   Required permission:    - user.write
+     * Add a Users Secret
+     */
+    addSecret(requestParameters: UserServiceApiAddSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceAddSecretResponse>;
+    /**
+     * Create an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization\'s available methods.  If an invite code has been created previously, it\'s url template and application name will be used as defaults for the new code.  The new code will overwrite the previous one and make it invalid.  Note: It is possible to reissue a new code only when the previous code has expired, or when the user provides a wrong code three or more times during verification.
+     * Create an invite code for a user
+     */
+    private createInviteCodeRaw;
+    /**
+     * Create an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization\'s available methods.  If an invite code has been created previously, it\'s url template and application name will be used as defaults for the new code.  The new code will overwrite the previous one and make it invalid.  Note: It is possible to reissue a new code only when the previous code has expired, or when the user provides a wrong code three or more times during verification.
+     * Create an invite code for a user
+     */
+    createInviteCode(requestParameters: UserServiceApiCreateInviteCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceCreateInviteCodeResponse>;
+    /**
+     * Create a passkey registration link which includes a code and either return it or send it to the user..
+     * Create a passkey registration link for a user
+     */
+    private createPasskeyRegistrationLinkRaw;
+    /**
+     * Create a passkey registration link which includes a code and either return it or send it to the user..
+     * Create a passkey registration link for a user
+     */
+    createPasskeyRegistrationLink(requestParameters: UserServiceApiCreatePasskeyRegistrationLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceCreatePasskeyRegistrationLinkResponse>;
+    /**
+     * Create a new human or machine user in the specified organization.   Required permission:    - user.write
+     * Create a User
+     */
+    private createUserRaw;
+    /**
+     * Create a new human or machine user in the specified organization.   Required permission:    - user.write
+     * Create a User
+     */
+    createUser(requestParameters: UserServiceApiCreateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceCreateUserResponse>;
+    /**
+     * The state of the user will be changed to \'deactivated\'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state \'deactivated\'. Use deactivate user when the user should not be able to use the account anymore, but you still need access to the user data..
+     * Deactivate user
+     */
+    private deactivateUserRaw;
+    /**
+     * The state of the user will be changed to \'deactivated\'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state \'deactivated\'. Use deactivate user when the user should not be able to use the account anymore, but you still need access to the user data..
+     * Deactivate user
+     */
+    deactivateUser(requestParameters: UserServiceApiDeactivateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceDeactivateUserResponse>;
+    /**
+     * The state of the user will be changed to \'deleted\'. The user will not be able to log in anymore. Endpoints requesting this user will return an error \'User not found..
+     * Delete user
+     */
+    private deleteUserRaw;
+    /**
+     * The state of the user will be changed to \'deleted\'. The user will not be able to log in anymore. Endpoints requesting this user will return an error \'User not found..
+     * Delete user
+     */
+    deleteUser(requestParameters: UserServiceApiDeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceDeleteUserResponse>;
+    /**
+     * Delete metadata objects from an user with a specific key.   Required permission:   - `user.write`
+     * Delete User Metadata
+     */
+    private deleteUserMetadataRaw;
+    /**
+     * Delete metadata objects from an user with a specific key.   Required permission:   - `user.write`
+     * Delete User Metadata
+     */
+    deleteUserMetadata(requestParameters: UserServiceApiDeleteUserMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceDeleteUserMetadataResponse>;
+    /**
+     * Returns the full user object (human or machine) including the profile, email, etc..
+     * User by ID
+     */
+    private getUserByIDRaw;
+    /**
+     * Returns the full user object (human or machine) including the profile, email, etc..
+     * User by ID
+     */
+    getUserByID(requestParameters: UserServiceApiGetUserByIDRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceGetUserByIDResponse>;
+    /**
+     * Update the last time the user has skipped MFA initialization. The server timestamp is used.
+     * MFA Init Skipped
+     */
+    private humanMFAInitSkippedRaw;
+    /**
+     * Update the last time the user has skipped MFA initialization. The server timestamp is used.
+     * MFA Init Skipped
+     */
+    humanMFAInitSkipped(requestParameters: UserServiceApiHumanMFAInitSkippedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceHumanMFAInitSkippedResponse>;
+    /**
+     * ListAuthenticationFactors
+     */
+    private listAuthenticationFactorsRaw;
+    /**
+     * ListAuthenticationFactors
+     */
+    listAuthenticationFactors(requestParameters: UserServiceApiListAuthenticationFactorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceListAuthenticationFactorsResponse>;
+    /**
+     * List all possible authentication methods of a user like password, passwordless, (T)OTP and more..
+     * List all possible authentication methods of a user
+     */
+    private listAuthenticationMethodTypesRaw;
+    /**
+     * List all possible authentication methods of a user like password, passwordless, (T)OTP and more..
+     * List all possible authentication methods of a user
+     */
+    listAuthenticationMethodTypes(requestParameters: UserServiceApiListAuthenticationMethodTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceListAuthenticationMethodTypesResponse>;
+    /**
+     * List links to an identity provider of an user.
+     * List links to an identity provider of an user
+     */
+    private listIDPLinksRaw;
+    /**
+     * List links to an identity provider of an user.
+     * List links to an identity provider of an user
+     */
+    listIDPLinks(requestParameters: UserServiceApiListIDPLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceListIDPLinksResponse>;
+    /**
+     * List all matching keys. By default all keys of the instance on which the caller has permission to read the owning users are returned.  Make sure to include a limit and sorting for pagination.   Required permission:    - user.read
+     * Search Keys
+     */
+    private listKeysRaw;
+    /**
+     * List all matching keys. By default all keys of the instance on which the caller has permission to read the owning users are returned.  Make sure to include a limit and sorting for pagination.   Required permission:    - user.read
+     * Search Keys
+     */
+    listKeys(requestParameters: UserServiceApiListKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceListKeysResponse>;
+    /**
+     * List passkeys of an user
+     * List passkeys of an user
+     */
+    private listPasskeysRaw;
+    /**
+     * List passkeys of an user
+     * List passkeys of an user
+     */
+    listPasskeys(requestParameters: UserServiceApiListPasskeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceListPasskeysResponse>;
+    /**
+     * List all personal access tokens. By default all personal access tokens of the instance on which the caller has permission to read the owning users are returned.  Make sure to include a limit and sorting for pagination.   Required permission:    - user.read
+     * Search Personal Access Tokens
+     */
+    private listPersonalAccessTokensRaw;
+    /**
+     * List all personal access tokens. By default all personal access tokens of the instance on which the caller has permission to read the owning users are returned.  Make sure to include a limit and sorting for pagination.   Required permission:    - user.read
+     * Search Personal Access Tokens
+     */
+    listPersonalAccessTokens(requestParameters: UserServiceApiListPersonalAccessTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceListPersonalAccessTokensResponse>;
+    /**
+     * List metadata of an user filtered by query.   Required permission:   - `user.read`
+     * List User Metadata
+     */
+    private listUserMetadataRaw;
+    /**
+     * List metadata of an user filtered by query.   Required permission:   - `user.read`
+     * List User Metadata
+     */
+    listUserMetadata(requestParameters: UserServiceApiListUserMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceListUserMetadataResponse>;
+    /**
+     * Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.
+     * Search Users
+     */
+    private listUsersRaw;
+    /**
+     * Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.
+     * Search Users
+     */
+    listUsers(requestParameters: UserServiceApiListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceListUsersResponse>;
+    /**
+     * The state of the user will be changed to \'locked\'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state \'locked\'. Use this endpoint if the user should not be able to log in temporarily because of an event that happened (wrong password, etc.)..
+     * Lock user
+     */
+    private lockUserRaw;
+    /**
+     * The state of the user will be changed to \'locked\'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state \'locked\'. Use this endpoint if the user should not be able to log in temporarily because of an event that happened (wrong password, etc.)..
+     * Lock user
+     */
+    lockUser(requestParameters: UserServiceApiLockUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceLockUserResponse>;
+    /**
+     * Request a code to reset a password..
+     * Request a code to reset a password
+     */
+    private passwordResetRaw;
+    /**
+     * Request a code to reset a password..
+     * Request a code to reset a password
+     */
+    passwordReset(requestParameters: UserServiceApiPasswordResetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServicePasswordResetResponse>;
+    /**
+     * Reactivate a user with the state \'deactivated\'. The user will be able to log in again afterward. The endpoint returns an error if the user is not in the state \'deactivated\'..
+     * Reactivate user
+     */
+    private reactivateUserRaw;
+    /**
+     * Reactivate a user with the state \'deactivated\'. The user will be able to log in again afterward. The endpoint returns an error if the user is not in the state \'deactivated\'..
+     * Reactivate user
+     */
+    reactivateUser(requestParameters: UserServiceApiReactivateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceReactivateUserResponse>;
+    /**
+     * Start the registration of a passkey for a user, as a response the public key credential creation options are returned, which are used to verify the passkey..
+     * Start the registration of passkey for a user
+     */
+    private registerPasskeyRaw;
+    /**
+     * Start the registration of a passkey for a user, as a response the public key credential creation options are returned, which are used to verify the passkey..
+     * Start the registration of passkey for a user
+     */
+    registerPasskey(requestParameters: UserServiceApiRegisterPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRegisterPasskeyResponse>;
+    /**
+     * Start the registration of a TOTP generator for a user, as a response a secret returned, which is used to initialize a TOTP app or device..
+     * Start the registration of a TOTP generator for a user
+     */
+    private registerTOTPRaw;
+    /**
+     * Start the registration of a TOTP generator for a user, as a response a secret returned, which is used to initialize a TOTP app or device..
+     * Start the registration of a TOTP generator for a user
+     */
+    registerTOTP(requestParameters: UserServiceApiRegisterTOTPRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRegisterTOTPResponse>;
+    /**
+     * Start the registration of a u2f token for a user, as a response the public key credential creation options are returned, which are used to verify the u2f token..
+     * Start the registration of a u2f token for a user
+     */
+    private registerU2FRaw;
+    /**
+     * Start the registration of a u2f token for a user, as a response the public key credential creation options are returned, which are used to verify the u2f token..
+     * Start the registration of a u2f token for a user
+     */
+    registerU2F(requestParameters: UserServiceApiRegisterU2FRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRegisterU2FResponse>;
+    /**
+     * Remove link of an identity provider to an user.
+     * Remove link of an identity provider to an user
+     */
+    private removeIDPLinkRaw;
+    /**
+     * Remove link of an identity provider to an user.
+     * Remove link of an identity provider to an user
+     */
+    removeIDPLink(requestParameters: UserServiceApiRemoveIDPLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemoveIDPLinkResponse>;
+    /**
+     * Remove a machine users key by the given key ID and an optionally given user ID.   Required permission:    - user.write
+     * Remove a Key
+     */
+    private removeKeyRaw;
+    /**
+     * Remove a machine users key by the given key ID and an optionally given user ID.   Required permission:    - user.write
+     * Remove a Key
+     */
+    removeKey(requestParameters: UserServiceApiRemoveKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemoveKeyResponse>;
+    /**
+     * Remove the configured One-Time Password (OTP) Email factor of a user. As only one OTP Email per user is allowed, the user will not have OTP Email as a second factor afterward.
+     * Remove One-Time Password (OTP) Email from a user
+     */
+    private removeOTPEmailRaw;
+    /**
+     * Remove the configured One-Time Password (OTP) Email factor of a user. As only one OTP Email per user is allowed, the user will not have OTP Email as a second factor afterward.
+     * Remove One-Time Password (OTP) Email from a user
+     */
+    removeOTPEmail(requestParameters: UserServiceApiRemoveOTPEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemoveOTPEmailResponse>;
+    /**
+     * Remove the configured One-Time Password (OTP) SMS factor of a user. As only one OTP SMS per user is allowed, the user will not have OTP SMS as a second factor afterward.
+     * Remove One-Time Password (OTP) SMS from a user
+     */
+    private removeOTPSMSRaw;
+    /**
+     * Remove the configured One-Time Password (OTP) SMS factor of a user. As only one OTP SMS per user is allowed, the user will not have OTP SMS as a second factor afterward.
+     * Remove One-Time Password (OTP) SMS from a user
+     */
+    removeOTPSMS(requestParameters: UserServiceApiRemoveOTPSMSRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemoveOTPSMSResponse>;
+    /**
+     * Remove passkey from a user.
+     * Remove passkey from a user
+     */
+    private removePasskeyRaw;
+    /**
+     * Remove passkey from a user.
+     * Remove passkey from a user
+     */
+    removePasskey(requestParameters: UserServiceApiRemovePasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemovePasskeyResponse>;
+    /**
+     * Removes a machine users personal access token by the given token ID and an optionally given user ID.   Required permission:    - user.write
+     * Remove a Personal Access Token
+     */
+    private removePersonalAccessTokenRaw;
+    /**
+     * Removes a machine users personal access token by the given token ID and an optionally given user ID.   Required permission:    - user.write
+     * Remove a Personal Access Token
+     */
+    removePersonalAccessToken(requestParameters: UserServiceApiRemovePersonalAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemovePersonalAccessTokenResponse>;
+    /**
+     * Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx) to remove the phone number.   Delete the phone number of a user.
+     * Delete the user phone
+     */
+    private removePhoneRaw;
+    /**
+     * Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx) to remove the phone number.   Delete the phone number of a user.
+     * Delete the user phone
+     */
+    removePhone(requestParameters: UserServiceApiRemovePhoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemovePhoneResponse>;
+    /**
+     * Remove the current client ID and client secret from a machine user.   Required permission:    - user.write
+     * Remove a Users Secret
+     */
+    private removeSecretRaw;
+    /**
+     * Remove the current client ID and client secret from a machine user.   Required permission:    - user.write
+     * Remove a Users Secret
+     */
+    removeSecret(requestParameters: UserServiceApiRemoveSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemoveSecretResponse>;
+    /**
+     * Remove the configured TOTP generator of a user. As only one TOTP generator per user is allowed, the user will not have TOTP as a second factor afterward.
+     * Remove TOTP generator from a user
+     */
+    private removeTOTPRaw;
+    /**
+     * Remove the configured TOTP generator of a user. As only one TOTP generator per user is allowed, the user will not have TOTP as a second factor afterward.
+     * Remove TOTP generator from a user
+     */
+    removeTOTP(requestParameters: UserServiceApiRemoveTOTPRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemoveTOTPResponse>;
+    /**
+     * Remove u2f token from a user.
+     * Remove u2f token from a user
+     */
+    private removeU2FRaw;
+    /**
+     * Remove u2f token from a user.
+     * Remove u2f token from a user
+     */
+    removeU2F(requestParameters: UserServiceApiRemoveU2FRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRemoveU2FResponse>;
+    /**
+     * Resend code to verify user email
+     * Resend code to verify user email
+     */
+    private resendEmailCodeRaw;
+    /**
+     * Resend code to verify user email
+     * Resend code to verify user email
+     */
+    resendEmailCode(requestParameters: UserServiceApiResendEmailCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceResendEmailCodeResponse>;
+    /**
+     * Deprecated: Use [CreateInviteCode](apis/resources/user_service_v2/user-service-create-invite-code.api.mdx) instead.   Resend an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization\'s available methods.  A resend is only possible if a code has been created previously and sent to the user. If there is no code or it was directly returned, an error will be returned.
+     * Resend an invite code for a user
+     */
+    private resendInviteCodeRaw;
+    /**
+     * Deprecated: Use [CreateInviteCode](apis/resources/user_service_v2/user-service-create-invite-code.api.mdx) instead.   Resend an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization\'s available methods.  A resend is only possible if a code has been created previously and sent to the user. If there is no code or it was directly returned, an error will be returned.
+     * Resend an invite code for a user
+     */
+    resendInviteCode(requestParameters: UserServiceApiResendInviteCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceResendInviteCodeResponse>;
+    /**
+     * Resend code to verify user phone number.
+     * Resend code to verify user phone number
+     */
+    private resendPhoneCodeRaw;
+    /**
+     * Resend code to verify user phone number.
+     * Resend code to verify user phone number
+     */
+    resendPhoneCode(requestParameters: UserServiceApiResendPhoneCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceResendPhoneCodeResponse>;
+    /**
+     * Retrieve the information returned by the identity provider for registration or updating an existing user with new information..
+     * Retrieve the information returned by the identity provider
+     */
+    private retrieveIdentityProviderIntentRaw;
+    /**
+     * Retrieve the information returned by the identity provider for registration or updating an existing user with new information..
+     * Retrieve the information returned by the identity provider
+     */
+    retrieveIdentityProviderIntent(requestParameters: UserServiceApiRetrieveIdentityProviderIntentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceRetrieveIdentityProviderIntentResponse>;
+    /**
+     * Send code to verify user email
+     * Send code to verify user email
+     */
+    private sendEmailCodeRaw;
+    /**
+     * Send code to verify user email
+     * Send code to verify user email
+     */
+    sendEmailCode(requestParameters: UserServiceApiSendEmailCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceSendEmailCodeResponse>;
+    /**
+     * Deprecated: [Update the users email field](apis/resources/user_service_v2/user-service-update-user.api.mdx).   Change the email address of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by email..
+     * Change the user email
+     */
+    private setEmailRaw;
+    /**
+     * Deprecated: [Update the users email field](apis/resources/user_service_v2/user-service-update-user.api.mdx).   Change the email address of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by email..
+     * Change the user email
+     */
+    setEmail(requestParameters: UserServiceApiSetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceSetEmailResponse>;
+    /**
+     * Deprecated: [Update the users password](apis/resources/user_service_v2/user-service-update-user.api.mdx) instead.   Change the password of a user with either a verification code or the current password..
+     * Change password
+     */
+    private setPasswordRaw;
+    /**
+     * Deprecated: [Update the users password](apis/resources/user_service_v2/user-service-update-user.api.mdx) instead.   Change the password of a user with either a verification code or the current password..
+     * Change password
+     */
+    setPassword(requestParameters: UserServiceApiSetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceSetPasswordResponse>;
+    /**
+     * Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx).   Set the phone number of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by sms..
+     * Set the user phone
+     */
+    private setPhoneRaw;
+    /**
+     * Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx).   Set the phone number of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by sms..
+     * Set the user phone
+     */
+    setPhone(requestParameters: UserServiceApiSetPhoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceSetPhoneResponse>;
+    /**
+     * Sets a list of key value pairs. Existing metadata entries with matching keys are overwritten. Existing metadata entries without matching keys are untouched. To remove metadata entries, use [DeleteUserMetadata](apis/resources/user_service_v2/user-service-delete-user-metadata.api.mdx). For HTTP requests, make sure the bytes array value is base64 encoded.   Required permission:   - `user.write`
+     * Set User Metadata
+     */
+    private setUserMetadataRaw;
+    /**
+     * Sets a list of key value pairs. Existing metadata entries with matching keys are overwritten. Existing metadata entries without matching keys are untouched. To remove metadata entries, use [DeleteUserMetadata](apis/resources/user_service_v2/user-service-delete-user-metadata.api.mdx). For HTTP requests, make sure the bytes array value is base64 encoded.   Required permission:   - `user.write`
+     * Set User Metadata
+     */
+    setUserMetadata(requestParameters: UserServiceApiSetUserMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceSetUserMetadataResponse>;
+    /**
+     * Start a flow with an identity provider, for external login, registration or linking..
+     * Start flow with an identity provider
+     */
+    private startIdentityProviderIntentRaw;
+    /**
+     * Start a flow with an identity provider, for external login, registration or linking..
+     * Start flow with an identity provider
+     */
+    startIdentityProviderIntent(requestParameters: UserServiceApiStartIdentityProviderIntentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceStartIdentityProviderIntentResponse>;
+    /**
+     * The state of the user will be changed to \'active\'. The user will be able to log in again. The endpoint returns an error if the user is not in the state \'locked\'.
+     * Unlock user
+     */
+    private unlockUserRaw;
+    /**
+     * The state of the user will be changed to \'active\'. The user will be able to log in again. The endpoint returns an error if the user is not in the state \'locked\'.
+     * Unlock user
+     */
+    unlockUser(requestParameters: UserServiceApiUnlockUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceUnlockUserResponse>;
+    /**
+     * Deprecated: Use [UpdateUser](apis/resources/user_service_v2/user-service-update-user.api.mdx) to update a user of type human instead.   Update all information from a user.
+     * Update Human User
+     */
+    private updateHumanUserRaw;
+    /**
+     * Deprecated: Use [UpdateUser](apis/resources/user_service_v2/user-service-update-user.api.mdx) to update a user of type human instead.   Update all information from a user.
+     * Update Human User
+     */
+    updateHumanUser(requestParameters: UserServiceApiUpdateHumanUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceUpdateHumanUserResponse>;
+    /**
+     * Partially update an existing user.  If you change the users email or phone, you can specify how the ownership should be verified.  If you change the users password, you can specify if the password should be changed again on the users next login.   Required permission:    - user.write
+     * Update a User
+     */
+    private updateUserRaw;
+    /**
+     * Partially update an existing user.  If you change the users email or phone, you can specify how the ownership should be verified.  If you change the users password, you can specify if the password should be changed again on the users next login.   Required permission:    - user.write
+     * Update a User
+     */
+    updateUser(requestParameters: UserServiceApiUpdateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceUpdateUserResponse>;
+    /**
+     * Verify the email with the generated code.
+     * Verify the email
+     */
+    private verifyEmailRaw;
+    /**
+     * Verify the email with the generated code.
+     * Verify the email
+     */
+    verifyEmail(requestParameters: UserServiceApiVerifyEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceVerifyEmailResponse>;
+    /**
+     * Verify the invite code of a user previously issued. This will set their email to a verified state and  allow the user to set up their first authentication method (password, passkeys, IdP) depending on the organization\'s available methods.
+     * Verify an invite code for a user
+     */
+    private verifyInviteCodeRaw;
+    /**
+     * Verify the invite code of a user previously issued. This will set their email to a verified state and  allow the user to set up their first authentication method (password, passkeys, IdP) depending on the organization\'s available methods.
+     * Verify an invite code for a user
+     */
+    verifyInviteCode(requestParameters: UserServiceApiVerifyInviteCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceVerifyInviteCodeResponse>;
+    /**
+     * Verify the passkey registration with the public key credential..
+     * Verify a passkey for a user
+     */
+    private verifyPasskeyRegistrationRaw;
+    /**
+     * Verify the passkey registration with the public key credential..
+     * Verify a passkey for a user
+     */
+    verifyPasskeyRegistration(requestParameters: UserServiceApiVerifyPasskeyRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceVerifyPasskeyRegistrationResponse>;
+    /**
+     * Verify the phone number with the generated code.
+     * Verify the phone number
+     */
+    private verifyPhoneRaw;
+    /**
+     * Verify the phone number with the generated code.
+     * Verify the phone number
+     */
+    verifyPhone(requestParameters: UserServiceApiVerifyPhoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceVerifyPhoneResponse>;
+    /**
+     * Verify the TOTP registration with a generated code..
+     * Verify a TOTP generator for a user
+     */
+    private verifyTOTPRegistrationRaw;
+    /**
+     * Verify the TOTP registration with a generated code..
+     * Verify a TOTP generator for a user
+     */
+    verifyTOTPRegistration(requestParameters: UserServiceApiVerifyTOTPRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceVerifyTOTPRegistrationResponse>;
+    /**
+     * Verify the u2f token registration with the public key credential..
+     * Verify a u2f token for a user
+     */
+    private verifyU2FRegistrationRaw;
+    /**
+     * Verify the u2f token registration with the public key credential..
+     * Verify a u2f token for a user
+     */
+    verifyU2FRegistration(requestParameters: UserServiceApiVerifyU2FRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserServiceVerifyU2FRegistrationResponse>;
+}