/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Certifications * 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'; /** * * @export * @interface AccessReviewItem */ export interface AccessReviewItem { /** * * @type {AccessSummary} * @memberof AccessReviewItem */ 'accessSummary'?: AccessSummary; /** * * @type {CertificationIdentitySummary} * @memberof AccessReviewItem */ 'identitySummary'?: CertificationIdentitySummary; /** * The review item\'s id * @type {string} * @memberof AccessReviewItem */ 'id'?: string; /** * Whether the review item is complete * @type {boolean} * @memberof AccessReviewItem */ 'completed'?: boolean; /** * Indicates whether the review item is for new access to a source * @type {boolean} * @memberof AccessReviewItem */ 'newAccess'?: boolean; /** * * @type {CertificationDecision} * @memberof AccessReviewItem */ 'decision'?: CertificationDecision; /** * Comments for this review item * @type {string} * @memberof AccessReviewItem */ 'comments'?: string | null; } /** * 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 CampaignReference */ export interface CampaignReference { /** * The unique ID of the campaign. * @type {string} * @memberof CampaignReference */ 'id': string; /** * The name of the campaign. * @type {string} * @memberof CampaignReference */ 'name': string; /** * The type of object that is being referenced. * @type {string} * @memberof CampaignReference */ 'type': CampaignReferenceTypeEnum; /** * The type of the campaign. * @type {string} * @memberof CampaignReference */ 'campaignType': CampaignReferenceCampaignTypeEnum; /** * The description of the campaign set by the admin who created it. * @type {string} * @memberof CampaignReference */ 'description': string | null; /** * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). * @type {string} * @memberof CampaignReference */ 'correlatedStatus': CampaignReferenceCorrelatedStatusEnum; /** * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. * @type {string} * @memberof CampaignReference */ 'mandatoryCommentRequirement': CampaignReferenceMandatoryCommentRequirementEnum; } export const CampaignReferenceTypeEnum = { Campaign: 'CAMPAIGN' } as const; export type CampaignReferenceTypeEnum = typeof CampaignReferenceTypeEnum[keyof typeof CampaignReferenceTypeEnum]; export const CampaignReferenceCampaignTypeEnum = { Manager: 'MANAGER', SourceOwner: 'SOURCE_OWNER', Search: 'SEARCH', RoleComposition: 'ROLE_COMPOSITION', MachineAccount: 'MACHINE_ACCOUNT' } as const; export type CampaignReferenceCampaignTypeEnum = typeof CampaignReferenceCampaignTypeEnum[keyof typeof CampaignReferenceCampaignTypeEnum]; export const CampaignReferenceCorrelatedStatusEnum = { Correlated: 'CORRELATED', Uncorrelated: 'UNCORRELATED' } as const; export type CampaignReferenceCorrelatedStatusEnum = typeof CampaignReferenceCorrelatedStatusEnum[keyof typeof CampaignReferenceCorrelatedStatusEnum]; export const CampaignReferenceMandatoryCommentRequirementEnum = { AllDecisions: 'ALL_DECISIONS', RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', NoDecisions: 'NO_DECISIONS' } as const; export type CampaignReferenceMandatoryCommentRequirementEnum = typeof CampaignReferenceMandatoryCommentRequirementEnum[keyof typeof CampaignReferenceMandatoryCommentRequirementEnum]; /** * The decision to approve or revoke the review item * @export * @enum {string} */ export const CertificationDecision = { Approve: 'APPROVE', Revoke: 'REVOKE' } as const; export type CertificationDecision = typeof CertificationDecision[keyof typeof CertificationDecision]; /** * * @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; } /** * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. * @export * @enum {string} */ export const CertificationPhase = { Staged: 'STAGED', Active: 'ACTIVE', Signed: 'SIGNED' } as const; export type CertificationPhase = typeof CertificationPhase[keyof typeof CertificationPhase]; /** * * @export * @interface CertificationReference */ export interface CertificationReference { /** * The id of the certification. * @type {string} * @memberof CertificationReference */ 'id'?: string; /** * The name of the certification. * @type {string} * @memberof CertificationReference */ 'name'?: string; /** * * @type {string} * @memberof CertificationReference */ 'type'?: CertificationReferenceTypeEnum; /** * * @type {Reviewer} * @memberof CertificationReference */ 'reviewer'?: Reviewer; } export const CertificationReferenceTypeEnum = { Certification: 'CERTIFICATION' } as const; export type CertificationReferenceTypeEnum = typeof CertificationReferenceTypeEnum[keyof typeof CertificationReferenceTypeEnum]; /** * * @export * @interface CertificationTask */ export interface CertificationTask { /** * The ID of the certification task. * @type {string} * @memberof CertificationTask */ 'id'?: string; /** * The type of the certification task. More values may be added in the future. * @type {string} * @memberof CertificationTask */ 'type'?: CertificationTaskTypeEnum; /** * The type of item that is being operated on by this task whose ID is stored in the targetId field. * @type {string} * @memberof CertificationTask */ 'targetType'?: CertificationTaskTargetTypeEnum; /** * The ID of the item being operated on by this task. * @type {string} * @memberof CertificationTask */ 'targetId'?: string; /** * The status of the task. * @type {string} * @memberof CertificationTask */ 'status'?: CertificationTaskStatusEnum; /** * List of error messages * @type {Array} * @memberof CertificationTask */ 'errors'?: Array; /** * Reassignment trails that lead to self certification identity * @type {Array} * @memberof CertificationTask */ 'reassignmentTrailDTOs'?: Array; /** * The date and time on which this task was created. * @type {string} * @memberof CertificationTask */ 'created'?: string; } export const CertificationTaskTypeEnum = { Reassign: 'REASSIGN', AdminReassign: 'ADMIN_REASSIGN', CompleteCertification: 'COMPLETE_CERTIFICATION', FinishCertification: 'FINISH_CERTIFICATION', CompleteCampaign: 'COMPLETE_CAMPAIGN', ActivateCampaign: 'ACTIVATE_CAMPAIGN', CampaignCreate: 'CAMPAIGN_CREATE', CampaignDelete: 'CAMPAIGN_DELETE' } as const; export type CertificationTaskTypeEnum = typeof CertificationTaskTypeEnum[keyof typeof CertificationTaskTypeEnum]; export const CertificationTaskTargetTypeEnum = { Certification: 'CERTIFICATION', Campaign: 'CAMPAIGN' } as const; export type CertificationTaskTargetTypeEnum = typeof CertificationTaskTargetTypeEnum[keyof typeof CertificationTaskTargetTypeEnum]; export const CertificationTaskStatusEnum = { Queued: 'QUEUED', InProgress: 'IN_PROGRESS', Success: 'SUCCESS', Error: 'ERROR' } as const; export type CertificationTaskStatusEnum = typeof CertificationTaskStatusEnum[keyof typeof CertificationTaskStatusEnum]; /** * 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 IdentityCertificationDto */ export interface IdentityCertificationDto { /** * id of the certification * @type {string} * @memberof IdentityCertificationDto */ 'id'?: string; /** * name of the certification * @type {string} * @memberof IdentityCertificationDto */ 'name'?: string; /** * * @type {CampaignReference} * @memberof IdentityCertificationDto */ 'campaign'?: CampaignReference; /** * Have all decisions been made? * @type {boolean} * @memberof IdentityCertificationDto */ 'completed'?: boolean; /** * The number of identities for whom all decisions have been made and are complete. * @type {number} * @memberof IdentityCertificationDto */ 'identitiesCompleted'?: number; /** * The total number of identities in the Certification, both complete and incomplete. * @type {number} * @memberof IdentityCertificationDto */ 'identitiesTotal'?: number; /** * created date * @type {string} * @memberof IdentityCertificationDto */ 'created'?: string; /** * modified date * @type {string} * @memberof IdentityCertificationDto */ 'modified'?: string; /** * The number of approve/revoke/acknowledge decisions that have been made. * @type {number} * @memberof IdentityCertificationDto */ 'decisionsMade'?: number; /** * The total number of approve/revoke/acknowledge decisions. * @type {number} * @memberof IdentityCertificationDto */ 'decisionsTotal'?: number; /** * The due date of the certification. * @type {string} * @memberof IdentityCertificationDto */ 'due'?: string | null; /** * The date the reviewer signed off on the Certification. * @type {string} * @memberof IdentityCertificationDto */ 'signed'?: string | null; /** * * @type {Reviewer} * @memberof IdentityCertificationDto */ 'reviewer'?: Reviewer; /** * * @type {Reassignment} * @memberof IdentityCertificationDto */ 'reassignment'?: Reassignment | null; /** * Identifies if the certification has an error * @type {boolean} * @memberof IdentityCertificationDto */ 'hasErrors'?: boolean; /** * Description of the certification error * @type {string} * @memberof IdentityCertificationDto */ 'errorMessage'?: string | null; /** * * @type {CertificationPhase} * @memberof IdentityCertificationDto */ 'phase'?: CertificationPhase; } /** * * @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; } /** * * @export * @interface ListIdentityCertificationsV1401Response */ export interface ListIdentityCertificationsV1401Response { /** * A message describing the error * @type {any} * @memberof ListIdentityCertificationsV1401Response */ 'error'?: any; } /** * * @export * @interface ListIdentityCertificationsV1429Response */ export interface ListIdentityCertificationsV1429Response { /** * A message describing the error * @type {any} * @memberof ListIdentityCertificationsV1429Response */ '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]; /** * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. * @export * @interface PermissionDTO */ export interface PermissionDTO { /** * All the rights (e.g. actions) that this permission allows on the target * @type {Array} * @memberof PermissionDTO */ 'rights'?: Array; /** * The target the permission would grants rights on. * @type {string} * @memberof PermissionDTO */ 'target'?: string; } /** * * @export * @interface ReassignReference */ export interface ReassignReference { /** * The ID of item or identity being reassigned. * @type {string} * @memberof ReassignReference */ 'id': string; /** * The type of item or identity being reassigned. * @type {string} * @memberof ReassignReference */ 'type': ReassignReferenceTypeEnum; } export const ReassignReferenceTypeEnum = { TargetSummary: 'TARGET_SUMMARY', Item: 'ITEM', IdentitySummary: 'IDENTITY_SUMMARY' } as const; export type ReassignReferenceTypeEnum = typeof ReassignReferenceTypeEnum[keyof typeof ReassignReferenceTypeEnum]; /** * * @export * @interface Reassignment */ export interface Reassignment { /** * * @type {CertificationReference} * @memberof Reassignment */ 'from'?: CertificationReference; /** * The comment entered when the Certification was reassigned * @type {string} * @memberof Reassignment */ 'comment'?: string; } /** * * @export * @interface ReassignmentTrailDTO */ export interface ReassignmentTrailDTO { /** * The ID of previous owner identity. * @type {string} * @memberof ReassignmentTrailDTO */ 'previousOwner'?: string; /** * The ID of new owner identity. * @type {string} * @memberof ReassignmentTrailDTO */ 'newOwner'?: string; /** * The type of reassignment. * @type {string} * @memberof ReassignmentTrailDTO */ 'reassignmentType'?: string; } /** * * @export * @interface ReviewDecision */ export interface ReviewDecision { /** * The id of the review decision * @type {string} * @memberof ReviewDecision */ 'id': string; /** * * @type {CertificationDecision} * @memberof ReviewDecision */ 'decision': CertificationDecision; /** * The date at which a user\'s access should be taken away. Should only be set for `REVOKE` decisions. * @type {string} * @memberof ReviewDecision */ 'proposedEndDate'?: string; /** * Indicates whether decision should be marked as part of a larger bulk decision * @type {boolean} * @memberof ReviewDecision */ 'bulk': boolean; /** * * @type {ReviewRecommendation} * @memberof ReviewDecision */ 'recommendation'?: ReviewRecommendation; /** * Comments recorded when the decision was made * @type {string} * @memberof ReviewDecision */ 'comments'?: string; } /** * * @export * @interface ReviewReassign */ export interface ReviewReassign { /** * * @type {Array} * @memberof ReviewReassign */ 'reassign': Array; /** * The ID of the identity to which the certification is reassigned * @type {string} * @memberof ReviewReassign */ 'reassignTo': string; /** * The reason comment for why the reassign was made * @type {string} * @memberof ReviewReassign */ 'reason': string; } /** * * @export * @interface ReviewRecommendation */ export interface ReviewRecommendation { /** * The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. * @type {string} * @memberof ReviewRecommendation */ 'recommendation'?: string | null; /** * A list of reasons for the recommendation. * @type {Array} * @memberof ReviewRecommendation */ 'reasons'?: Array; /** * The time at which the recommendation was recorded. * @type {string} * @memberof ReviewRecommendation */ 'timestamp'?: string; } /** * * @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; } /** * * @export * @interface Reviewer */ export interface Reviewer { /** * The id of the reviewer. * @type {string} * @memberof Reviewer */ 'id'?: string; /** * The name of the reviewer. * @type {string} * @memberof Reviewer */ 'name'?: string; /** * The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. * @type {string} * @memberof Reviewer */ 'email'?: string | null; /** * The type of the reviewing identity. * @type {string} * @memberof Reviewer */ 'type'?: ReviewerTypeEnum; /** * The created date of the reviewing identity. * @type {string} * @memberof Reviewer */ 'created'?: string | null; /** * The modified date of the reviewing identity. * @type {string} * @memberof Reviewer */ 'modified'?: string | null; } export const ReviewerTypeEnum = { Identity: 'IDENTITY', GovernanceGroup: 'GOVERNANCE_GROUP' } as const; export type ReviewerTypeEnum = typeof ReviewerTypeEnum[keyof typeof ReviewerTypeEnum]; /** * CertificationsApi - axios parameter creator * @export */ export const CertificationsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. * @summary Certification task by id * @param {string} id The task ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCertificationTaskV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getCertificationTaskV1', 'id', id) const localVarPath = `/certification-tasks/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 API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. * @summary Permissions for entitlement certification item * @param {string} certificationId The certification ID * @param {string} itemId The certification item 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 * @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 {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityCertificationItemPermissionsV1: async (certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'certificationId' is not null or undefined assertParamExists('getIdentityCertificationItemPermissionsV1', 'certificationId', certificationId) // verify required parameter 'itemId' is not null or undefined assertParamExists('getIdentityCertificationItemPermissionsV1', 'itemId', itemId) const localVarPath = `/certifications/v1/{certificationId}/access-review-items/{itemId}/permissions` .replace(`{${"certificationId"}}`, encodeURIComponent(String(certificationId))) .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // 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; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } 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 single identity campaign certification by its ID. Reviewers for this certification can also call this API. * @summary Identity certification by id * @param {string} id The certification id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityCertificationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentityCertificationV1', 'id', id) const localVarPath = `/certifications/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 API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. * @summary List of pending certification tasks * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. * @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* **targetId**: *eq, in* **type**: *eq, in* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPendingCertificationTasksV1: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/certification-tasks/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 (reviewerIdentity !== undefined) { localVarQueryParameter['reviewer-identity'] = reviewerIdentity; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } 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 reviewers for the certification. Reviewers for this certification can also call this API. * @summary List of reviewers for certification * @param {string} id The 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* **name**: *eq, sw* **email**: *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, email** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listCertificationReviewersV1: 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('listCertificationReviewersV1', 'id', id) const localVarPath = `/certifications/v1/{id}/reviewers` .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 a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary List of access review items * @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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentityAccessReviewItemsV1: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('listIdentityAccessReviewItemsV1', 'id', id) const localVarPath = `/certifications/v1/{id}/access-review-items` .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; } if (entitlements !== undefined) { localVarQueryParameter['entitlements'] = entitlements; } if (accessProfiles !== undefined) { localVarQueryParameter['access-profiles'] = accessProfiles; } if (roles !== undefined) { localVarQueryParameter['roles'] = roles; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. * @summary List identity campaign certifications * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. * @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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* * @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, due, signed** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentityCertificationsV1: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/certifications/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 (reviewerIdentity !== undefined) { localVarQueryParameter['reviewer-identity'] = reviewerIdentity; } 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, }; }, /** * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Decide on a certification item * @param {string} id The ID of the identity campaign certification on which to make decisions * @param {Array} reviewDecision A non-empty array of decisions to be made. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ makeIdentityDecisionV1: async (id: string, reviewDecision: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('makeIdentityDecisionV1', 'id', id) // verify required parameter 'reviewDecision' is not null or undefined assertParamExists('makeIdentityDecisionV1', 'reviewDecision', reviewDecision) const localVarPath = `/certifications/v1/{id}/decide` .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: '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(reviewDecision, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Reassign identities or items * @param {string} id The identity campaign certification ID * @param {ReviewReassign} reviewReassign * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ reassignIdentityCertificationsV1: async (id: string, reviewReassign: ReviewReassign, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('reassignIdentityCertificationsV1', 'id', id) // verify required parameter 'reviewReassign' is not null or undefined assertParamExists('reassignIdentityCertificationsV1', 'reviewReassign', reviewReassign) const localVarPath = `/certifications/v1/{id}/reassign` .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: '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(reviewReassign, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Finalize identity certification decisions * @param {string} id The identity campaign certification ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ signOffIdentityCertificationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('signOffIdentityCertificationV1', 'id', id) const localVarPath = `/certifications/v1/{id}/sign-off` .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: 'POST', ...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 API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. * @summary Reassign certifications asynchronously * @param {string} id The identity campaign certification ID * @param {ReviewReassign} reviewReassign * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitReassignCertsAsyncV1: async (id: string, reviewReassign: ReviewReassign, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('submitReassignCertsAsyncV1', 'id', id) // verify required parameter 'reviewReassign' is not null or undefined assertParamExists('submitReassignCertsAsyncV1', 'reviewReassign', reviewReassign) const localVarPath = `/certifications/v1/{id}/reassign-async` .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: '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(reviewReassign, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * CertificationsApi - functional programming interface * @export */ export const CertificationsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CertificationsApiAxiosParamCreator(configuration) return { /** * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. * @summary Certification task by id * @param {string} id The task ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getCertificationTaskV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getCertificationTaskV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.getCertificationTaskV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. * @summary Permissions for entitlement certification item * @param {string} certificationId The certification ID * @param {string} itemId The certification item 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 * @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 {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityCertificationItemPermissionsV1(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationItemPermissionsV1(certificationId, itemId, filters, limit, offset, count, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.getIdentityCertificationItemPermissionsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. * @summary Identity certification by id * @param {string} id The certification id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityCertificationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.getIdentityCertificationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. * @summary List of pending certification tasks * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. * @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* **targetId**: *eq, in* **type**: *eq, in* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getPendingCertificationTasksV1(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingCertificationTasksV1(reviewerIdentity, limit, offset, count, filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.getPendingCertificationTasksV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. * @summary List of reviewers for certification * @param {string} id The 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* **name**: *eq, sw* **email**: *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, email** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listCertificationReviewersV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listCertificationReviewersV1(id, limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.listCertificationReviewersV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary List of access review items * @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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listIdentityAccessReviewItemsV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessReviewItemsV1(id, limit, offset, count, filters, sorters, entitlements, accessProfiles, roles, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.listIdentityAccessReviewItemsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. * @summary List identity campaign certifications * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. * @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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* * @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, due, signed** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listIdentityCertificationsV1(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityCertificationsV1(reviewerIdentity, limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.listIdentityCertificationsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Decide on a certification item * @param {string} id The ID of the identity campaign certification on which to make decisions * @param {Array} reviewDecision A non-empty array of decisions to be made. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async makeIdentityDecisionV1(id: string, reviewDecision: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.makeIdentityDecisionV1(id, reviewDecision, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.makeIdentityDecisionV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Reassign identities or items * @param {string} id The identity campaign certification ID * @param {ReviewReassign} reviewReassign * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async reassignIdentityCertificationsV1(id: string, reviewReassign: ReviewReassign, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.reassignIdentityCertificationsV1(id, reviewReassign, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.reassignIdentityCertificationsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Finalize identity certification decisions * @param {string} id The identity campaign certification ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async signOffIdentityCertificationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.signOffIdentityCertificationV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.signOffIdentityCertificationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. * @summary Reassign certifications asynchronously * @param {string} id The identity campaign certification ID * @param {ReviewReassign} reviewReassign * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async submitReassignCertsAsyncV1(id: string, reviewReassign: ReviewReassign, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.submitReassignCertsAsyncV1(id, reviewReassign, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationsApi.submitReassignCertsAsyncV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * CertificationsApi - factory interface * @export */ export const CertificationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = CertificationsApiFp(configuration) return { /** * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. * @summary Certification task by id * @param {CertificationsApiGetCertificationTaskV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCertificationTaskV1(requestParameters: CertificationsApiGetCertificationTaskV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getCertificationTaskV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. * @summary Permissions for entitlement certification item * @param {CertificationsApiGetIdentityCertificationItemPermissionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityCertificationItemPermissionsV1(requestParameters: CertificationsApiGetIdentityCertificationItemPermissionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getIdentityCertificationItemPermissionsV1(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. * @summary Identity certification by id * @param {CertificationsApiGetIdentityCertificationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityCertificationV1(requestParameters: CertificationsApiGetIdentityCertificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getIdentityCertificationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. * @summary List of pending certification tasks * @param {CertificationsApiGetPendingCertificationTasksV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPendingCertificationTasksV1(requestParameters: CertificationsApiGetPendingCertificationTasksV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getPendingCertificationTasksV1(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. * @summary List of reviewers for certification * @param {CertificationsApiListCertificationReviewersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listCertificationReviewersV1(requestParameters: CertificationsApiListCertificationReviewersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listCertificationReviewersV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary List of access review items * @param {CertificationsApiListIdentityAccessReviewItemsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentityAccessReviewItemsV1(requestParameters: CertificationsApiListIdentityAccessReviewItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listIdentityAccessReviewItemsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(axios, basePath)); }, /** * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. * @summary List identity campaign certifications * @param {CertificationsApiListIdentityCertificationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentityCertificationsV1(requestParameters: CertificationsApiListIdentityCertificationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listIdentityCertificationsV1(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Decide on a certification item * @param {CertificationsApiMakeIdentityDecisionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ makeIdentityDecisionV1(requestParameters: CertificationsApiMakeIdentityDecisionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.makeIdentityDecisionV1(requestParameters.id, requestParameters.reviewDecision, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Reassign identities or items * @param {CertificationsApiReassignIdentityCertificationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ reassignIdentityCertificationsV1(requestParameters: CertificationsApiReassignIdentityCertificationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.reassignIdentityCertificationsV1(requestParameters.id, requestParameters.reviewReassign, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Finalize identity certification decisions * @param {CertificationsApiSignOffIdentityCertificationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ signOffIdentityCertificationV1(requestParameters: CertificationsApiSignOffIdentityCertificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.signOffIdentityCertificationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. * @summary Reassign certifications asynchronously * @param {CertificationsApiSubmitReassignCertsAsyncV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitReassignCertsAsyncV1(requestParameters: CertificationsApiSubmitReassignCertsAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.submitReassignCertsAsyncV1(requestParameters.id, requestParameters.reviewReassign, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for getCertificationTaskV1 operation in CertificationsApi. * @export * @interface CertificationsApiGetCertificationTaskV1Request */ export interface CertificationsApiGetCertificationTaskV1Request { /** * The task ID * @type {string} * @memberof CertificationsApiGetCertificationTaskV1 */ readonly id: string } /** * Request parameters for getIdentityCertificationItemPermissionsV1 operation in CertificationsApi. * @export * @interface CertificationsApiGetIdentityCertificationItemPermissionsV1Request */ export interface CertificationsApiGetIdentityCertificationItemPermissionsV1Request { /** * The certification ID * @type {string} * @memberof CertificationsApiGetIdentityCertificationItemPermissionsV1 */ readonly certificationId: string /** * The certification item ID * @type {string} * @memberof CertificationsApiGetIdentityCertificationItemPermissionsV1 */ readonly itemId: 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 * @type {string} * @memberof CertificationsApiGetIdentityCertificationItemPermissionsV1 */ readonly filters?: 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 CertificationsApiGetIdentityCertificationItemPermissionsV1 */ 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 CertificationsApiGetIdentityCertificationItemPermissionsV1 */ 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 CertificationsApiGetIdentityCertificationItemPermissionsV1 */ readonly count?: boolean } /** * Request parameters for getIdentityCertificationV1 operation in CertificationsApi. * @export * @interface CertificationsApiGetIdentityCertificationV1Request */ export interface CertificationsApiGetIdentityCertificationV1Request { /** * The certification id * @type {string} * @memberof CertificationsApiGetIdentityCertificationV1 */ readonly id: string } /** * Request parameters for getPendingCertificationTasksV1 operation in CertificationsApi. * @export * @interface CertificationsApiGetPendingCertificationTasksV1Request */ export interface CertificationsApiGetPendingCertificationTasksV1Request { /** * The ID of reviewer identity. *me* indicates the current user. * @type {string} * @memberof CertificationsApiGetPendingCertificationTasksV1 */ readonly reviewerIdentity?: 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 CertificationsApiGetPendingCertificationTasksV1 */ 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 CertificationsApiGetPendingCertificationTasksV1 */ 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 CertificationsApiGetPendingCertificationTasksV1 */ 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* **targetId**: *eq, in* **type**: *eq, in* * @type {string} * @memberof CertificationsApiGetPendingCertificationTasksV1 */ readonly filters?: string } /** * Request parameters for listCertificationReviewersV1 operation in CertificationsApi. * @export * @interface CertificationsApiListCertificationReviewersV1Request */ export interface CertificationsApiListCertificationReviewersV1Request { /** * The certification ID * @type {string} * @memberof CertificationsApiListCertificationReviewersV1 */ 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 CertificationsApiListCertificationReviewersV1 */ 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 CertificationsApiListCertificationReviewersV1 */ 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 CertificationsApiListCertificationReviewersV1 */ 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* **name**: *eq, sw* **email**: *eq, sw* * @type {string} * @memberof CertificationsApiListCertificationReviewersV1 */ 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, email** * @type {string} * @memberof CertificationsApiListCertificationReviewersV1 */ readonly sorters?: string } /** * Request parameters for listIdentityAccessReviewItemsV1 operation in CertificationsApi. * @export * @interface CertificationsApiListIdentityAccessReviewItemsV1Request */ export interface CertificationsApiListIdentityAccessReviewItemsV1Request { /** * The identity campaign certification ID * @type {string} * @memberof CertificationsApiListIdentityAccessReviewItemsV1 */ 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 CertificationsApiListIdentityAccessReviewItemsV1 */ 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 CertificationsApiListIdentityAccessReviewItemsV1 */ 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 CertificationsApiListIdentityAccessReviewItemsV1 */ 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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* * @type {string} * @memberof CertificationsApiListIdentityAccessReviewItemsV1 */ 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** * @type {string} * @memberof CertificationsApiListIdentityAccessReviewItemsV1 */ readonly sorters?: string /** * Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. * @type {string} * @memberof CertificationsApiListIdentityAccessReviewItemsV1 */ readonly entitlements?: string /** * Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. * @type {string} * @memberof CertificationsApiListIdentityAccessReviewItemsV1 */ readonly accessProfiles?: string /** * Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. * @type {string} * @memberof CertificationsApiListIdentityAccessReviewItemsV1 */ readonly roles?: string } /** * Request parameters for listIdentityCertificationsV1 operation in CertificationsApi. * @export * @interface CertificationsApiListIdentityCertificationsV1Request */ export interface CertificationsApiListIdentityCertificationsV1Request { /** * Reviewer\'s identity. *me* indicates the current user. * @type {string} * @memberof CertificationsApiListIdentityCertificationsV1 */ readonly reviewerIdentity?: 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 CertificationsApiListIdentityCertificationsV1 */ 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 CertificationsApiListIdentityCertificationsV1 */ 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 CertificationsApiListIdentityCertificationsV1 */ 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* * @type {string} * @memberof CertificationsApiListIdentityCertificationsV1 */ 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, due, signed** * @type {string} * @memberof CertificationsApiListIdentityCertificationsV1 */ readonly sorters?: string } /** * Request parameters for makeIdentityDecisionV1 operation in CertificationsApi. * @export * @interface CertificationsApiMakeIdentityDecisionV1Request */ export interface CertificationsApiMakeIdentityDecisionV1Request { /** * The ID of the identity campaign certification on which to make decisions * @type {string} * @memberof CertificationsApiMakeIdentityDecisionV1 */ readonly id: string /** * A non-empty array of decisions to be made. * @type {Array} * @memberof CertificationsApiMakeIdentityDecisionV1 */ readonly reviewDecision: Array } /** * Request parameters for reassignIdentityCertificationsV1 operation in CertificationsApi. * @export * @interface CertificationsApiReassignIdentityCertificationsV1Request */ export interface CertificationsApiReassignIdentityCertificationsV1Request { /** * The identity campaign certification ID * @type {string} * @memberof CertificationsApiReassignIdentityCertificationsV1 */ readonly id: string /** * * @type {ReviewReassign} * @memberof CertificationsApiReassignIdentityCertificationsV1 */ readonly reviewReassign: ReviewReassign } /** * Request parameters for signOffIdentityCertificationV1 operation in CertificationsApi. * @export * @interface CertificationsApiSignOffIdentityCertificationV1Request */ export interface CertificationsApiSignOffIdentityCertificationV1Request { /** * The identity campaign certification ID * @type {string} * @memberof CertificationsApiSignOffIdentityCertificationV1 */ readonly id: string } /** * Request parameters for submitReassignCertsAsyncV1 operation in CertificationsApi. * @export * @interface CertificationsApiSubmitReassignCertsAsyncV1Request */ export interface CertificationsApiSubmitReassignCertsAsyncV1Request { /** * The identity campaign certification ID * @type {string} * @memberof CertificationsApiSubmitReassignCertsAsyncV1 */ readonly id: string /** * * @type {ReviewReassign} * @memberof CertificationsApiSubmitReassignCertsAsyncV1 */ readonly reviewReassign: ReviewReassign } /** * CertificationsApi - object-oriented interface * @export * @class CertificationsApi * @extends {BaseAPI} */ export class CertificationsApi extends BaseAPI { /** * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. * @summary Certification task by id * @param {CertificationsApiGetCertificationTaskV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public getCertificationTaskV1(requestParameters: CertificationsApiGetCertificationTaskV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).getCertificationTaskV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. * @summary Permissions for entitlement certification item * @param {CertificationsApiGetIdentityCertificationItemPermissionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public getIdentityCertificationItemPermissionsV1(requestParameters: CertificationsApiGetIdentityCertificationItemPermissionsV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).getIdentityCertificationItemPermissionsV1(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. * @summary Identity certification by id * @param {CertificationsApiGetIdentityCertificationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public getIdentityCertificationV1(requestParameters: CertificationsApiGetIdentityCertificationV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).getIdentityCertificationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. * @summary List of pending certification tasks * @param {CertificationsApiGetPendingCertificationTasksV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public getPendingCertificationTasksV1(requestParameters: CertificationsApiGetPendingCertificationTasksV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).getPendingCertificationTasksV1(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. * @summary List of reviewers for certification * @param {CertificationsApiListCertificationReviewersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public listCertificationReviewersV1(requestParameters: CertificationsApiListCertificationReviewersV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).listCertificationReviewersV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary List of access review items * @param {CertificationsApiListIdentityAccessReviewItemsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public listIdentityAccessReviewItemsV1(requestParameters: CertificationsApiListIdentityAccessReviewItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).listIdentityAccessReviewItemsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. * @summary List identity campaign certifications * @param {CertificationsApiListIdentityCertificationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public listIdentityCertificationsV1(requestParameters: CertificationsApiListIdentityCertificationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).listIdentityCertificationsV1(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Decide on a certification item * @param {CertificationsApiMakeIdentityDecisionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public makeIdentityDecisionV1(requestParameters: CertificationsApiMakeIdentityDecisionV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).makeIdentityDecisionV1(requestParameters.id, requestParameters.reviewDecision, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Reassign identities or items * @param {CertificationsApiReassignIdentityCertificationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public reassignIdentityCertificationsV1(requestParameters: CertificationsApiReassignIdentityCertificationsV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).reassignIdentityCertificationsV1(requestParameters.id, requestParameters.reviewReassign, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. * @summary Finalize identity certification decisions * @param {CertificationsApiSignOffIdentityCertificationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public signOffIdentityCertificationV1(requestParameters: CertificationsApiSignOffIdentityCertificationV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).signOffIdentityCertificationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. * @summary Reassign certifications asynchronously * @param {CertificationsApiSubmitReassignCertsAsyncV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationsApi */ public submitReassignCertsAsyncV1(requestParameters: CertificationsApiSubmitReassignCertsAsyncV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationsApiFp(this.configuration).submitReassignCertsAsyncV1(requestParameters.id, requestParameters.reviewReassign, axiosOptions).then((request) => request(this.axios, this.basePath)); } }