/** * Identity Security Cloud API - UI Metadata * 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 type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @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 GetTenantUiMetadataV1401Response */ export interface GetTenantUiMetadataV1401Response { /** * A message describing the error * @type {any} * @memberof GetTenantUiMetadataV1401Response */ 'error'?: any; } /** * * @export * @interface GetTenantUiMetadataV1429Response */ export interface GetTenantUiMetadataV1429Response { /** * A message describing the error * @type {any} * @memberof GetTenantUiMetadataV1429Response */ '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 declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface TenantUiMetadataItemResponse */ export interface TenantUiMetadataItemResponse { /** * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. * @type {string} * @memberof TenantUiMetadataItemResponse */ 'iframeWhiteList'?: string | null; /** * Descriptor for the username input field. If you would like to reset the value use \"null\". * @type {string} * @memberof TenantUiMetadataItemResponse */ 'usernameLabel'?: string | null; /** * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". * @type {string} * @memberof TenantUiMetadataItemResponse */ 'usernameEmptyText'?: string | null; } /** * * @export * @interface TenantUiMetadataItemUpdateRequest */ export interface TenantUiMetadataItemUpdateRequest { /** * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. * @type {string} * @memberof TenantUiMetadataItemUpdateRequest */ 'iframeWhiteList'?: string | null; /** * Descriptor for the username input field. If you would like to reset the value use \"null\". * @type {string} * @memberof TenantUiMetadataItemUpdateRequest */ 'usernameLabel'?: string | null; /** * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". * @type {string} * @memberof TenantUiMetadataItemUpdateRequest */ 'usernameEmptyText'?: string | null; } /** * UIMetadataApi - axios parameter creator * @export */ export declare const UIMetadataApiAxiosParamCreator: (configuration?: Configuration) => { /** * This API endpoint retrieves UI metadata configured for your tenant. * @summary Get a tenant ui metadata * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantUiMetadataV1: (xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. * @summary Update tenant ui metadata * @param {TenantUiMetadataItemUpdateRequest} tenantUiMetadataItemUpdateRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTenantUiMetadataV1: (tenantUiMetadataItemUpdateRequest: TenantUiMetadataItemUpdateRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * UIMetadataApi - functional programming interface * @export */ export declare const UIMetadataApiFp: (configuration?: Configuration) => { /** * This API endpoint retrieves UI metadata configured for your tenant. * @summary Get a tenant ui metadata * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantUiMetadataV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. * @summary Update tenant ui metadata * @param {TenantUiMetadataItemUpdateRequest} tenantUiMetadataItemUpdateRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTenantUiMetadataV1(tenantUiMetadataItemUpdateRequest: TenantUiMetadataItemUpdateRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UIMetadataApi - factory interface * @export */ export declare const UIMetadataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This API endpoint retrieves UI metadata configured for your tenant. * @summary Get a tenant ui metadata * @param {UIMetadataApiGetTenantUiMetadataV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantUiMetadataV1(requestParameters?: UIMetadataApiGetTenantUiMetadataV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. * @summary Update tenant ui metadata * @param {UIMetadataApiSetTenantUiMetadataV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTenantUiMetadataV1(requestParameters: UIMetadataApiSetTenantUiMetadataV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getTenantUiMetadataV1 operation in UIMetadataApi. * @export * @interface UIMetadataApiGetTenantUiMetadataV1Request */ export interface UIMetadataApiGetTenantUiMetadataV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof UIMetadataApiGetTenantUiMetadataV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for setTenantUiMetadataV1 operation in UIMetadataApi. * @export * @interface UIMetadataApiSetTenantUiMetadataV1Request */ export interface UIMetadataApiSetTenantUiMetadataV1Request { /** * * @type {TenantUiMetadataItemUpdateRequest} * @memberof UIMetadataApiSetTenantUiMetadataV1 */ readonly tenantUiMetadataItemUpdateRequest: TenantUiMetadataItemUpdateRequest; /** * Use this header to enable this experimental API. * @type {string} * @memberof UIMetadataApiSetTenantUiMetadataV1 */ readonly xSailPointExperimental?: string; } /** * UIMetadataApi - object-oriented interface * @export * @class UIMetadataApi * @extends {BaseAPI} */ export declare class UIMetadataApi extends BaseAPI { /** * This API endpoint retrieves UI metadata configured for your tenant. * @summary Get a tenant ui metadata * @param {UIMetadataApiGetTenantUiMetadataV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UIMetadataApi */ getTenantUiMetadataV1(requestParameters?: UIMetadataApiGetTenantUiMetadataV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. * @summary Update tenant ui metadata * @param {UIMetadataApiSetTenantUiMetadataV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UIMetadataApi */ setTenantUiMetadataV1(requestParameters: UIMetadataApiSetTenantUiMetadataV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }