/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - OAuth Clients * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * Access type of API Client indicating online or offline use * @export * @enum {string} */ export const AccessType = { Online: 'ONLINE', Offline: 'OFFLINE' } as const; export type AccessType = typeof AccessType[keyof typeof AccessType]; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * Type of an API Client indicating public or confidentials use * @export * @enum {string} */ export const ClientType = { Confidential: 'CONFIDENTIAL', Public: 'PUBLIC' } as const; export type ClientType = typeof ClientType[keyof typeof ClientType]; /** * * @export * @interface CreateOAuthClientRequest */ export interface CreateOAuthClientRequest { /** * The name of the business the API Client should belong to * @type {string} * @memberof CreateOAuthClientRequest */ 'businessName'?: string | null; /** * The homepage URL associated with the owner of the API Client * @type {string} * @memberof CreateOAuthClientRequest */ 'homepageUrl'?: string | null; /** * A human-readable name for the API Client * @type {string} * @memberof CreateOAuthClientRequest */ 'name': string | null; /** * A description of the API Client * @type {string} * @memberof CreateOAuthClientRequest */ 'description': string | null; /** * The number of seconds an access token generated for this API Client is valid for * @type {number} * @memberof CreateOAuthClientRequest */ 'accessTokenValiditySeconds': number; /** * The number of seconds a refresh token generated for this API Client is valid for * @type {number} * @memberof CreateOAuthClientRequest */ 'refreshTokenValiditySeconds'?: number; /** * A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. * @type {Array} * @memberof CreateOAuthClientRequest */ 'redirectUris'?: Array | null; /** * A list of OAuth 2.0 grant types this API Client can be used with * @type {Array} * @memberof CreateOAuthClientRequest */ 'grantTypes': Array | null; /** * * @type {AccessType} * @memberof CreateOAuthClientRequest */ 'accessType': AccessType; /** * * @type {ClientType} * @memberof CreateOAuthClientRequest */ 'type'?: ClientType; /** * An indicator of whether the API Client can be used for requests internal within the product. * @type {boolean} * @memberof CreateOAuthClientRequest */ 'internal'?: boolean; /** * An indicator of whether the API Client is enabled for use * @type {boolean} * @memberof CreateOAuthClientRequest */ 'enabled': boolean; /** * An indicator of whether the API Client supports strong authentication * @type {boolean} * @memberof CreateOAuthClientRequest */ 'strongAuthSupported'?: boolean; /** * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow * @type {boolean} * @memberof CreateOAuthClientRequest */ 'claimsSupported'?: boolean; /** * Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. * @type {Array} * @memberof CreateOAuthClientRequest */ 'scope'?: Array | null; } /** * * @export * @interface CreateOAuthClientResponse */ export interface CreateOAuthClientResponse { /** * ID of the OAuth client * @type {string} * @memberof CreateOAuthClientResponse */ 'id': string; /** * Secret of the OAuth client (This field is only returned on the intial create call.) * @type {string} * @memberof CreateOAuthClientResponse */ 'secret': string; /** * The name of the business the API Client should belong to * @type {string} * @memberof CreateOAuthClientResponse */ 'businessName': string; /** * The homepage URL associated with the owner of the API Client * @type {string} * @memberof CreateOAuthClientResponse */ 'homepageUrl': string; /** * A human-readable name for the API Client * @type {string} * @memberof CreateOAuthClientResponse */ 'name': string; /** * A description of the API Client * @type {string} * @memberof CreateOAuthClientResponse */ 'description': string; /** * The number of seconds an access token generated for this API Client is valid for * @type {number} * @memberof CreateOAuthClientResponse */ 'accessTokenValiditySeconds': number; /** * The number of seconds a refresh token generated for this API Client is valid for * @type {number} * @memberof CreateOAuthClientResponse */ 'refreshTokenValiditySeconds': number; /** * A list of the approved redirect URIs used with the authorization_code flow * @type {Array} * @memberof CreateOAuthClientResponse */ 'redirectUris': Array; /** * A list of OAuth 2.0 grant types this API Client can be used with * @type {Array} * @memberof CreateOAuthClientResponse */ 'grantTypes': Array; /** * * @type {AccessType} * @memberof CreateOAuthClientResponse */ 'accessType': AccessType; /** * * @type {ClientType} * @memberof CreateOAuthClientResponse */ 'type': ClientType; /** * An indicator of whether the API Client can be used for requests internal to IDN * @type {boolean} * @memberof CreateOAuthClientResponse */ 'internal': boolean; /** * An indicator of whether the API Client is enabled for use * @type {boolean} * @memberof CreateOAuthClientResponse */ 'enabled': boolean; /** * An indicator of whether the API Client supports strong authentication * @type {boolean} * @memberof CreateOAuthClientResponse */ 'strongAuthSupported': boolean; /** * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow * @type {boolean} * @memberof CreateOAuthClientResponse */ 'claimsSupported': boolean; /** * The date and time, down to the millisecond, when the API Client was created * @type {string} * @memberof CreateOAuthClientResponse */ 'created': string; /** * The date and time, down to the millisecond, when the API Client was last updated * @type {string} * @memberof CreateOAuthClientResponse */ 'modified': string; /** * Scopes of the API Client. * @type {Array} * @memberof CreateOAuthClientResponse */ 'scope': Array | null; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetOAuthClientResponse */ export interface GetOAuthClientResponse { /** * ID of the OAuth client * @type {string} * @memberof GetOAuthClientResponse */ 'id': string; /** * The name of the business the API Client should belong to * @type {string} * @memberof GetOAuthClientResponse */ 'businessName': string | null; /** * The homepage URL associated with the owner of the API Client * @type {string} * @memberof GetOAuthClientResponse */ 'homepageUrl': string | null; /** * A human-readable name for the API Client * @type {string} * @memberof GetOAuthClientResponse */ 'name': string; /** * A description of the API Client * @type {string} * @memberof GetOAuthClientResponse */ 'description': string | null; /** * The number of seconds an access token generated for this API Client is valid for * @type {number} * @memberof GetOAuthClientResponse */ 'accessTokenValiditySeconds': number; /** * The number of seconds a refresh token generated for this API Client is valid for * @type {number} * @memberof GetOAuthClientResponse */ 'refreshTokenValiditySeconds': number; /** * A list of the approved redirect URIs used with the authorization_code flow * @type {Array} * @memberof GetOAuthClientResponse */ 'redirectUris': Array | null; /** * A list of OAuth 2.0 grant types this API Client can be used with * @type {Array} * @memberof GetOAuthClientResponse */ 'grantTypes': Array; /** * * @type {AccessType} * @memberof GetOAuthClientResponse */ 'accessType': AccessType; /** * * @type {ClientType} * @memberof GetOAuthClientResponse */ 'type': ClientType; /** * An indicator of whether the API Client can be used for requests internal to IDN * @type {boolean} * @memberof GetOAuthClientResponse */ 'internal': boolean; /** * An indicator of whether the API Client is enabled for use * @type {boolean} * @memberof GetOAuthClientResponse */ 'enabled': boolean; /** * An indicator of whether the API Client supports strong authentication * @type {boolean} * @memberof GetOAuthClientResponse */ 'strongAuthSupported': boolean; /** * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow * @type {boolean} * @memberof GetOAuthClientResponse */ 'claimsSupported': boolean; /** * The date and time, down to the millisecond, when the API Client was created * @type {string} * @memberof GetOAuthClientResponse */ 'created': string; /** * The date and time, down to the millisecond, when the API Client was last updated * @type {string} * @memberof GetOAuthClientResponse */ 'modified': string; /** * * @type {string} * @memberof GetOAuthClientResponse */ 'secret'?: string | null; /** * * @type {string} * @memberof GetOAuthClientResponse */ 'metadata'?: string | null; /** * The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. * @type {string} * @memberof GetOAuthClientResponse */ 'lastUsed'?: string | null; /** * Scopes of the API Client. * @type {Array} * @memberof GetOAuthClientResponse */ 'scope': Array | null; } /** * OAuth2 Grant Type * @export * @enum {string} */ export const GrantType = { ClientCredentials: 'CLIENT_CREDENTIALS', AuthorizationCode: 'AUTHORIZATION_CODE', RefreshToken: 'REFRESH_TOKEN' } as const; export type GrantType = typeof GrantType[keyof typeof GrantType]; /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export const JsonPatchOperationOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy', Test: 'test' } as const; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListOauthClientsV1401Response */ export interface ListOauthClientsV1401Response { /** * A message describing the error * @type {any} * @memberof ListOauthClientsV1401Response */ 'error'?: any; } /** * * @export * @interface ListOauthClientsV1429Response */ export interface ListOauthClientsV1429Response { /** * A message describing the error * @type {any} * @memberof ListOauthClientsV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * OAuthClientsApi - axios parameter creator * @export */ export const OAuthClientsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This creates an OAuth client. * @summary Create oauth client * @param {CreateOAuthClientRequest} createOAuthClientRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createOauthClientV1: async (createOAuthClientRequest: CreateOAuthClientRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'createOAuthClientRequest' is not null or undefined assertParamExists('createOauthClientV1', 'createOAuthClientRequest', createOAuthClientRequest) const localVarPath = `/oauth-clients/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(createOAuthClientRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This deletes an OAuth client. * @summary Delete oauth client * @param {string} id The OAuth client id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteOauthClientV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteOauthClientV1', 'id', id) const localVarPath = `/oauth-clients/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets details of an OAuth client. * @summary Get oauth client * @param {string} id The OAuth client id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOauthClientV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getOauthClientV1', 'id', id) const localVarPath = `/oauth-clients/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a list of OAuth clients. * @summary List oauth clients * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listOauthClientsV1: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/oauth-clients/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This performs a targeted update to the field(s) of an OAuth client. * @summary Patch oauth client * @param {string} id The OAuth client id * @param {Array} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchOauthClientV1: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('patchOauthClientV1', 'id', id) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('patchOauthClientV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/oauth-clients/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * OAuthClientsApi - functional programming interface * @export */ export const OAuthClientsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = OAuthClientsApiAxiosParamCreator(configuration) return { /** * This creates an OAuth client. * @summary Create oauth client * @param {CreateOAuthClientRequest} createOAuthClientRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createOauthClientV1(createOAuthClientRequest: CreateOAuthClientRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createOauthClientV1(createOAuthClientRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.createOauthClientV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This deletes an OAuth client. * @summary Delete oauth client * @param {string} id The OAuth client id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteOauthClientV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOauthClientV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.deleteOauthClientV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets details of an OAuth client. * @summary Get oauth client * @param {string} id The OAuth client id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getOauthClientV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getOauthClientV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.getOauthClientV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a list of OAuth clients. * @summary List oauth clients * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listOauthClientsV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listOauthClientsV1(filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.listOauthClientsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This performs a targeted update to the field(s) of an OAuth client. * @summary Patch oauth client * @param {string} id The OAuth client id * @param {Array} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchOauthClientV1(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchOauthClientV1(id, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.patchOauthClientV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * OAuthClientsApi - factory interface * @export */ export const OAuthClientsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = OAuthClientsApiFp(configuration) return { /** * This creates an OAuth client. * @summary Create oauth client * @param {OAuthClientsApiCreateOauthClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createOauthClientV1(requestParameters: OAuthClientsApiCreateOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createOauthClientV1(requestParameters.createOAuthClientRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * This deletes an OAuth client. * @summary Delete oauth client * @param {OAuthClientsApiDeleteOauthClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteOauthClientV1(requestParameters: OAuthClientsApiDeleteOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteOauthClientV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets details of an OAuth client. * @summary Get oauth client * @param {OAuthClientsApiGetOauthClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOauthClientV1(requestParameters: OAuthClientsApiGetOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getOauthClientV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a list of OAuth clients. * @summary List oauth clients * @param {OAuthClientsApiListOauthClientsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listOauthClientsV1(requestParameters: OAuthClientsApiListOauthClientsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listOauthClientsV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This performs a targeted update to the field(s) of an OAuth client. * @summary Patch oauth client * @param {OAuthClientsApiPatchOauthClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchOauthClientV1(requestParameters: OAuthClientsApiPatchOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchOauthClientV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createOauthClientV1 operation in OAuthClientsApi. * @export * @interface OAuthClientsApiCreateOauthClientV1Request */ export interface OAuthClientsApiCreateOauthClientV1Request { /** * * @type {CreateOAuthClientRequest} * @memberof OAuthClientsApiCreateOauthClientV1 */ readonly createOAuthClientRequest: CreateOAuthClientRequest } /** * Request parameters for deleteOauthClientV1 operation in OAuthClientsApi. * @export * @interface OAuthClientsApiDeleteOauthClientV1Request */ export interface OAuthClientsApiDeleteOauthClientV1Request { /** * The OAuth client id * @type {string} * @memberof OAuthClientsApiDeleteOauthClientV1 */ readonly id: string } /** * Request parameters for getOauthClientV1 operation in OAuthClientsApi. * @export * @interface OAuthClientsApiGetOauthClientV1Request */ export interface OAuthClientsApiGetOauthClientV1Request { /** * The OAuth client id * @type {string} * @memberof OAuthClientsApiGetOauthClientV1 */ readonly id: string } /** * Request parameters for listOauthClientsV1 operation in OAuthClientsApi. * @export * @interface OAuthClientsApiListOauthClientsV1Request */ export interface OAuthClientsApiListOauthClientsV1Request { /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* * @type {string} * @memberof OAuthClientsApiListOauthClientsV1 */ readonly filters?: string } /** * Request parameters for patchOauthClientV1 operation in OAuthClientsApi. * @export * @interface OAuthClientsApiPatchOauthClientV1Request */ export interface OAuthClientsApiPatchOauthClientV1Request { /** * The OAuth client id * @type {string} * @memberof OAuthClientsApiPatchOauthClientV1 */ readonly id: string /** * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported * @type {Array} * @memberof OAuthClientsApiPatchOauthClientV1 */ readonly jsonPatchOperation: Array } /** * OAuthClientsApi - object-oriented interface * @export * @class OAuthClientsApi * @extends {BaseAPI} */ export class OAuthClientsApi extends BaseAPI { /** * This creates an OAuth client. * @summary Create oauth client * @param {OAuthClientsApiCreateOauthClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof OAuthClientsApi */ public createOauthClientV1(requestParameters: OAuthClientsApiCreateOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig) { return OAuthClientsApiFp(this.configuration).createOauthClientV1(requestParameters.createOAuthClientRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This deletes an OAuth client. * @summary Delete oauth client * @param {OAuthClientsApiDeleteOauthClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof OAuthClientsApi */ public deleteOauthClientV1(requestParameters: OAuthClientsApiDeleteOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig) { return OAuthClientsApiFp(this.configuration).deleteOauthClientV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets details of an OAuth client. * @summary Get oauth client * @param {OAuthClientsApiGetOauthClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof OAuthClientsApi */ public getOauthClientV1(requestParameters: OAuthClientsApiGetOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig) { return OAuthClientsApiFp(this.configuration).getOauthClientV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a list of OAuth clients. * @summary List oauth clients * @param {OAuthClientsApiListOauthClientsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof OAuthClientsApi */ public listOauthClientsV1(requestParameters: OAuthClientsApiListOauthClientsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return OAuthClientsApiFp(this.configuration).listOauthClientsV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This performs a targeted update to the field(s) of an OAuth client. * @summary Patch oauth client * @param {OAuthClientsApiPatchOauthClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof OAuthClientsApi */ public patchOauthClientV1(requestParameters: OAuthClientsApiPatchOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig) { return OAuthClientsApiFp(this.configuration).patchOauthClientV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } }