/** * Sonatype Lifecycle Public REST API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.207.0-01 * * * 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'; import type { ApiUserTokenDTO, ApiUserTokenExistsDTO } from '../models/index'; export interface UserTokensApiDeleteUserTokenByUserCodeRequest { userCode: string; } export interface UserTokensApiGetUserTokenByUsernameAndRealmIdRequest { username: string; realm?: string; } export interface UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest { createdAfter?: string; createdBefore?: string; realm?: string; } /** * UserTokensApi - interface * * @export * @interface UserTokensApiInterface */ export interface UserTokensApiInterface { /** * Use this method to generate a user token for the currently logged in user. Permissions required: None * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTokensApiInterface */ createUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to generate a user token for the currently logged in user. Permissions required: None */ createUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete an existing user token for the currently logged in user. Permissions required: None * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTokensApiInterface */ deleteCurrentUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete an existing user token for the currently logged in user. Permissions required: None */ deleteCurrentUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users * @param {string} userCode Enter the `userCode` to be deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTokensApiInterface */ deleteUserTokenByUserCodeRaw(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users */ deleteUserTokenByUserCode(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the creation time of the user token for the currently logged in user. Permissions required: None * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTokensApiInterface */ getCurrentUserTokenCreateTimeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the creation time of the user token for the currently logged in user. Permissions required: None */ getCurrentUserTokenCreateTime(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users * @param {string} username Enter the username. * @param {string} [realm] Enter the realmId. Possible values are `Internal`, `SAML` , `OAUTH2` , and `Crowd`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTokensApiInterface */ getUserTokenByUsernameAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users */ getUserTokenByUsernameAndRealmId(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to check if a user token has been issued to the logged in user. Permissions required: None * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTokensApiInterface */ getUserTokenExistsForCurrentUserRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to check if a user token has been issued to the logged in user. Permissions required: None */ getUserTokenExistsForCurrentUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms. Permissions required: Edit System Configuration and Users. * @param {string} [createdAfter] Enter the start date for the date range in `yyyy-mm-dd` format. * @param {string} [createdBefore] Enter the end date for the date range in `yyyy-mm-dd` format. * @param {string} [realm] Enter the `realmId`. Possible values are `Internal`, `SAML` , `OAUTH2`, and `Crowd`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTokensApiInterface */ getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms. Permissions required: Edit System Configuration and Users. */ getUserTokensByCreatedBetweenAndRealmId(requestParameters: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete all existing LDAP user tokens. Permissions required: Edit System Configuration and Users * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTokensApiInterface */ purgeUserTokensRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete all existing LDAP user tokens. Permissions required: Edit System Configuration and Users */ purgeUserTokens(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class UserTokensApi extends runtime.BaseAPI implements UserTokensApiInterface { /** * Use this method to generate a user token for the currently logged in user. Permissions required: None */ createUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to generate a user token for the currently logged in user. Permissions required: None */ createUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete an existing user token for the currently logged in user. Permissions required: None */ deleteCurrentUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete an existing user token for the currently logged in user. Permissions required: None */ deleteCurrentUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users */ deleteUserTokenByUserCodeRaw(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users */ deleteUserTokenByUserCode(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the creation time of the user token for the currently logged in user. Permissions required: None */ getCurrentUserTokenCreateTimeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the creation time of the user token for the currently logged in user. Permissions required: None */ getCurrentUserTokenCreateTime(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users */ getUserTokenByUsernameAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users */ getUserTokenByUsernameAndRealmId(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to check if a user token has been issued to the logged in user. Permissions required: None */ getUserTokenExistsForCurrentUserRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to check if a user token has been issued to the logged in user. Permissions required: None */ getUserTokenExistsForCurrentUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms. Permissions required: Edit System Configuration and Users. */ getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms. Permissions required: Edit System Configuration and Users. */ getUserTokensByCreatedBetweenAndRealmId(requestParameters?: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete all existing LDAP user tokens. Permissions required: Edit System Configuration and Users */ purgeUserTokensRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete all existing LDAP user tokens. Permissions required: Edit System Configuration and Users */ purgeUserTokens(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }