/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Certification Summaries * 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'; /** * An object holding the access that is being reviewed * @export * @interface AccessSummary */ export interface AccessSummary { /** * * @type {AccessSummaryAccess} * @memberof AccessSummary */ 'access'?: AccessSummaryAccess; /** * * @type {ReviewableEntitlement} * @memberof AccessSummary */ 'entitlement'?: ReviewableEntitlement | null; /** * * @type {ReviewableAccessProfile} * @memberof AccessSummary */ 'accessProfile'?: ReviewableAccessProfile; /** * * @type {ReviewableRole} * @memberof AccessSummary */ 'role'?: ReviewableRole | null; } /** * * @export * @interface AccessSummaryAccess */ export interface AccessSummaryAccess { /** * * @type {DtoType} * @memberof AccessSummaryAccess */ 'type'?: DtoType; /** * The ID of the item being certified * @type {string} * @memberof AccessSummaryAccess */ 'id'?: string; /** * The name of the item being certified * @type {string} * @memberof AccessSummaryAccess */ 'name'?: string; } /** * Insights into account activity * @export * @interface ActivityInsights */ export interface ActivityInsights { /** * UUID of the account * @type {string} * @memberof ActivityInsights */ 'accountID'?: string; /** * The number of days of activity * @type {number} * @memberof ActivityInsights */ 'usageDays'?: number; /** * Status indicating if the activity is complete or unknown * @type {string} * @memberof ActivityInsights */ 'usageDaysState'?: ActivityInsightsUsageDaysStateEnum; } export const ActivityInsightsUsageDaysStateEnum = { Complete: 'COMPLETE', Unknown: 'UNKNOWN' } as const; export type ActivityInsightsUsageDaysStateEnum = typeof ActivityInsightsUsageDaysStateEnum[keyof typeof ActivityInsightsUsageDaysStateEnum]; /** * * @export * @interface CertificationIdentitySummary */ export interface CertificationIdentitySummary { /** * The ID of the identity summary * @type {string} * @memberof CertificationIdentitySummary */ 'id'?: string; /** * Name of the linked identity * @type {string} * @memberof CertificationIdentitySummary */ 'name'?: string; /** * The ID of the identity being certified * @type {string} * @memberof CertificationIdentitySummary */ 'identityId'?: string; /** * Indicates whether the review items for the linked identity\'s certification have been completed * @type {boolean} * @memberof CertificationIdentitySummary */ 'completed'?: boolean; } /** * DAS data for the entitlement * @export * @interface DataAccess */ export interface DataAccess { /** * List of classification policies that apply to resources the entitlement \\ groups has access to * @type {Array} * @memberof DataAccess */ 'policies'?: Array; /** * List of classification categories that apply to resources the entitlement \\ groups has access to * @type {Array} * @memberof DataAccess */ 'categories'?: Array; /** * * @type {DataAccessImpactScore} * @memberof DataAccess */ 'impactScore'?: DataAccessImpactScore; } /** * * @export * @interface DataAccessCategoriesInner */ export interface DataAccessCategoriesInner { /** * Value of the category * @type {string} * @memberof DataAccessCategoriesInner */ 'value'?: string; /** * Number of matched for each category * @type {number} * @memberof DataAccessCategoriesInner */ 'matchCount'?: number; } /** * * @export * @interface DataAccessImpactScore */ export interface DataAccessImpactScore { /** * Impact Score for this data * @type {string} * @memberof DataAccessImpactScore */ 'value'?: string; } /** * * @export * @interface DataAccessPoliciesInner */ export interface DataAccessPoliciesInner { /** * Value of the policy * @type {string} * @memberof DataAccessPoliciesInner */ 'value'?: string; } /** * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. * @export * @enum {string} */ export const DtoType = { AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', AccessProfile: 'ACCESS_PROFILE', AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', Account: 'ACCOUNT', Application: 'APPLICATION', Campaign: 'CAMPAIGN', CampaignFilter: 'CAMPAIGN_FILTER', Certification: 'CERTIFICATION', Cluster: 'CLUSTER', ConnectorSchema: 'CONNECTOR_SCHEMA', Entitlement: 'ENTITLEMENT', GovernanceGroup: 'GOVERNANCE_GROUP', Identity: 'IDENTITY', IdentityProfile: 'IDENTITY_PROFILE', IdentityRequest: 'IDENTITY_REQUEST', MachineIdentity: 'MACHINE_IDENTITY', LifecycleState: 'LIFECYCLE_STATE', PasswordPolicy: 'PASSWORD_POLICY', Role: 'ROLE', Rule: 'RULE', SodPolicy: 'SOD_POLICY', Source: 'SOURCE', Tag: 'TAG', TagCategory: 'TAG_CATEGORY', TaskResult: 'TASK_RESULT', ReportResult: 'REPORT_RESULT', SodViolation: 'SOD_VIOLATION', AccountActivity: 'ACCOUNT_ACTIVITY', Workgroup: 'WORKGROUP' } as const; 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 GetIdentityDecisionSummaryV1401Response */ export interface GetIdentityDecisionSummaryV1401Response { /** * A message describing the error * @type {any} * @memberof GetIdentityDecisionSummaryV1401Response */ 'error'?: any; } /** * * @export * @interface GetIdentityDecisionSummaryV1429Response */ export interface GetIdentityDecisionSummaryV1429Response { /** * A message describing the error * @type {any} * @memberof GetIdentityDecisionSummaryV1429Response */ 'message'?: any; } /** * * @export * @interface IdentityCertDecisionSummary */ export interface IdentityCertDecisionSummary { /** * Number of entitlement decisions that have been made * @type {number} * @memberof IdentityCertDecisionSummary */ 'entitlementDecisionsMade'?: number; /** * Number of access profile decisions that have been made * @type {number} * @memberof IdentityCertDecisionSummary */ 'accessProfileDecisionsMade'?: number; /** * Number of role decisions that have been made * @type {number} * @memberof IdentityCertDecisionSummary */ 'roleDecisionsMade'?: number; /** * Number of account decisions that have been made * @type {number} * @memberof IdentityCertDecisionSummary */ 'accountDecisionsMade'?: number; /** * The total number of entitlement decisions on the certification, both complete and incomplete * @type {number} * @memberof IdentityCertDecisionSummary */ 'entitlementDecisionsTotal'?: number; /** * The total number of access profile decisions on the certification, both complete and incomplete * @type {number} * @memberof IdentityCertDecisionSummary */ 'accessProfileDecisionsTotal'?: number; /** * The total number of role decisions on the certification, both complete and incomplete * @type {number} * @memberof IdentityCertDecisionSummary */ 'roleDecisionsTotal'?: number; /** * The total number of account decisions on the certification, both complete and incomplete * @type {number} * @memberof IdentityCertDecisionSummary */ 'accountDecisionsTotal'?: number; /** * The number of entitlement decisions that have been made which were approved * @type {number} * @memberof IdentityCertDecisionSummary */ 'entitlementsApproved'?: number; /** * The number of entitlement decisions that have been made which were revoked * @type {number} * @memberof IdentityCertDecisionSummary */ 'entitlementsRevoked'?: number; /** * The number of access profile decisions that have been made which were approved * @type {number} * @memberof IdentityCertDecisionSummary */ 'accessProfilesApproved'?: number; /** * The number of access profile decisions that have been made which were revoked * @type {number} * @memberof IdentityCertDecisionSummary */ 'accessProfilesRevoked'?: number; /** * The number of role decisions that have been made which were approved * @type {number} * @memberof IdentityCertDecisionSummary */ 'rolesApproved'?: number; /** * The number of role decisions that have been made which were revoked * @type {number} * @memberof IdentityCertDecisionSummary */ 'rolesRevoked'?: number; /** * The number of account decisions that have been made which were approved * @type {number} * @memberof IdentityCertDecisionSummary */ 'accountsApproved'?: number; /** * The number of account decisions that have been made which were revoked * @type {number} * @memberof IdentityCertDecisionSummary */ 'accountsRevoked'?: number; } /** * * @export * @interface IdentityReferenceWithNameAndEmail */ export interface IdentityReferenceWithNameAndEmail { /** * The type can only be IDENTITY. This is read-only. * @type {string} * @memberof IdentityReferenceWithNameAndEmail */ 'type'?: string; /** * Identity ID. * @type {string} * @memberof IdentityReferenceWithNameAndEmail */ 'id'?: string; /** * Identity\'s human-readable display name. This is read-only. * @type {string} * @memberof IdentityReferenceWithNameAndEmail */ 'name'?: string; /** * Identity\'s email address. This is read-only. * @type {string} * @memberof IdentityReferenceWithNameAndEmail */ 'email'?: string | null; } /** * 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]; /** * * @export * @interface ReviewableAccessProfile */ export interface ReviewableAccessProfile { /** * The id of the Access Profile * @type {string} * @memberof ReviewableAccessProfile */ 'id'?: string; /** * Name of the Access Profile * @type {string} * @memberof ReviewableAccessProfile */ 'name'?: string; /** * Information about the Access Profile * @type {string} * @memberof ReviewableAccessProfile */ 'description'?: string; /** * Indicates if the entitlement is a privileged entitlement * @type {boolean} * @memberof ReviewableAccessProfile */ 'privileged'?: boolean; /** * True if the entitlement is cloud governed * @type {boolean} * @memberof ReviewableAccessProfile */ 'cloudGoverned'?: boolean; /** * The date at which a user\'s access expires * @type {string} * @memberof ReviewableAccessProfile */ 'endDate'?: string | null; /** * * @type {IdentityReferenceWithNameAndEmail} * @memberof ReviewableAccessProfile */ 'owner'?: IdentityReferenceWithNameAndEmail | null; /** * A list of entitlements associated with this Access Profile * @type {Array} * @memberof ReviewableAccessProfile */ 'entitlements'?: Array; /** * Date the Access Profile was created. * @type {string} * @memberof ReviewableAccessProfile */ 'created'?: string; /** * Date the Access Profile was last modified. * @type {string} * @memberof ReviewableAccessProfile */ 'modified'?: string; } /** * * @export * @interface ReviewableEntitlement */ export interface ReviewableEntitlement { /** * The id for the entitlement * @type {string} * @memberof ReviewableEntitlement */ 'id'?: string; /** * The name of the entitlement * @type {string} * @memberof ReviewableEntitlement */ 'name'?: string; /** * Information about the entitlement * @type {string} * @memberof ReviewableEntitlement */ 'description'?: string | null; /** * Indicates if the entitlement is a privileged entitlement * @type {boolean} * @memberof ReviewableEntitlement */ 'privileged'?: boolean; /** * * @type {IdentityReferenceWithNameAndEmail} * @memberof ReviewableEntitlement */ 'owner'?: IdentityReferenceWithNameAndEmail | null; /** * The name of the attribute on the source * @type {string} * @memberof ReviewableEntitlement */ 'attributeName'?: string; /** * The value of the attribute on the source * @type {string} * @memberof ReviewableEntitlement */ 'attributeValue'?: string; /** * The schema object type on the source used to represent the entitlement and its attributes * @type {string} * @memberof ReviewableEntitlement */ 'sourceSchemaObjectType'?: string; /** * The name of the source for which this entitlement belongs * @type {string} * @memberof ReviewableEntitlement */ 'sourceName'?: string; /** * The type of the source for which the entitlement belongs * @type {string} * @memberof ReviewableEntitlement */ 'sourceType'?: string; /** * The ID of the source for which the entitlement belongs * @type {string} * @memberof ReviewableEntitlement */ 'sourceId'?: string; /** * Indicates if the entitlement has permissions * @type {boolean} * @memberof ReviewableEntitlement */ 'hasPermissions'?: boolean; /** * Indicates if the entitlement is a representation of an account permission * @type {boolean} * @memberof ReviewableEntitlement */ 'isPermission'?: boolean; /** * Indicates whether the entitlement can be revoked * @type {boolean} * @memberof ReviewableEntitlement */ 'revocable'?: boolean; /** * True if the entitlement is cloud governed * @type {boolean} * @memberof ReviewableEntitlement */ 'cloudGoverned'?: boolean; /** * True if the entitlement has DAS data * @type {boolean} * @memberof ReviewableEntitlement */ 'containsDataAccess'?: boolean; /** * * @type {DataAccess} * @memberof ReviewableEntitlement */ 'dataAccess'?: DataAccess | null; /** * * @type {ReviewableEntitlementAccount} * @memberof ReviewableEntitlement */ 'account'?: ReviewableEntitlementAccount | null; } /** * Information about the status of the entitlement * @export * @interface ReviewableEntitlementAccount */ export interface ReviewableEntitlementAccount { /** * The native identity for this account * @type {string} * @memberof ReviewableEntitlementAccount */ 'nativeIdentity'?: string; /** * Indicates whether this account is currently disabled * @type {boolean} * @memberof ReviewableEntitlementAccount */ 'disabled'?: boolean; /** * Indicates whether this account is currently locked * @type {boolean} * @memberof ReviewableEntitlementAccount */ 'locked'?: boolean; /** * * @type {DtoType} * @memberof ReviewableEntitlementAccount */ 'type'?: DtoType; /** * The id associated with the account * @type {string} * @memberof ReviewableEntitlementAccount */ 'id'?: string | null; /** * The account name * @type {string} * @memberof ReviewableEntitlementAccount */ 'name'?: string | null; /** * When the account was created * @type {string} * @memberof ReviewableEntitlementAccount */ 'created'?: string | null; /** * When the account was last modified * @type {string} * @memberof ReviewableEntitlementAccount */ 'modified'?: string | null; /** * * @type {ActivityInsights} * @memberof ReviewableEntitlementAccount */ 'activityInsights'?: ActivityInsights; /** * Information about the account * @type {string} * @memberof ReviewableEntitlementAccount */ 'description'?: string | null; /** * The id associated with the machine Account Governance Group * @type {string} * @memberof ReviewableEntitlementAccount */ 'governanceGroupId'?: string | null; /** * * @type {ReviewableEntitlementAccountOwner} * @memberof ReviewableEntitlementAccount */ 'owner'?: ReviewableEntitlementAccountOwner | null; } /** * Information about the machine account owner * @export * @interface ReviewableEntitlementAccountOwner */ export interface ReviewableEntitlementAccountOwner { /** * The id associated with the machine account owner * @type {string} * @memberof ReviewableEntitlementAccountOwner */ 'id'?: string | null; /** * An enumeration of the types of Owner supported within the IdentityNow infrastructure. * @type {string} * @memberof ReviewableEntitlementAccountOwner */ 'type'?: ReviewableEntitlementAccountOwnerTypeEnum; /** * The machine account owner\'s display name * @type {string} * @memberof ReviewableEntitlementAccountOwner */ 'displayName'?: string | null; } export const ReviewableEntitlementAccountOwnerTypeEnum = { Identity: 'IDENTITY' } as const; export type ReviewableEntitlementAccountOwnerTypeEnum = typeof ReviewableEntitlementAccountOwnerTypeEnum[keyof typeof ReviewableEntitlementAccountOwnerTypeEnum]; /** * * @export * @interface ReviewableRole */ export interface ReviewableRole { /** * The id for the Role * @type {string} * @memberof ReviewableRole */ 'id'?: string; /** * The name of the Role * @type {string} * @memberof ReviewableRole */ 'name'?: string; /** * Information about the Role * @type {string} * @memberof ReviewableRole */ 'description'?: string; /** * Indicates if the entitlement is a privileged entitlement * @type {boolean} * @memberof ReviewableRole */ 'privileged'?: boolean; /** * * @type {IdentityReferenceWithNameAndEmail} * @memberof ReviewableRole */ 'owner'?: IdentityReferenceWithNameAndEmail | null; /** * Indicates whether the Role can be revoked or requested * @type {boolean} * @memberof ReviewableRole */ 'revocable'?: boolean; /** * The date when a user\'s access expires. * @type {string} * @memberof ReviewableRole */ 'endDate'?: string; /** * The list of Access Profiles associated with this Role * @type {Array} * @memberof ReviewableRole */ 'accessProfiles'?: Array; /** * The list of entitlements associated with this Role * @type {Array} * @memberof ReviewableRole */ 'entitlements'?: Array; } /** * CertificationSummariesApi - axios parameter creator * @export */ export const CertificationSummariesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. * @summary Access summaries * @param {string} id The identity campaign certification ID * @param {GetIdentityAccessSummariesV1TypeEnum} type The type of access review item to retrieve summaries for * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityAccessSummariesV1: async (id: string, type: GetIdentityAccessSummariesV1TypeEnum, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentityAccessSummariesV1', 'id', id) // verify required parameter 'type' is not null or undefined assertParamExists('getIdentityAccessSummariesV1', 'type', type) const localVarPath = `/certifications/v1/{id}/access-summaries/{type}` .replace(`{${"id"}}`, encodeURIComponent(String(id))) .replace(`{${"type"}}`, encodeURIComponent(String(type))); // 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 (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. * @summary Summary of certification decisions * @param {string} id The certification ID * @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: **identitySummary.id**: *eq, in* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityDecisionSummaryV1: async (id: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentityDecisionSummaryV1', 'id', id) const localVarPath = `/certifications/v1/{id}/decision-summary` .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; 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 API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. * @summary Identity summaries for campaign certification * @param {string} id The identity campaign certification ID * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @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: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitySummariesV1: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentitySummariesV1', 'id', id) const localVarPath = `/certifications/v1/{id}/identity-summaries` .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; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. * @summary Summary for identity * @param {string} id The identity campaign certification ID * @param {string} identitySummaryId The identity summary ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitySummaryV1: async (id: string, identitySummaryId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentitySummaryV1', 'id', id) // verify required parameter 'identitySummaryId' is not null or undefined assertParamExists('getIdentitySummaryV1', 'identitySummaryId', identitySummaryId) const localVarPath = `/certifications/v1/{id}/identity-summaries/{identitySummaryId}` .replace(`{${"id"}}`, encodeURIComponent(String(id))) .replace(`{${"identitySummaryId"}}`, encodeURIComponent(String(identitySummaryId))); // 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, }; }, } }; /** * CertificationSummariesApi - functional programming interface * @export */ export const CertificationSummariesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CertificationSummariesApiAxiosParamCreator(configuration) return { /** * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. * @summary Access summaries * @param {string} id The identity campaign certification ID * @param {GetIdentityAccessSummariesV1TypeEnum} type The type of access review item to retrieve summaries for * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityAccessSummariesV1(id: string, type: GetIdentityAccessSummariesV1TypeEnum, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAccessSummariesV1(id, type, limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationSummariesApi.getIdentityAccessSummariesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. * @summary Summary of certification decisions * @param {string} id The certification ID * @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: **identitySummary.id**: *eq, in* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityDecisionSummaryV1(id: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityDecisionSummaryV1(id, filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationSummariesApi.getIdentityDecisionSummaryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. * @summary Identity summaries for campaign certification * @param {string} id The identity campaign certification ID * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @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: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentitySummariesV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummariesV1(id, limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationSummariesApi.getIdentitySummariesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. * @summary Summary for identity * @param {string} id The identity campaign certification ID * @param {string} identitySummaryId The identity summary ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentitySummaryV1(id: string, identitySummaryId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummaryV1(id, identitySummaryId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationSummariesApi.getIdentitySummaryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * CertificationSummariesApi - factory interface * @export */ export const CertificationSummariesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = CertificationSummariesApiFp(configuration) return { /** * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. * @summary Access summaries * @param {CertificationSummariesApiGetIdentityAccessSummariesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityAccessSummariesV1(requestParameters: CertificationSummariesApiGetIdentityAccessSummariesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getIdentityAccessSummariesV1(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. * @summary Summary of certification decisions * @param {CertificationSummariesApiGetIdentityDecisionSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityDecisionSummaryV1(requestParameters: CertificationSummariesApiGetIdentityDecisionSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getIdentityDecisionSummaryV1(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. * @summary Identity summaries for campaign certification * @param {CertificationSummariesApiGetIdentitySummariesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitySummariesV1(requestParameters: CertificationSummariesApiGetIdentitySummariesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getIdentitySummariesV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. * @summary Summary for identity * @param {CertificationSummariesApiGetIdentitySummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitySummaryV1(requestParameters: CertificationSummariesApiGetIdentitySummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getIdentitySummaryV1(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for getIdentityAccessSummariesV1 operation in CertificationSummariesApi. * @export * @interface CertificationSummariesApiGetIdentityAccessSummariesV1Request */ export interface CertificationSummariesApiGetIdentityAccessSummariesV1Request { /** * The identity campaign certification ID * @type {string} * @memberof CertificationSummariesApiGetIdentityAccessSummariesV1 */ readonly id: string /** * The type of access review item to retrieve summaries for * @type {'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT'} * @memberof CertificationSummariesApiGetIdentityAccessSummariesV1 */ readonly type: GetIdentityAccessSummariesV1TypeEnum /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof CertificationSummariesApiGetIdentityAccessSummariesV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof CertificationSummariesApiGetIdentityAccessSummariesV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof CertificationSummariesApiGetIdentityAccessSummariesV1 */ readonly count?: boolean /** * 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* * @type {string} * @memberof CertificationSummariesApiGetIdentityAccessSummariesV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** * @type {string} * @memberof CertificationSummariesApiGetIdentityAccessSummariesV1 */ readonly sorters?: string } /** * Request parameters for getIdentityDecisionSummaryV1 operation in CertificationSummariesApi. * @export * @interface CertificationSummariesApiGetIdentityDecisionSummaryV1Request */ export interface CertificationSummariesApiGetIdentityDecisionSummaryV1Request { /** * The certification ID * @type {string} * @memberof CertificationSummariesApiGetIdentityDecisionSummaryV1 */ readonly id: string /** * 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: **identitySummary.id**: *eq, in* * @type {string} * @memberof CertificationSummariesApiGetIdentityDecisionSummaryV1 */ readonly filters?: string } /** * Request parameters for getIdentitySummariesV1 operation in CertificationSummariesApi. * @export * @interface CertificationSummariesApiGetIdentitySummariesV1Request */ export interface CertificationSummariesApiGetIdentitySummariesV1Request { /** * The identity campaign certification ID * @type {string} * @memberof CertificationSummariesApiGetIdentitySummariesV1 */ readonly id: string /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof CertificationSummariesApiGetIdentitySummariesV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof CertificationSummariesApiGetIdentitySummariesV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof CertificationSummariesApiGetIdentitySummariesV1 */ readonly count?: boolean /** * 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: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* * @type {string} * @memberof CertificationSummariesApiGetIdentitySummariesV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** * @type {string} * @memberof CertificationSummariesApiGetIdentitySummariesV1 */ readonly sorters?: string } /** * Request parameters for getIdentitySummaryV1 operation in CertificationSummariesApi. * @export * @interface CertificationSummariesApiGetIdentitySummaryV1Request */ export interface CertificationSummariesApiGetIdentitySummaryV1Request { /** * The identity campaign certification ID * @type {string} * @memberof CertificationSummariesApiGetIdentitySummaryV1 */ readonly id: string /** * The identity summary ID * @type {string} * @memberof CertificationSummariesApiGetIdentitySummaryV1 */ readonly identitySummaryId: string } /** * CertificationSummariesApi - object-oriented interface * @export * @class CertificationSummariesApi * @extends {BaseAPI} */ export class CertificationSummariesApi extends BaseAPI { /** * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. * @summary Access summaries * @param {CertificationSummariesApiGetIdentityAccessSummariesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationSummariesApi */ public getIdentityAccessSummariesV1(requestParameters: CertificationSummariesApiGetIdentityAccessSummariesV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationSummariesApiFp(this.configuration).getIdentityAccessSummariesV1(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. * @summary Summary of certification decisions * @param {CertificationSummariesApiGetIdentityDecisionSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationSummariesApi */ public getIdentityDecisionSummaryV1(requestParameters: CertificationSummariesApiGetIdentityDecisionSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationSummariesApiFp(this.configuration).getIdentityDecisionSummaryV1(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. * @summary Identity summaries for campaign certification * @param {CertificationSummariesApiGetIdentitySummariesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationSummariesApi */ public getIdentitySummariesV1(requestParameters: CertificationSummariesApiGetIdentitySummariesV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationSummariesApiFp(this.configuration).getIdentitySummariesV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. * @summary Summary for identity * @param {CertificationSummariesApiGetIdentitySummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationSummariesApi */ public getIdentitySummaryV1(requestParameters: CertificationSummariesApiGetIdentitySummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationSummariesApiFp(this.configuration).getIdentitySummaryV1(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(this.axios, this.basePath)); } } /** * @export */ export const GetIdentityAccessSummariesV1TypeEnum = { Role: 'ROLE', AccessProfile: 'ACCESS_PROFILE', Entitlement: 'ENTITLEMENT' } as const; export type GetIdentityAccessSummariesV1TypeEnum = typeof GetIdentityAccessSummariesV1TypeEnum[keyof typeof GetIdentityAccessSummariesV1TypeEnum];