bitbucket-datacenter-mcp 0.2.0

package/build/bitbucket-client/services/AuthenticationService.d.ts

@@ -0,0 +1,684 @@
+import type { AuthenticationEntity } from '../models/AuthenticationEntity.js';
+import type { AuthenticationResponse } from '../models/AuthenticationResponse.js';
+import type { BasicAuthConfigEntity } from '../models/BasicAuthConfigEntity.js';
+import type { CaptchaDataEntity } from '../models/CaptchaDataEntity.js';
+import type { ConversationDTO } from '../models/ConversationDTO.js';
+import type { IdpConfigEntity } from '../models/IdpConfigEntity.js';
+import type { JitUserEntity } from '../models/JitUserEntity.js';
+import type { LoginOptionEntity } from '../models/LoginOptionEntity.js';
+import type { RestAccessToken } from '../models/RestAccessToken.js';
+import type { RestAccessTokenRequest } from '../models/RestAccessTokenRequest.js';
+import type { RestProject } from '../models/RestProject.js';
+import type { RestRawAccessToken } from '../models/RestRawAccessToken.js';
+import type { RestRepository } from '../models/RestRepository.js';
+import type { RestSshAccessKey } from '../models/RestSshAccessKey.js';
+import type { RestSshKey } from '../models/RestSshKey.js';
+import type { RestSshSettings } from '../models/RestSshSettings.js';
+import type { SsoConfigEntity } from '../models/SsoConfigEntity.js';
+import type { SsoManagementStatusDTO } from '../models/SsoManagementStatusDTO.js';
+import type { StatusDTO } from '../models/StatusDTO.js';
+import type { TotpCodeVerificationDTO } from '../models/TotpCodeVerificationDTO.js';
+import type { TotpElevationRestDTO } from '../models/TotpElevationRestDTO.js';
+import type { TotpRecoveryCodeAuthenticationDTO } from '../models/TotpRecoveryCodeAuthenticationDTO.js';
+import type { TotpRecoveryCodeDTO } from '../models/TotpRecoveryCodeDTO.js';
+import type { TotpUserEnrollmentDTO } from '../models/TotpUserEnrollmentDTO.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+export declare class AuthenticationService {
+    /**
+     * Get project HTTP tokens
+     * Get all access tokens associated with the given project.
+     * @param projectKey The project key.
+     * @param start Start number for the page (inclusive). If not passed, first page is assumed.
+     * @param limit Number of items to return. If not passed, a page size of 25 is used.
+     * @returns any A response containing a page of access tokens and associated details.
+     * @throws ApiError
+     */
+    static getAllAccessTokens(projectKey: string, start?: number, limit?: number): CancelablePromise<{
+        isLastPage?: boolean;
+        limit?: number;
+        nextPageStart?: number;
+        size?: number;
+        start?: number;
+        values?: Array<RestAccessToken>;
+    }>;
+    /**
+     * Create project HTTP token
+     * Create an access token for the project according to the given request.
+     * @param projectKey The project key.
+     * @param requestBody The request containing the details of the access token to create.
+     * @returns RestRawAccessToken A response containing the raw access token and associated details.
+     * @throws ApiError
+     */
+    static createAccessToken(projectKey: string, requestBody?: RestAccessTokenRequest): CancelablePromise<RestRawAccessToken>;
+    /**
+     * Get repository HTTP tokens
+     * Get all access tokens associated with the given repository.
+     * @param projectKey The project key.
+     * @param repositorySlug The repository slug.
+     * @param start Start number for the page (inclusive). If not passed, first page is assumed.
+     * @param limit Number of items to return. If not passed, a page size of 25 is used.
+     * @returns any A response containing a page of access tokens and associated details.
+     * @throws ApiError
+     */
+    static getAllAccessTokens1(projectKey: string, repositorySlug: string, start?: number, limit?: number): CancelablePromise<{
+        isLastPage?: boolean;
+        limit?: number;
+        nextPageStart?: number;
+        size?: number;
+        start?: number;
+        values?: Array<RestAccessToken>;
+    }>;
+    /**
+     * Create repository HTTP token
+     * Create an access token for the repository according to the given request.
+     * @param projectKey The project key.
+     * @param repositorySlug The repository slug.
+     * @param requestBody The request containing the details of the access token to create.
+     * @returns RestRawAccessToken A response containing the raw access token and associated details.
+     * @throws ApiError
+     */
+    static createAccessToken1(projectKey: string, repositorySlug: string, requestBody?: RestAccessTokenRequest): CancelablePromise<RestRawAccessToken>;
+    /**
+     * Delete a HTTP token
+     * Delete the access token identified by the given ID.
+     * @param projectKey The project key.
+     * @param tokenId The token id.
+     * @param repositorySlug The repository slug.
+     * @returns void
+     * @throws ApiError
+     */
+    static deleteById1(projectKey: string, tokenId: string, repositorySlug: string): CancelablePromise<void>;
+    /**
+     * Get HTTP token by ID
+     * Get the access token identified by the given ID.
+     * @param projectKey The project key.
+     * @param tokenId The token id.
+     * @param repositorySlug The repository slug.
+     * @returns RestAccessToken A response containing the access token and associated details.
+     * @throws ApiError
+     */
+    static getById1(projectKey: string, tokenId: string, repositorySlug: string): CancelablePromise<RestAccessToken>;
+    /**
+     * Update HTTP token
+     * Modify an access token according to the given request. Any fields not specified will not be altered.
+     * @param projectKey The project key.
+     * @param tokenId The token id.
+     * @param repositorySlug The repository slug.
+     * @param requestBody The request containing the details of the access token to modify
+     * @returns RestAccessToken A response containing the updated access token and associated details.
+     * @throws ApiError
+     */
+    static updateAccessToken1(projectKey: string, tokenId: string, repositorySlug: string, requestBody?: RestAccessTokenRequest): CancelablePromise<RestAccessToken>;
+    /**
+     * Delete a HTTP token
+     * Delete the access token identified by the given ID.
+     * @param projectKey The project key.
+     * @param tokenId The token id.
+     * @returns void
+     * @throws ApiError
+     */
+    static deleteById(projectKey: string, tokenId: string): CancelablePromise<void>;
+    /**
+     * Get HTTP token by ID
+     * Get the access token identified by the given ID.
+     * @param projectKey The project key.
+     * @param tokenId The token id.
+     * @returns RestAccessToken A response containing the access token and associated details.
+     * @throws ApiError
+     */
+    static getById(projectKey: string, tokenId: string): CancelablePromise<RestAccessToken>;
+    /**
+     * Update HTTP token
+     * Modify an access token according to the given request. Any fields not specified will not be altered.
+     * @param projectKey The project key.
+     * @param tokenId The token id.
+     * @param requestBody The request containing the details of the access token to modify
+     * @returns RestAccessToken A response containing the updated access token and associated details.
+     * @throws ApiError
+     */
+    static updateAccessToken(projectKey: string, tokenId: string, requestBody?: RestAccessTokenRequest): CancelablePromise<RestAccessToken>;
+    /**
+     * Get personal HTTP tokens
+     * Get all access tokens associated with the given user.
+     * @param userSlug The user slug.
+     * @param start Start number for the page (inclusive). If not passed, first page is assumed.
+     * @param limit Number of items to return. If not passed, a page size of 25 is used.
+     * @returns any A response containing a page of access tokens and associated details.
+     * @throws ApiError
+     */
+    static getAllAccessTokens2(userSlug: string, start?: number, limit?: number): CancelablePromise<{
+        isLastPage?: boolean;
+        limit?: number;
+        nextPageStart?: number;
+        size?: number;
+        start?: number;
+        values?: Array<RestAccessToken>;
+    }>;
+    /**
+     * Create personal HTTP token
+     * Create an access token for the user according to the given request.
+     * @param userSlug The user slug.
+     * @param requestBody The request containing the details of the access token to create.
+     * @returns RestRawAccessToken A response containing the raw access token and associated details.
+     * @throws ApiError
+     */
+    static createAccessToken2(userSlug: string, requestBody?: RestAccessTokenRequest): CancelablePromise<RestRawAccessToken>;
+    /**
+     * Delete a HTTP token
+     * Delete the access token identified by the given ID.
+     * @param tokenId The token id.
+     * @param userSlug The user slug.
+     * @returns void
+     * @throws ApiError
+     */
+    static deleteById2(tokenId: string, userSlug: string): CancelablePromise<void>;
+    /**
+     * Get HTTP token by ID
+     * Get the access token identified by the given ID.
+     * @param tokenId The token id.
+     * @param userSlug The user slug.
+     * @returns RestAccessToken A response containing the access token and associated details.
+     * @throws ApiError
+     */
+    static getById2(tokenId: string, userSlug: string): CancelablePromise<RestAccessToken>;
+    /**
+     * Update HTTP token
+     * Modify an access token according to the given request. Any fields not specified will not be altered.
+     * @param tokenId The token id.
+     * @param userSlug The user slug.
+     * @param requestBody The request containing the details of the access token to modify
+     * @returns RestAccessToken A response containing the updated access token and associated details.
+     * @throws ApiError
+     */
+    static updateAccessToken2(tokenId: string, userSlug: string, requestBody?: RestAccessTokenRequest): CancelablePromise<RestAccessToken>;
+    /**
+     * Get repository SSH keys
+     * Retrieves the access keys for the repository identified in the URL.
+     * @param projectKey The project key.
+     * @param repositorySlug The repository slug.
+     * @param filter If specified only SSH access keys with a label prefixed with the supplied string will be returned
+     * @param effective Controls whether SSH access keys configured at the project level should be included in the results or not. When set to <code>true</code> all keys that have <em>access</em> to the repository (including project level keys) are included in the results. When set to <code>false</code>, only access keys configured for the specified <code>repository</code> are considered. Default is <code>false</code>.
+     * @param minimumPermission If specified only SSH access keys with at least the supplied permission will be returned. Default is <code>Permission.REPO_READ</code>.
+     * @param permission
+     * @param start Start number for the page (inclusive). If not passed, first page is assumed.
+     * @param limit Number of items to return. If not passed, a page size of 25 is used.
+     * @returns any A single page of access keys for the repository.
+     * @throws ApiError
+     */
+    static getForRepository1(projectKey: string, repositorySlug: string, filter?: string, effective?: string, minimumPermission?: string, permission?: string, start?: number, limit?: number): CancelablePromise<{
+        isLastPage?: boolean;
+        limit?: number;
+        nextPageStart?: number;
+        size?: number;
+        start?: number;
+        values?: Array<RestSshAccessKey>;
+    }>;
+    /**
+     * Add repository SSH key
+     * Register a new SSH key and grants access to the repository identified in the URL.
+     * @param projectKey The project key
+     * @param repositorySlug The repository slug
+     * @param requestBody
+     * @returns RestSshAccessKey The newly created access key.
+     * @throws ApiError
+     */
+    static addForRepository(projectKey: string, repositorySlug: string, requestBody?: RestSshAccessKey): CancelablePromise<RestSshAccessKey>;
+    /**
+     * Revoke repository SSH key
+     * Remove an existing access key for the repository identified in the URL. If the same SSH key is used as an access key for multiple projects or repositories, only the access to the repository identified in the URL will be revoked.
+     * @param projectKey The project key
+     * @param keyId The key id
+     * @param repositorySlug The repository slug
+     * @returns void
+     * @throws ApiError
+     */
+    static revokeForRepository(projectKey: string, keyId: string, repositorySlug: string): CancelablePromise<void>;
+    /**
+     * Get repository SSH key
+     * Retrieves the access key for the SSH key with id <code>keyId</code> on the repository identified in the URL.
+     * @param projectKey The project key
+     * @param keyId The key id
+     * @param repositorySlug The repository slug
+     * @returns RestSshAccessKey The access key for the repository and SSH key with ID <code>keyId</code>.
+     * @throws ApiError
+     */
+    static getForRepository(projectKey: string, keyId: string, repositorySlug: string): CancelablePromise<RestSshAccessKey>;
+    /**
+     * Update repository SSH key permission
+     * Updates the permission granted to the specified SSH key to the repository identified in the URL.
+     * @param projectKey The project key
+     * @param keyId The newly created access key
+     * @param permission The new permission to be granted to the SSH key
+     * @param repositorySlug The repository slug
+     * @returns RestSshAccessKey The newly created access key.
+     * @throws ApiError
+     */
+    static updatePermission1(projectKey: string, keyId: string, permission: string, repositorySlug: string): CancelablePromise<RestSshAccessKey>;
+    /**
+     * Get SSH key
+     * Retrieves the access keys for the project identified in the URL.
+     * @param projectKey The project key
+     * @param filter If specified only SSH access keys with a label prefixed with the supplied string will be returned.
+     * @param permission If specified only SSH access keys with at least the supplied permission will be returned Default is PROJECT_READ.
+     * @param start Start number for the page (inclusive). If not passed, first page is assumed.
+     * @param limit Number of items to return. If not passed, a page size of 25 is used.
+     * @returns any A single page of access keys associated with the project.
+     * @throws ApiError
+     */
+    static getSshKeysForProject(projectKey: string, filter?: string, permission?: string, start?: number, limit?: number): CancelablePromise<{
+        isLastPage?: boolean;
+        limit?: number;
+        nextPageStart?: number;
+        size?: number;
+        start?: number;
+        values?: Array<RestSshAccessKey>;
+    }>;
+    /**
+     * Add project SSH key
+     * Register a new SSH key and grants access to the project identified in the URL.
+     * @param projectKey The project key
+     * @param requestBody
+     * @returns RestSshAccessKey The newly created access key.
+     * @throws ApiError
+     */
+    static addForProject(projectKey: string, requestBody?: RestSshAccessKey): CancelablePromise<RestSshAccessKey>;
+    /**
+     * Revoke project SSH key
+     * Remove an existing access key for the project identified in the URL. If the same SSH key is used as an access key for multiple projects or repositories, only the access to the project identified in the URL will be revoked.
+     * @param projectKey The project key
+     * @param keyId The key id
+     * @returns void
+     * @throws ApiError
+     */
+    static revokeForProject(projectKey: string, keyId: string): CancelablePromise<void>;
+    /**
+     * Get project SSH key
+     * Retrieves the access key for the SSH key with id <code>keyId</code> on the project identified in the URL.
+     * @param projectKey The project key
+     * @param keyId The key id
+     * @returns RestSshAccessKey The access key for the repository and SSH key with ID <code>keyId</code>.
+     * @throws ApiError
+     */
+    static getForProject(projectKey: string, keyId: string): CancelablePromise<RestSshAccessKey>;
+    /**
+     * Update project SSH key permission
+     * Updates the permission granted to the specified SSH key to the project identified in the URL.
+     * @param projectKey The project key
+     * @param keyId The newly created access key
+     * @param permission The new permission to be granted to the SSH key
+     * @returns RestSshAccessKey The newly created access key.
+     * @throws ApiError
+     */
+    static updatePermission(projectKey: string, keyId: string, permission: string): CancelablePromise<RestSshAccessKey>;
+    /**
+     * Revoke project SSH key
+     * Remove an existing access key for the projects and repositories in the submitted entity. If the same SSH key is used as an access key for multiple projects or repositories not supplied, only the access to the projects or repositories identified will be revoked.
+     * @param keyId The identifier of the SSH key
+     * @param requestBody
+     * @returns void
+     * @throws ApiError
+     */
+    static revokeMany(keyId: string, requestBody?: {
+        projects?: RestProject;
+        repositories?: RestRepository;
+    }): CancelablePromise<void>;
+    /**
+     * Get project SSH keys
+     * Retrieves all project-related access keys for the SSH key with id <code>keyId</code>. If the current user is not an admin any of the projects the key provides access to, none are returned.
+     * @param keyId
+     * @returns any The SSH key with ID <code>keyId</code>.
+     * @throws ApiError
+     */
+    static getForProjects(keyId: number): CancelablePromise<any>;
+    /**
+     * Get repository SSH key
+     * Retrieves all repository-related access keys for the SSH key with id <code>keyId</code>. If the current user is not an admin of any of the projects the key provides access to, none are returned.
+     * @param keyId The key id
+     * @param withRestrictions Include the readOnly field. The `readOnly` field is contextual for the user making the request. `readOnly` returns true if there is a restriction and the user does not have`PROJECT_ADMIN` access for the repository the key is associated with.
+     * @returns any The SSH key with ID <code>keyId</code>.
+     * @throws ApiError
+     */
+    static getForRepositories(keyId: string, withRestrictions?: string): CancelablePromise<any>;
+    /**
+     * Delete all user SSH key
+     * Delete all SSH keys for a supplied user.
+     * @param userName the username of the user to delete the keys for. If no username is specified, the SSH keys will be deleted for the current authenticated user.
+     * @param user
+     * @returns void
+     * @throws ApiError
+     */
+    static deleteSshKeys(userName?: string, user?: string): CancelablePromise<void>;
+    /**
+     * Get SSH keys for user
+     * Retrieve a page of SSH keys.
+     * @param userName the username of the user to retrieve the keys for. If no username is specified, the SSH keys will be retrieved for the current authenticated user.
+     * @param user
+     * @param start Start number for the page (inclusive). If not passed, first page is assumed.
+     * @param limit Number of items to return. If not passed, a page size of 25 is used.
+     * @returns any A page of SSH keys.
+     * @throws ApiError
+     */
+    static getSshKeys(userName?: string, user?: string, start?: number, limit?: number): CancelablePromise<{
+        isLastPage?: boolean;
+        limit?: number;
+        nextPageStart?: number;
+        size?: number;
+        start?: number;
+        values?: Array<RestSshKey>;
+    }>;
+    /**
+     * Add SSH key for user
+     * Add a new SSH key to a supplied user.
+     * @param user the username of the user to add the SSH key for. If no username is specified, the SSH key will be added for the current authenticated user.
+     * @param requestBody
+     * @returns RestSshKey The newly created SSH key.
+     * @throws ApiError
+     */
+    static addSshKey(user?: any, requestBody?: {
+        algorithmType?: string;
+        bitLength?: number;
+        readonly createdDate?: string;
+        expiryDays?: number;
+        readonly fingerprint?: string;
+        readonly id?: number;
+        label?: string;
+        readonly lastAuthenticated?: string;
+        text?: string;
+        /**
+         * Contains a warning about the key, for example that it's deprecated
+         */
+        readonly warning?: string;
+    }): CancelablePromise<RestSshKey>;
+    /**
+     * Remove SSH key
+     * Delete an SSH key.
+     *
+     * The authenticated user must have <strong>ADMIN</strong> permission or higher to call this resource.
+     * @param keyId the id of the key to delete.
+     * @returns void
+     * @throws ApiError
+     */
+    static deleteSshKey(keyId: string): CancelablePromise<void>;
+    /**
+     * Get SSH key for user by keyId
+     * Retrieve an SSH key by keyId
+     *
+     * The authenticated user must have <strong>ADMIN</strong> permission or higher to call this resource.
+     * @param keyId the ID of the key to retrieve.
+     * @returns RestSshKey An SSH key.
+     * @throws ApiError
+     */
+    static getSshKey(keyId: string): CancelablePromise<RestSshKey>;
+    /**
+     * Get SSH settings
+     * Gets the SSH settings from the upstream.
+     * @returns RestSshSettings The ssh settings from upstream
+     * @throws ApiError
+     */
+    static sshSettings(): CancelablePromise<RestSshSettings>;
+    /**
+     * Get all configured IdPs
+     * Returns a page of configured IdPs.
+     *
+     * This endpoint makes no guarantees to ordering besides the ordering being consistent.
+     * @param start Start number for the page (inclusive). If not passed, first page is assumed.
+     * @param limit Number of items to return. If not passed, a page size of 50 is used. A limit of -1 means that the request will fetch all results.
+     * @returns any A page of configured IdPs.
+     * @throws ApiError
+     */
+    static getIdps(start?: number, limit?: number): CancelablePromise<{
+        isLastPage?: boolean;
+        limit?: number;
+        results?: Array<IdpConfigEntity>;
+        size?: number;
+        start?: number;
+    }>;
+    /**
+     * Create IdP configuration
+     * Creates a new IdP configuration.
+     * @param requestBody The configuration of the new IdP to add. The ID must be null.
+     * @returns IdpConfigEntity The newly created IdP configuration.
+     * @throws ApiError
+     */
+    static addIdp(requestBody?: IdpConfigEntity): CancelablePromise<IdpConfigEntity>;
+    /**
+     * Delete IdP configuration
+     * Removes the configuration for the IdP that matches the given ID.
+     * @param id The ID of the IdP
+     * @returns IdpConfigEntity The IdP configuration was successfully deleted.
+     * @throws ApiError
+     */
+    static removeIdp(id: string): CancelablePromise<IdpConfigEntity>;
+    /**
+     * Get IdP configuration
+     * Returns the configuration for the IdP that matches the given ID.
+     * @param id The ID of the IdP
+     * @returns IdpConfigEntity The configuration for the given IdP.
+     * @throws ApiError
+     */
+    static getIdp(id: string): CancelablePromise<IdpConfigEntity>;
+    /**
+     * Update IdP configuration
+     * Updates the configuration for the IdP that matches the given ID.
+     *
+     * Only the provided properties will be applied to the IdP configuration.
+     * @param id The ID of the IdP
+     * @param requestBody A request containing the IdP configuration to update. The ID must either be null or equal to the ID specified in the path.
+     * @returns IdpConfigEntity The updated configuration for the given IdP.
+     * @throws ApiError
+     */
+    static updateIdp(id: string, requestBody?: IdpConfigEntity): CancelablePromise<IdpConfigEntity>;
+    /**
+     * Get all JIT provisioned users
+     * Returns a list of all the users created by JIT (Just-in-time) provisioning.
+     *
+     * Just-in-time user provisioning (JIT provisioning) allows users to be created and updated automatically when they log in through SAML SSO or OpenID Connect (OIDC) SSO.
+     * @returns JitUserEntity A list of JIT users
+     * @throws ApiError
+     */
+    static getJitProvisionedUsers(): CancelablePromise<JitUserEntity>;
+    /**
+     * Get available login options
+     * Returns a list of available login options, which contains details about the metadata required for the login page.
+     *
+     * Only enabled login options will be returned. Login options can either be the native login form or the configured IdPs.
+     * @param start Start number for the page (inclusive). If not passed, first page is assumed.
+     * @param limit Number of items to return. If not passed, a page size of 50 is used. A limit of -1 means that the request will fetch all results.
+     * @returns any A list of login options
+     * @throws ApiError
+     */
+    static getLoginOptions(start?: number, limit?: number): CancelablePromise<{
+        isLastPage?: boolean;
+        limit?: number;
+        results?: Array<LoginOptionEntity>;
+        size?: number;
+        start?: number;
+    }>;
+    /**
+     * Get SSO configuration
+     * Returns the SSO configuration.
+     * @returns SsoConfigEntity The SSO configuration
+     * @throws ApiError
+     */
+    static getConfig(): CancelablePromise<SsoConfigEntity>;
+    /**
+     * Update SSO configuration
+     * Update the SSO configuration.
+     * @param requestBody A request containing the SSO configuration to update.
+     * @returns SsoConfigEntity The updated SSO Configuration
+     * @throws ApiError
+     */
+    static updateConfig(requestBody?: SsoConfigEntity): CancelablePromise<SsoConfigEntity>;
+    /**
+     * Get basic auth configuration
+     * Get the current configuration for blocking basic authentication requests.
+     * @returns BasicAuthConfigEntity The blocking basic authentication configuration.
+     * @throws ApiError
+     */
+    static get(): CancelablePromise<BasicAuthConfigEntity>;
+    /**
+     * Update basic auth configuration
+     * Store a new configuration for blocking basic authentication requests.
+     * @param requestBody A request containing the new basic authentication configuration.
+     * @returns void
+     * @throws ApiError
+     */
+    static put(requestBody?: BasicAuthConfigEntity): CancelablePromise<void>;
+    /**
+     * Authenticate with 2SV
+     * Authenticates as the given user. This endpoint <strong>may</strong>:
+     *
+     * - Ask for two-step verification if the user has enrolled; or
+     * - Enforce enrollment in two-step verification if two-step verification enforcement is configured for the instance and the user is not yet enrolled.
+     * @param requestBody
+     * @returns AuthenticationResponse The user has successfully authenticated.
+     * @throws ApiError
+     */
+    static authenticate(requestBody?: AuthenticationEntity): CancelablePromise<AuthenticationResponse>;
+    /**
+     * Get CAPTCHA challenge
+     * Provides data for a CAPTCHA challenge.
+     * @returns CaptchaDataEntity The CAPTCHA challenge
+     * @throws ApiError
+     */
+    static getCaptchaData(): CancelablePromise<CaptchaDataEntity>;
+    /**
+     * Authenticate using recovery code
+     * Authenticate as the given user using a recovery code.
+     * @param requestBody A request containing a recovery code for the specified user.
+     * @returns AuthenticationResponse The user was successfully logged in.
+     * @throws ApiError
+     */
+    static authenticateWithRecoveryCode(requestBody?: TotpRecoveryCodeAuthenticationDTO): CancelablePromise<AuthenticationResponse>;
+    /**
+     * Authenticate using TOTP code
+     * Authenticate as the given user using a TOTP code.
+     * @param requestBody A request containing a TOTP code for the given user.
+     * @returns void
+     * @throws ApiError
+     */
+    static verifyCode(requestBody?: TotpCodeVerificationDTO): CancelablePromise<void>;
+    /**
+     * Get elevated session status
+     * Checks the state of an elevated session for the currently authenticated user.
+     * @param actionType The type of action being performed.
+     * @returns void
+     * @throws ApiError
+     */
+    static getElevatedPermissionStatus(actionType?: 'unlock-user-2sv-settings'): CancelablePromise<void>;
+    /**
+     * Create elevated session with password
+     * Elevate permissions by providing the password for the currently authenticated user. This will create an elevated session.
+     * @param actionType The type of action being performed.
+     * @param requestBody A request containing the password for the currently authenticated user.
+     * @returns void
+     * @throws ApiError
+     */
+    static elevatePermissionsWithPassword(actionType?: 'unlock-user-2sv-settings', requestBody?: TotpElevationRestDTO): CancelablePromise<void>;
+    /**
+     * Create elevated session with recovery code
+     * Elevate permissions by providing a recovery code for the currently authenticated user. This will create an elevated session.
+     * @param actionType The type of action being performed.
+     * @param requestBody A request containing a recovery code for the currently authenticated user.
+     * @returns TotpRecoveryCodeDTO Permissions were successfully elevated.
+     * @throws ApiError
+     */
+    static elevatePermissionsWithRecoveryCode(actionType?: 'unlock-user-2sv-settings', requestBody?: TotpRecoveryCodeDTO): CancelablePromise<TotpRecoveryCodeDTO>;
+    /**
+     * Create elevated session with TOTP
+     * Elevate permissions by providing a TOTP code for the currently authenticated user. This will create an elevated session.
+     * @param actionType The type of action being performed.
+     * @param requestBody A request containing a TOTP code for the given user.
+     * @returns void
+     * @throws ApiError
+     */
+    static elevatePermissionsWithTotp(actionType?: 'unlock-user-2sv-settings', requestBody?: TotpElevationRestDTO): CancelablePromise<void>;
+    /**
+     * Get SSO management status
+     * Retrieves the status of the SSO management for the currently authenticated user.
+     * @returns SsoManagementStatusDTO Successfully retrieved SSO management status
+     * @throws ApiError
+     */
+    static getSsoManagementStatus(): CancelablePromise<SsoManagementStatusDTO>;
+    /**
+     * Get two-step verification status
+     * Retrieves the status of two-step verification for the currently authenticated user.
+     * @returns StatusDTO Successfully retrieved the two-step verification status.
+     * @throws ApiError
+     */
+    static getStatus(): CancelablePromise<StatusDTO>;
+    /**
+     * Complete enforced enrollment in 2SV
+     * Complete enforced enrollment in two-step verification by verifying the provided TOTP code and creating a new session for the given user.
+     * @param requestBody A request containing a TOTP code for the given user.
+     * @returns TotpRecoveryCodeDTO Enrollment successfully completed.
+     * @throws ApiError
+     */
+    static completeEnforcedEnrollment(requestBody?: TotpCodeVerificationDTO): CancelablePromise<TotpRecoveryCodeDTO>;
+    /**
+     * Complete authentication app update for 2SV
+     * Complete update of the authentication app used for two-step verification by verifying the provided TOTP code.
+     * @param requestBody A request containing a TOTP code for the given user.
+     * @returns TotpUserEnrollmentDTO Authentication app successfully updated.
+     * @throws ApiError
+     */
+    static completeAuthenticationChange(requestBody?: TotpCodeVerificationDTO): CancelablePromise<TotpUserEnrollmentDTO>;
+    /**
+     * Complete voluntary enrollment in 2SV
+     * Complete voluntary enrollment in two-step verification by verifying the provided TOTP code and creating a new session for the given user.
+     * @param requestBody A request containing a TOTP code for the given user.
+     * @returns TotpUserEnrollmentDTO Enrollment successfully completed.
+     * @throws ApiError
+     */
+    static completeVoluntaryEnrollment(requestBody?: TotpCodeVerificationDTO): CancelablePromise<TotpUserEnrollmentDTO>;
+    /**
+     * Rotate recovery code
+     * Rotates the recovery code for the currently authentication user.
+     * @returns TotpRecoveryCodeDTO The recovery code has been successfully rotated.
+     * @throws ApiError
+     */
+    static rotateRecoverCode(): CancelablePromise<TotpRecoveryCodeDTO>;
+    /**
+     * Start enforced enrollment in 2SV
+     * Start or resume enforced enrollment in two-step verification by returning the conversation details.
+     *
+     * There are two ways to enroll in two-step verification: voluntary and enforced. Enrollment is a two-step process. First, the user starts the enrollment process via <code>/start-voluntary-enrollment</code> or <code>/start-enforced-enrollment</code>. Second and final step is to complete the enrollment via <code>/complete-voluntary-enrollment</code> or <code>/complete-enforced-enrollment</code>. In the case of enforced enrollment, the conversation is started at the time of login via <code>/authenticate</code>.
+     * @param requestBody
+     * @returns TotpUserEnrollmentDTO A conversation has successfully started.
+     * @throws ApiError
+     */
+    static startEnforcedEnrollment(requestBody?: ConversationDTO): CancelablePromise<TotpUserEnrollmentDTO>;
+    /**
+     * Start authentication app update for 2SV
+     * Start the process of changing the authentication app used for two-step verification by creating a conversation.
+     * @returns TotpUserEnrollmentDTO A conversation has successfully started.
+     * @throws ApiError
+     */
+    static startEnrollmentUpdate(): CancelablePromise<TotpUserEnrollmentDTO>;
+    /**
+     * Start voluntary enrollment in 2SV
+     * Start voluntary enrollment in two-step verification by creating a conversation.
+     *
+     * There are two ways to enroll in two-step verification: voluntary and enforced. Enrollment is a two-step process. First, the user starts the enrollment process via <code>/start-voluntary-enrollment</code> or <code>/start-enforced-enrollment</code>. Second and final step is to complete the enrollment via <code>/complete-voluntary-enrollment</code> or <code>/complete-enforced-enrollment</code>. In the case of enforced enrollment, the conversation is started at the time of login via <code>/authenticate</code>.
+     * @returns TotpUserEnrollmentDTO A conversation has successfully started.
+     * @throws ApiError
+     */
+    static startVoluntaryEnrollment(): CancelablePromise<TotpUserEnrollmentDTO>;
+    /**
+     * Uneroll current user from two-step verification
+     * Unenroll the currently authenticated user from two-step verification.
+     * @returns void
+     * @throws ApiError
+     */
+    static unenroll(): CancelablePromise<void>;
+    /**
+     * Unenroll specific user from two-step verification
+     * Unenroll a user from two-step verification specified by the given username.
+     * @param userName username
+     * @param requestBody A request containing a TOTP code for the given user.
+     * @returns void
+     * @throws ApiError
+     */
+    static unenrollUser(userName: string, requestBody?: TotpElevationRestDTO): CancelablePromise<void>;
+}
+//# sourceMappingURL=AuthenticationService.d.ts.map