/** * Identity Security Cloud API - Public Identities Config * 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'; /** * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. * @export * @enum {string} */ export declare const DtoType: { readonly AccountCorrelationConfig: "ACCOUNT_CORRELATION_CONFIG"; readonly AccessProfile: "ACCESS_PROFILE"; readonly AccessRequestApproval: "ACCESS_REQUEST_APPROVAL"; readonly Account: "ACCOUNT"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly CampaignFilter: "CAMPAIGN_FILTER"; readonly Certification: "CERTIFICATION"; readonly Cluster: "CLUSTER"; readonly ConnectorSchema: "CONNECTOR_SCHEMA"; readonly Entitlement: "ENTITLEMENT"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; readonly Identity: "IDENTITY"; readonly IdentityProfile: "IDENTITY_PROFILE"; readonly IdentityRequest: "IDENTITY_REQUEST"; readonly MachineIdentity: "MACHINE_IDENTITY"; readonly LifecycleState: "LIFECYCLE_STATE"; readonly PasswordPolicy: "PASSWORD_POLICY"; readonly Role: "ROLE"; readonly Rule: "RULE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; readonly Tag: "TAG"; readonly TagCategory: "TAG_CATEGORY"; readonly TaskResult: "TASK_RESULT"; readonly ReportResult: "REPORT_RESULT"; readonly SodViolation: "SOD_VIOLATION"; readonly AccountActivity: "ACCOUNT_ACTIVITY"; readonly Workgroup: "WORKGROUP"; }; export type DtoType = typeof DtoType[keyof typeof DtoType]; /** * * @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 GetPublicIdentityConfigV1401Response */ export interface GetPublicIdentityConfigV1401Response { /** * A message describing the error * @type {any} * @memberof GetPublicIdentityConfigV1401Response */ 'error'?: any; } /** * * @export * @interface GetPublicIdentityConfigV1429Response */ export interface GetPublicIdentityConfigV1429Response { /** * A message describing the error * @type {any} * @memberof GetPublicIdentityConfigV1429Response */ 'message'?: any; } /** * The manager for the identity. * @export * @interface IdentityReference */ export interface IdentityReference { /** * * @type {DtoType} * @memberof IdentityReference */ 'type'?: DtoType; /** * Identity id * @type {string} * @memberof IdentityReference */ 'id'?: string; /** * Human-readable display name of identity. * @type {string} * @memberof IdentityReference */ 'name'?: string; } /** * 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]; /** * Used to map an attribute key for an Identity to its display name. * @export * @interface PublicIdentityAttributeConfig */ export interface PublicIdentityAttributeConfig { /** * The attribute key * @type {string} * @memberof PublicIdentityAttributeConfig */ 'key'?: string; /** * The attribute display name * @type {string} * @memberof PublicIdentityAttributeConfig */ 'name'?: string; } /** * Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. * @export * @interface PublicIdentityConfig */ export interface PublicIdentityConfig { /** * Up to 5 identity attributes that will be available to everyone in the org for all users in the org. * @type {Array} * @memberof PublicIdentityConfig */ 'attributes'?: Array; /** * When this configuration was last modified. * @type {string} * @memberof PublicIdentityConfig */ 'modified'?: string | null; /** * * @type {IdentityReference} * @memberof PublicIdentityConfig */ 'modifiedBy'?: IdentityReference | null; } /** * PublicIdentitiesConfigApi - axios parameter creator * @export */ export declare const PublicIdentitiesConfigApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. * @summary Get the public identities configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPublicIdentityConfigV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. * @summary Update the public identities configuration * @param {PublicIdentityConfig} publicIdentityConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePublicIdentityConfigV1: (publicIdentityConfig: PublicIdentityConfig, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * PublicIdentitiesConfigApi - functional programming interface * @export */ export declare const PublicIdentitiesConfigApiFp: (configuration?: Configuration) => { /** * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. * @summary Get the public identities configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPublicIdentityConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. * @summary Update the public identities configuration * @param {PublicIdentityConfig} publicIdentityConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePublicIdentityConfigV1(publicIdentityConfig: PublicIdentityConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PublicIdentitiesConfigApi - factory interface * @export */ export declare const PublicIdentitiesConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. * @summary Get the public identities configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPublicIdentityConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. * @summary Update the public identities configuration * @param {PublicIdentitiesConfigApiUpdatePublicIdentityConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePublicIdentityConfigV1(requestParameters: PublicIdentitiesConfigApiUpdatePublicIdentityConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for updatePublicIdentityConfigV1 operation in PublicIdentitiesConfigApi. * @export * @interface PublicIdentitiesConfigApiUpdatePublicIdentityConfigV1Request */ export interface PublicIdentitiesConfigApiUpdatePublicIdentityConfigV1Request { /** * * @type {PublicIdentityConfig} * @memberof PublicIdentitiesConfigApiUpdatePublicIdentityConfigV1 */ readonly publicIdentityConfig: PublicIdentityConfig; } /** * PublicIdentitiesConfigApi - object-oriented interface * @export * @class PublicIdentitiesConfigApi * @extends {BaseAPI} */ export declare class PublicIdentitiesConfigApi extends BaseAPI { /** * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. * @summary Get the public identities configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PublicIdentitiesConfigApi */ getPublicIdentityConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. * @summary Update the public identities configuration * @param {PublicIdentitiesConfigApiUpdatePublicIdentityConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PublicIdentitiesConfigApi */ updatePublicIdentityConfigV1(requestParameters: PublicIdentitiesConfigApiUpdatePublicIdentityConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }