/* tslint:disable */ /* eslint-disable */ /** * 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'; import { ApiUserTokenDTOFromJSON, ApiUserTokenDTOToJSON, ApiUserTokenExistsDTOFromJSON, ApiUserTokenExistsDTOToJSON, } 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 class UserTokensApi extends runtime.BaseAPI implements UserTokensApiInterface { /** * Use this method to generate a user token for the currently logged in user. Permissions required: None */ async createUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/userTokens/currentUser`; const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiUserTokenDTOFromJSON(jsonValue)); } /** * Use this method to generate a user token for the currently logged in user. Permissions required: None */ async createUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.createUserTokenRaw(initOverrides); return await response.value(); } /** * Use this method to delete an existing user token for the currently logged in user. Permissions required: None */ async deleteCurrentUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/userTokens/currentUser`; const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to delete an existing user token for the currently logged in user. Permissions required: None */ async deleteCurrentUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteCurrentUserTokenRaw(initOverrides); } /** * Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users */ async deleteUserTokenByUserCodeRaw(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['userCode'] == null) { throw new runtime.RequiredError( 'userCode', 'Required parameter "userCode" was null or undefined when calling deleteUserTokenByUserCode().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/userTokens/userCode/{userCode}`; urlPath = urlPath.replace(`{${"userCode"}}`, encodeURIComponent(String(requestParameters['userCode']))); const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users */ async deleteUserTokenByUserCode(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteUserTokenByUserCodeRaw(requestParameters, initOverrides); } /** * Use this method to retrieve the creation time of the user token for the currently logged in user. Permissions required: None */ async getCurrentUserTokenCreateTimeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/userTokens/currentUser/createTime`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response) as any; } } /** * Use this method to retrieve the creation time of the user token for the currently logged in user. Permissions required: None */ async getCurrentUserTokenCreateTime(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getCurrentUserTokenCreateTimeRaw(initOverrides); return await response.value(); } /** * Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users */ async getUserTokenByUsernameAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['username'] == null) { throw new runtime.RequiredError( 'username', 'Required parameter "username" was null or undefined when calling getUserTokenByUsernameAndRealmId().' ); } const queryParameters: any = {}; if (requestParameters['realm'] != null) { queryParameters['realm'] = requestParameters['realm']; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/userTokens/{username}`; urlPath = urlPath.replace(`{${"username"}}`, encodeURIComponent(String(requestParameters['username']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiUserTokenDTOFromJSON(jsonValue)); } /** * Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users */ async getUserTokenByUsernameAndRealmId(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getUserTokenByUsernameAndRealmIdRaw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to check if a user token has been issued to the logged in user. Permissions required: None */ async getUserTokenExistsForCurrentUserRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/userTokens/currentUser/hasToken`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiUserTokenExistsDTOFromJSON(jsonValue)); } /** * Use this method to check if a user token has been issued to the logged in user. Permissions required: None */ async getUserTokenExistsForCurrentUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getUserTokenExistsForCurrentUserRaw(initOverrides); return await response.value(); } /** * 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. */ async getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>> { const queryParameters: any = {}; if (requestParameters['createdAfter'] != null) { queryParameters['createdAfter'] = requestParameters['createdAfter']; } if (requestParameters['createdBefore'] != null) { queryParameters['createdBefore'] = requestParameters['createdBefore']; } if (requestParameters['realm'] != null) { queryParameters['realm'] = requestParameters['realm']; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/userTokens`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ApiUserTokenDTOFromJSON)); } /** * 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. */ async getUserTokensByCreatedBetweenAndRealmId(requestParameters: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const response = await this.getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to delete all existing LDAP user tokens. Permissions required: Edit System Configuration and Users */ async purgeUserTokensRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/userTokens/purge`; const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to delete all existing LDAP user tokens. Permissions required: Edit System Configuration and Users */ async purgeUserTokens(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.purgeUserTokensRaw(initOverrides); } }