/* 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 { ApiSamlConfigurationDTO, ApiSamlConfigurationResponseDTO, } from '../models/index'; import { ApiSamlConfigurationDTOFromJSON, ApiSamlConfigurationDTOToJSON, ApiSamlConfigurationResponseDTOFromJSON, ApiSamlConfigurationResponseDTOToJSON, } from '../models/index'; export interface ConfigSAMLApiInsertOrUpdateSamlConfigurationRequest { identityProviderXml?: string; samlConfiguration?: ApiSamlConfigurationDTO; } /** * ConfigSAMLApi - interface * * @export * @interface ConfigSAMLApiInterface */ export interface ConfigSAMLApiInterface { /** * Use this method to delete the SAML configuration. Permissions required: Edit System Configuration and Users. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigSAMLApiInterface */ deleteSamlConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete the SAML configuration. Permissions required: Edit System Configuration and Users. */ deleteSamlConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve IQ Server\'s metadata service provider descriptor. Permissions required: Edit System Configuration and Users * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigSAMLApiInterface */ getMetadata1Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve IQ Server\'s metadata service provider descriptor. Permissions required: Edit System Configuration and Users */ getMetadata1(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to inspect the SAML configuration. Permissions required: Edit System Configuration and Users * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigSAMLApiInterface */ getSamlConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to inspect the SAML configuration. Permissions required: Edit System Configuration and Users */ getSamlConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to enable SSO using SAML. This request uses the content type multipart/form-data to transmit the configuration to IQ Server. Permissions required: Edit System Configuration and Users * @param {string} [identityProviderXml] Enter the SAML metadata XML of your IdP. Refer to the IdP documentation to obtain this metadata. * @param {ApiSamlConfigurationDTO} [samlConfiguration] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigSAMLApiInterface */ insertOrUpdateSamlConfigurationRaw(requestParameters: ConfigSAMLApiInsertOrUpdateSamlConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to enable SSO using SAML. This request uses the content type multipart/form-data to transmit the configuration to IQ Server. Permissions required: Edit System Configuration and Users */ insertOrUpdateSamlConfiguration(requestParameters: ConfigSAMLApiInsertOrUpdateSamlConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export class ConfigSAMLApi extends runtime.BaseAPI implements ConfigSAMLApiInterface { /** * Use this method to delete the SAML configuration. Permissions required: Edit System Configuration and Users. */ async deleteSamlConfigurationRaw(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/config/saml`; const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to delete the SAML configuration. Permissions required: Edit System Configuration and Users. */ async deleteSamlConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteSamlConfigurationRaw(initOverrides); } /** * Use this method to retrieve IQ Server\'s metadata service provider descriptor. Permissions required: Edit System Configuration and Users */ async getMetadata1Raw(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/config/saml/metadata`; 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 IQ Server\'s metadata service provider descriptor. Permissions required: Edit System Configuration and Users */ async getMetadata1(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getMetadata1Raw(initOverrides); return await response.value(); } /** * Use this method to inspect the SAML configuration. Permissions required: Edit System Configuration and Users */ async getSamlConfigurationRaw(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/config/saml`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiSamlConfigurationResponseDTOFromJSON(jsonValue)); } /** * Use this method to inspect the SAML configuration. Permissions required: Edit System Configuration and Users */ async getSamlConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getSamlConfigurationRaw(initOverrides); return await response.value(); } /** * Use this method to enable SSO using SAML. This request uses the content type multipart/form-data to transmit the configuration to IQ Server. Permissions required: Edit System Configuration and Users */ async insertOrUpdateSamlConfigurationRaw(requestParameters: ConfigSAMLApiInsertOrUpdateSamlConfigurationRequest, 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}`; } } const consumes: runtime.Consume[] = [ { contentType: 'multipart/form-data' }, ]; // @ts-ignore: canConsumeForm may be unused const canConsumeForm = runtime.canConsumeForm(consumes); let formParams: { append(param: string, value: any): any }; let useForm = false; if (useForm) { formParams = new FormData(); } else { formParams = new URLSearchParams(); } if (requestParameters['identityProviderXml'] != null) { formParams.append('identityProviderXml', requestParameters['identityProviderXml'] as any); } if (requestParameters['samlConfiguration'] != null) { formParams.append('samlConfiguration', new Blob([JSON.stringify(ApiSamlConfigurationDTOToJSON(requestParameters['samlConfiguration']))], { type: "application/json", })); } let urlPath = `/api/v2/config/saml`; const response = await this.request({ path: urlPath, method: 'PUT', headers: headerParameters, query: queryParameters, body: formParams, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to enable SSO using SAML. This request uses the content type multipart/form-data to transmit the configuration to IQ Server. Permissions required: Edit System Configuration and Users */ async insertOrUpdateSamlConfiguration(requestParameters: ConfigSAMLApiInsertOrUpdateSamlConfigurationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.insertOrUpdateSamlConfigurationRaw(requestParameters, initOverrides); } }