SailPoint

MANUAL DESCRIPTION

The SailPoint integration connects Sim workflows to SailPoint Identity Security Cloud (ISC) with a Personal Access Token (PAT). Enter the tenant name from your ISC URL—or the full *.api.identitynow.com / *.api.identitynowgov.com host—plus the PAT client ID and client secret. Sim exchanges those credentials at the tenant's /oauth/token endpoint and calls SailPoint's current service-versioned endpoints, such as /identities/v1, /access-requests/v1, and /certifications/v1. There is no global API-version setting.

Create the PAT with the least-privileged scopes required by the actions in your workflow. Common read scopes include sp:search:read, idn:identity:read, idn:accounts:read, idn:entitlement:read, idn:role-unchecked:read or idn:role-checked:read, idn:access-profile:read, idn:sources:read, idn:campaign:read, idn:access-request-status:read, idn:access-request-config:read, idn:task-management:read, and idn:access-request-approvals:read. SailPoint lists idn:access-request:manage and idn:access-request-self:manage for access-request submission, idn:access-request:create for account-selection discovery, idn:access-request:manage for cancellation, idn:campaign:manage for certification decisions and sign-off, idn:access-request-approvals:manage for approval actions, idn:sources:manage for account import, and idn:entitlement:manage for entitlement import and entitlement request configuration. Some identity-governance endpoints require a user-context PAT and an appropriate SailPoint user authority in addition to an OAuth scope; scopes never grant authority beyond the PAT owner's ISC permissions.

List actions return one bounded page. Standard collections accept up to 250 records per call; role collections accept up to 50; Search accepts up to 10,000. Use offset, sorters, or Search's searchAfter cursor to continue. Enable count only when you need the provider's X-Total-Count header. Omitting Search indices searches every index allowed by SailPoint; complex Search request fields are available as structured JSON inputs.

Access requests are asynchronous. A successful submission returns SailPoint's newRequests and existingRequests tracking records, including the access-request IDs needed by the status tools. The standard request form applies the same requested items to every identity; use requestedForWithRequestedItems when identities need different items, dates, forms, or account selections. Use Get Account Selections before a machine grant/modify or a human multi-account request, then copy the returned source/account selection into Request Access. Account-selection discovery accepts at most 25 flat requested items. An entitlement revoke is limited to one entitlement per request, while entitlement grants are limited to 25 entitlements and 10 identities. Sim also caps other request recipient/item arrays at 250 to keep execution payloads bounded.

Use Get Access Request Config to inspect the tenant's request-on-behalf-of and machine-identity settings. Use Get Entitlement Request Config to inspect one entitlement's grant, revocation, duration, approval, and form requirements before constructing a request. These configuration reads help a workflow avoid offering a request shape the tenant or entitlement does not permit.

Account and entitlement imports upload a CSV to a source and return a task that can be followed with Get Task Status. Sim caps each uploaded CSV at 25 MiB and does not automatically poll the task. The file must be available to the workflow owner, and the source must support the corresponding import operation.

The 40 actions cover six connected workflows: search and entity lookup; account, entitlement, role, access-profile, and source inventory; access-request configuration and account-selection discovery; access request submission, cancellation, approval, rejection, and status; campaign and certification review, decision, and sign-off; and CSV import plus task monitoring. Provider-defined objects such as account attributes and Search documents remain JSON because their fields depend on the tenant, source, index, and field projection.

Usage Instructions

Read and act on identity-governance data in SailPoint Identity Security Cloud (ISC) with a Personal Access Token (PAT) exchanged through OAuth2 client credentials at https://TENANT.api.identitynow.com/oauth/token. SailPoint versions each service independently, so the integration uses current service paths such as /search/v1, /identities/v1, and /access-requests/v1; there is no shared annual API-version setting. Use a PAT whose owner has the ISC user level required by each endpoint because many identity, role, access-profile, certification, approval, and access-request operations require user context in addition to scopes. Common read scopes include sp:search:read, idn:identity:read, idn:accounts:read, idn:entitlement:read, idn:role-unchecked:read or idn:role-checked:read, idn:access-profile:read, idn:sources:read, idn:campaign:read, idn:access-request-status:read, idn:access-request-config:read, idn:task-management:read, and idn:access-request-approvals:read. Mutations additionally use idn:sources:manage for account aggregation, idn:entitlement:manage for entitlement aggregation and entitlement request configuration, idn:campaign:manage for certification decisions and sign-off, the access-request scopes listed by SailPoint for request submission, idn:access-request:create for account-selection discovery, and idn:access-request-approvals:manage for approval actions. A scope alone does not grant authority beyond the PAT owner's ISC permissions, and authorization failures may be returned as provider errors or filtered visibility depending on the endpoint and tenant policy.

Actions

SailPoint Approve Access Request

Approve one pending access-request approval.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
approvalIdstringYesApproval ID
commentstringNoOptional reviewer comment

Output

ParameterTypeDescription
acceptedbooleanWhether SailPoint accepted the asynchronous action
statusnumberProvider response status (normally 202)

SailPoint Cancel Access Request

Cancel an access request that has not passed approval.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
accountActivityIdstringYesAccount activity / identity request ID
commentstringYesCancellation reason

Output

ParameterTypeDescription
acceptedbooleanWhether SailPoint accepted the asynchronous action
statusnumberProvider response status (normally 202)

SailPoint Decide Certification Review Items

Approve or revoke 1-250 review items in an identity certification.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesCertification ID
decisionsarrayYesArray of {id, decision: APPROVE|REVOKE, bulk, proposedEndDate?, recommendation?, comments?}

Output

ParameterTypeDescription
certificationobjectUpdated identity certification
idstringCertification ID
namestringCertification name
campaignjsonCampaign reference
completedbooleanWhether all decisions are complete
identitiesCompletednumberIdentities fully reviewed
identitiesTotalnumberTotal identities
createdstringCreation timestamp
modifiedstringLast modification timestamp
decisionsMadenumberDecisions made
decisionsTotalnumberTotal decisions
duestringCertification due timestamp
signedstringSign-off timestamp
reviewerjsonReviewer reference
reassignmentjsonReassignment details
hasErrorsbooleanWhether the certification has errors
errorMessagestringCertification error message
phasestringCertification phase

SailPoint Get Access Profile

Get an access profile by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesAccess profile ID

Output

ParameterTypeDescription
accessProfileobjectSailPoint access profile
idstringAccess profile ID
namestringAccess profile name
descriptionstringAccess profile description
createdstringCreation timestamp
modifiedstringLast modification timestamp
enabledbooleanWhether the access profile is enabled
ownerjsonPrimary owner reference
sourcejsonSource reference
entitlementsarrayEntitlement references
requestablebooleanWhether the access profile is requestable
accessRequestConfigjsonAccess-request configuration
revocationRequestConfigjsonRevocation-request configuration
segmentsarraySegment IDs
accessModelMetadatajsonAccess-model metadata
provisioningCriteriajsonMulti-account provisioning criteria
additionalOwnersarrayAdditional owner references

SailPoint Get Access Profile Entitlements

List entitlements in one access profile.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesAccess profile ID
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayEntitlements in this access profile
idstringEntitlement ID
namestringEntitlement name
attributestringSource entitlement attribute
valuestringSource entitlement value
sourceSchemaObjectTypestringSource schema object type
descriptionstringEntitlement description
privilegedbooleanWhether the entitlement is privileged
cloudGovernedbooleanWhether SailPoint governs the entitlement
requestablebooleanWhether the entitlement is requestable
ownerobjectPrimary owner reference
idstringIdentity ID
typestringIDENTITY
namestringIdentity display name
additionalOwnersarrayAdditional owner references
typestringIDENTITY or GOVERNANCE_GROUP
idstringIdentity or governance-group ID
namestringDisplay name
manuallyUpdatedFieldsjsonFields manually updated in SailPoint
accessModelMetadataobjectAccess-model metadata
attributesarrayAccess-model metadata attributes
keystringMetadata type identifier
namestringMetadata type display name
multiselectbooleanWhether the metadata accepts multiple values
statusstringMetadata item status
typestringMetadata item type
objectTypesarrayApplicable object types
descriptionstringMetadata item description
valuesarrayMetadata values
valuestringMetadata value
namestringMetadata value display name
statusstringMetadata value status
createdstringCreation timestamp
modifiedstringLast modification timestamp
sourceobjectSource reference
idstringSource ID
typestringSOURCE
namestringSource name
attributesjsonSource-defined entitlement attributes
segmentsarraySegment IDs
directPermissionsarrayDirect permissions
rightsarrayRights granted on the target
targetstringPermission target
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint Get Access Request Config

Get tenant access-request, request-on-behalf-of, and machine-identity configuration.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host

Output

ParameterTypeDescription
accessRequestConfigobjectTenant access-request configuration
approvalsMustBeExternalbooleanWhether approvals must be handled externally
reauthorizationEnabledbooleanWhether reauthorization is enabled
requestOnBehalfOfConfigobjectRequest-on-behalf-of policy
allowRequestOnBehalfOfAnyoneByAnyonebooleanWhether anyone may request for anyone
allowRequestOnBehalfOfEmployeeByManagerbooleanWhether managers may request for their employees
allowRequestOnBehalfOfForMachineIdentitybooleanWhether anyone may request for a machine identity
allowRequestForMachineByOwnerbooleanWhether machine owners may request for their machines
entitlementRequestConfigobjectTenant entitlement request configuration
accessRequestConfigobjectEntitlement grant request configuration
approvalSchemesarrayOrdered approval schemes
approverTypestringENTITLEMENT_OWNER, SOURCE_OWNER, MANAGER, GOVERNANCE_GROUP, or WORKFLOW
approverIdstringGovernance group or workflow approver ID
requestCommentRequiredbooleanWhether a request comment is required
denialCommentRequiredbooleanWhether a denial comment is required
reauthorizationRequiredbooleanWhether reauthorization is required
requireEndDatebooleanWhether an end date is required
maxPermittedAccessDurationobjectMaximum permitted access duration
valuenumberDuration value
timeUnitstringHOURS, DAYS, WEEKS, or MONTHS
formDefinitionIdstringRequest form definition ID
revocationRequestConfigobjectEntitlement revocation request configuration
approvalSchemesarrayOrdered revocation approval schemes
approverTypestringENTITLEMENT_OWNER, SOURCE_OWNER, MANAGER, GOVERNANCE_GROUP, or WORKFLOW
approverIdstringGovernance group or workflow approver ID
govGroupVisibilityEnabledbooleanWhether governance group visibility is enabled
machineIdentityAccessRequestEnabledbooleanWhether machine identity access requests are enabled

SailPoint Get Access Request Status

List requested-item status records for access requests.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
requestedForstringNoIdentity ID for whom the access was requested
requestedBystringNoIdentity ID that submitted the access request
regardingIdentitystringNoIdentity ID that is either the requester or the request target
assignedTostringNoIdentity ID assigned to the access-request work item
requestStatestringNoEXECUTING
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayRequested item status records in this page
idstringRequested item status ID
namestringRequested item name
typestringRequested item type
cancelledRequestDetailsjsonCancellation details
errorMessagesarrayLocalized request errors
statestringRequest state
approvalDetailsarrayApproval details
approvalIdsarrayApproval IDs
manualWorkItemDetailsarrayManual provisioning work items
accountActivityItemIdstringAccount activity item ID
requestTypestringAccess request type
modifiedstringLast modification timestamp
createdstringCreation timestamp
requesterjsonRequester reference
requestedForjsonRequested-for identity reference
identityTypestringHUMAN or MACHINE
requesterCommentjsonRequester comment
sodViolationContextjsonSeparation-of-duties violation context
provisioningDetailsjsonProvisioning details
preApprovalTriggerDetailsjsonPre-approval trigger details
accessRequestPhasesarrayRequest lifecycle phases
descriptionstringRequested object description
startDatestringRequested start date
removeDatestringRequested removal date
cancelablebooleanWhether the request can be cancelled
accessRequestIdstringAccess request ID
clientMetadatajsonCaller-provided string metadata
requestedAccountsarraySelected account references
privilegeLevelstringRequested object privilege level
jitDetailsarrayJust-in-time access details
formjsonCompleted request form
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint Get Account

Get an account from the current /accounts/v1 service by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesAccount ID

Output

ParameterTypeDescription
accountobjectSailPoint account
idstringAccount ID
namestringAccount name
createdstringCreation timestamp
modifiedstringLast modification timestamp
sourceIdstringSource ID
sourceNamestringSource name
identityIdstringCorrelated identity ID
cloudLifecycleStatestringCloud lifecycle state
identityStatestringIdentity state
connectionTypestringSource connection type
isMachinebooleanWhether this is a machine account
recommendationjsonCorrelation recommendation
attributesjsonSource-defined account attributes
authoritativebooleanWhether the account is authoritative
descriptionstringAccount description
disabledbooleanWhether the account is disabled
lockedbooleanWhether the account is locked
nativeIdentitystringNative account identifier
systemAccountbooleanWhether this is a system account
uncorrelatedbooleanWhether the account is uncorrelated
uuidstringAccount UUID
manuallyCorrelatedbooleanWhether the account was manually correlated
hasEntitlementsbooleanWhether the account has entitlements
identityjsonCorrelated identity reference
sourceOwnerjsonSource owner reference
featuresstringAccount features
originstringAccount origin
ownerIdentityjsonOwner identity reference

SailPoint Get Account Activity

Get an account activity by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesAccount activity ID

Output

ParameterTypeDescription
accountActivityobjectSailPoint account activity
idstringAccount activity ID
namestringAccount activity name
createdstringCreation timestamp
modifiedstringLast modification timestamp
completedstringCompletion timestamp
completionStatusstringCompletion status
typestringActivity type
requesterIdentitySummaryjsonRequester identity summary
targetIdentitySummaryjsonTarget identity summary
errorsarrayProvisioning errors
warningsarrayProvisioning warnings
itemsarrayAccount activity items
executionStatusstringExecution status
clientMetadatajsonCaller-provided string metadata

SailPoint Get Account Entitlements

List entitlements granted to one account.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesAccount ID
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayEntitlements on this account
idstringEntitlement ID
namestringEntitlement name
attributestringSource entitlement attribute
valuestringSource entitlement value
sourceSchemaObjectTypestringSource schema object type
descriptionstringEntitlement description
privilegedbooleanWhether the entitlement is privileged
cloudGovernedbooleanWhether SailPoint governs the entitlement
requestablebooleanWhether the entitlement is requestable
ownerobjectPrimary owner reference
idstringIdentity ID
typestringIDENTITY
namestringIdentity display name
additionalOwnersarrayAdditional owner references
typestringIDENTITY or GOVERNANCE_GROUP
idstringIdentity or governance-group ID
namestringDisplay name
manuallyUpdatedFieldsjsonFields manually updated in SailPoint
accessModelMetadataobjectAccess-model metadata
attributesarrayAccess-model metadata attributes
keystringMetadata type identifier
namestringMetadata type display name
multiselectbooleanWhether the metadata accepts multiple values
statusstringMetadata item status
typestringMetadata item type
objectTypesarrayApplicable object types
descriptionstringMetadata item description
valuesarrayMetadata values
valuestringMetadata value
namestringMetadata value display name
statusstringMetadata value status
createdstringCreation timestamp
modifiedstringLast modification timestamp
sourceobjectSource reference
idstringSource ID
typestringSOURCE
namestringSource name
attributesjsonSource-defined entitlement attributes
segmentsarraySegment IDs
directPermissionsarrayDirect permissions
rightsarrayRights granted on the target
targetstringPermission target
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint Get Account Selections

Resolve eligible source accounts before submitting a machine or multi-account access request.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
requestTypestringNoGRANT_ACCESS (default), REVOKE_ACCESS, or MODIFY_ACCESS
requestedForarrayNoHuman identity IDs for the flat request shape
requestedItemsarrayNoFlat human request items
requestedForWithRequestedItemsarrayNoPer-identity request items for account selection and all machine identity requests
clientMetadatajsonNoArbitrary string-to-string metadata returned by related APIs

Output

ParameterTypeDescription
accountSelectionsobjectEligible account selections grouped by identity and requested item
identitiesarrayIdentity-specific eligible account selections
requestedItemsarrayRequested items and their eligible accounts
descriptionstringRequested item description
accountsSelectionBlockedbooleanWhether account selection is blocked
accountsSelectionBlockedReasonstringProvider reason account selection is blocked
typestringACCESS_PROFILE, ROLE, or ENTITLEMENT
idstringRequested item ID
namestringRequested item name
sourcesarraySources and eligible accounts for this item
typestringSOURCE or provider reference type
idstringSource ID
namestringSource name
accountsarrayEligible accounts on this source
uuidstringAccount UUID
nativeIdentitystringNative account identifier
typestringACCOUNT or provider reference type
idstringAccount reference ID
namestringAccount name
accountsSelectionRequiredbooleanWhether this identity requires account selection
typestringIDENTITY, MACHINE_IDENTITY, or provider reference type
idstringIdentity ID
namestringIdentity name

SailPoint Get Campaign

Get a certification campaign by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesCampaign ID
detailstringNoSLIM or FULL

Output

ParameterTypeDescription
campaignobjectSailPoint certification campaign
idstringCampaign ID
namestringCampaign name
descriptionstringCampaign description
deadlinestringCampaign deadline
typestringCampaign type
statusstringCampaign status
correlatedStatusstringCampaign correlation status
mandatoryCommentRequirementstringDecision comment requirement
createdstringCreation timestamp
modifiedstringLast modification timestamp
recommendationsEnabledbooleanWhether recommendations are enabled
emailNotificationEnabledbooleanWhether email notifications are enabled
autoRevokeAllowedbooleanWhether automatic revocation is allowed
totalCertificationsnumberTotal certifications
completedCertificationsnumberCompleted certifications
alertsarrayCampaign alerts
filterjsonCampaign filter reference
sunsetCommentsRequiredbooleanWhether sunset-date changes require comments
sourceOwnerCampaignInfojsonSource-owner campaign configuration
searchCampaignInfojsonSearch campaign configuration
roleCompositionCampaignInfojsonRole-composition campaign configuration
machineAccountCampaignInfojsonMachine-account campaign configuration
sourcesWithOrphanEntitlementsarraySources containing orphan entitlements

SailPoint Get Certification

Get an identity certification by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesCertification ID

Output

ParameterTypeDescription
certificationobjectSailPoint identity certification
idstringCertification ID
namestringCertification name
campaignjsonCampaign reference
completedbooleanWhether all decisions are complete
identitiesCompletednumberIdentities fully reviewed
identitiesTotalnumberTotal identities
createdstringCreation timestamp
modifiedstringLast modification timestamp
decisionsMadenumberDecisions made
decisionsTotalnumberTotal decisions
duestringCertification due timestamp
signedstringSign-off timestamp
reviewerjsonReviewer reference
reassignmentjsonReassignment details
hasErrorsbooleanWhether the certification has errors
errorMessagestringCertification error message
phasestringCertification phase

SailPoint Get Entitlement

Get an entitlement by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesEntitlement ID

Output

ParameterTypeDescription
entitlementobjectSailPoint entitlement
idstringEntitlement ID
namestringEntitlement name
attributestringSource entitlement attribute
valuestringSource entitlement value
sourceSchemaObjectTypestringSource schema object type
descriptionstringEntitlement description
privilegeLevelobjectPrivilege-level details
directstringDirect privilege level assigned to the entitlement
setBystringUser or process that set the privilege level
setByTypestringMethod by which the privilege level was set
inheritedstringInherited privilege level on the entitlement
effectivestringEffective privilege level assigned to the entitlement
tagsarrayEntitlement tags
cloudGovernedbooleanWhether SailPoint governs the entitlement
requestablebooleanWhether the entitlement is requestable
ownerobjectPrimary owner reference
idstringIdentity ID
typestringIDENTITY
namestringIdentity display name
manuallyUpdatedFieldsjsonFields manually updated in SailPoint
accessModelMetadataobjectAccess-model metadata
attributesarrayAccess-model metadata attributes
keystringMetadata type identifier
namestringMetadata type display name
multiselectbooleanWhether the metadata accepts multiple values
statusstringMetadata item status
typestringMetadata item type
objectTypesarrayApplicable object types
descriptionstringMetadata item description
valuesarrayMetadata values
valuestringMetadata value
namestringMetadata value display name
statusstringMetadata value status
createdstringCreation timestamp
modifiedstringLast modification timestamp
sourceobjectSource reference
idstringSource ID
typestringSOURCE
namestringSource name
attributesjsonSource-defined entitlement attributes
segmentsarraySegment IDs
directPermissionsarrayDirect permissions
rightsarrayRights granted on the target
targetstringPermission target

SailPoint Get Entitlement Request Config

Get grant, revocation, duration, approval, and form settings for an entitlement.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesEntitlement ID

Output

ParameterTypeDescription
entitlementRequestConfigobjectEntitlement request configuration
accessRequestConfigobjectEntitlement grant request configuration
approvalSchemesarrayOrdered approval schemes
approverTypestringENTITLEMENT_OWNER, SOURCE_OWNER, MANAGER, GOVERNANCE_GROUP, or WORKFLOW
approverIdstringGovernance group or workflow approver ID
requestCommentRequiredbooleanWhether a request comment is required
denialCommentRequiredbooleanWhether a denial comment is required
reauthorizationRequiredbooleanWhether reauthorization is required
requireEndDatebooleanWhether an end date is required
maxPermittedAccessDurationobjectMaximum permitted access duration
valuenumberDuration value
timeUnitstringHOURS, DAYS, WEEKS, or MONTHS
formDefinitionIdstringRequest form definition ID
revocationRequestConfigobjectEntitlement revocation request configuration
approvalSchemesarrayOrdered revocation approval schemes
approverTypestringENTITLEMENT_OWNER, SOURCE_OWNER, MANAGER, GOVERNANCE_GROUP, or WORKFLOW
approverIdstringGovernance group or workflow approver ID

SailPoint Get Identity

Get an identity from the current /identities/v1 service by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesIdentity ID

Output

ParameterTypeDescription
identityobjectSailPoint identity
idstringIdentity ID
namestringIdentity name
createdstringCreation timestamp
modifiedstringLast modification timestamp
aliasstringIdentity alias
emailAddressstringIdentity email address
processingStatestringIdentity processing state
identityStatusstringIdentity status
managerRefjsonManager reference
isManagerbooleanWhether the identity manages other identities
lastRefreshstringLast identity refresh timestamp
attributesjsonTenant-defined identity attributes
lifecycleStatejsonLifecycle-state reference

SailPoint Get Role

Get a role by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesRole ID

Output

ParameterTypeDescription
roleobjectSailPoint role
idstringRole ID
namestringRole name
createdstringCreation timestamp
modifiedstringLast modification timestamp
descriptionstringRole description
ownerjsonPrimary owner reference
additionalOwnersarrayAdditional owner references
accessProfilesarrayAccess profile references
entitlementsarrayEntitlement references
membershipjsonRole membership selector
legacyMembershipInfojsonLegacy membership information
enabledbooleanWhether the role is enabled
requestablebooleanWhether the role is requestable
accessRequestConfigjsonAccess-request configuration
revocationRequestConfigjsonRevocation-request configuration
segmentsarraySegment IDs
dimensionalbooleanWhether the role is dimensional
dimensionRefsarrayDimension references
accessModelMetadatajsonAccess-model metadata
privilegeLevelstringRole privilege level

SailPoint Get Role Entitlements

List entitlements in one role using the current non-experimental roles service.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesRole ID
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum roles for this page (0-50; default 50)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayEntitlements in this role
idstringEntitlement ID
namestringEntitlement name
attributestringSource entitlement attribute
valuestringSource entitlement value
sourceSchemaObjectTypestringSource schema object type
descriptionstringEntitlement description
privilegedbooleanWhether the entitlement is privileged
cloudGovernedbooleanWhether SailPoint governs the entitlement
requestablebooleanWhether the entitlement is requestable
ownerobjectPrimary owner reference
idstringIdentity ID
typestringIDENTITY
namestringIdentity display name
additionalOwnersarrayAdditional owner references
typestringIDENTITY or GOVERNANCE_GROUP
idstringIdentity or governance-group ID
namestringDisplay name
manuallyUpdatedFieldsjsonFields manually updated in SailPoint
accessModelMetadataobjectAccess-model metadata
attributesarrayAccess-model metadata attributes
keystringMetadata type identifier
namestringMetadata type display name
multiselectbooleanWhether the metadata accepts multiple values
statusstringMetadata item status
typestringMetadata item type
objectTypesarrayApplicable object types
descriptionstringMetadata item description
valuesarrayMetadata values
valuestringMetadata value
namestringMetadata value display name
statusstringMetadata value status
createdstringCreation timestamp
modifiedstringLast modification timestamp
sourceobjectSource reference
idstringSource ID
typestringSOURCE
namestringSource name
attributesjsonSource-defined entitlement attributes
segmentsarraySegment IDs
directPermissionsarrayDirect permissions
rightsarrayRights granted on the target
targetstringPermission target
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint Get Source

Get an identity source by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesSource ID

Output

ParameterTypeDescription
sourceobjectSailPoint identity source
idstringSource ID
namestringSource name
descriptionstringSource description
ownerjsonSource owner reference
clusterjsonVirtual appliance cluster reference
accountCorrelationConfigjsonAccount correlation configuration
accountCorrelationRulejsonAccount correlation rule reference
managerCorrelationMappingjsonManager correlation mapping
managerCorrelationRulejsonManager correlation rule reference
beforeProvisioningRulejsonBefore-provisioning rule reference
schemasarraySource schemas
passwordPoliciesarrayPassword policy references
featuresarraySource features
typestringSource type
connectorstringConnector name
connectorClassstringConnector implementation class
connectorAttributesjsonConnector-specific attributes
deleteThresholdnumberAccount deletion threshold
authoritativebooleanWhether the source is authoritative
managementWorkgroupjsonManagement workgroup reference
healthybooleanWhether the source is healthy
statusstringSource status
sincestringStatus start timestamp
connectorIdstringConnector ID
connectorNamestringConnector display name
connectionTypestringConnection type
connectorImplementationIdstringConnector implementation ID
createdstringCreation timestamp
modifiedstringLast modification timestamp
credentialProviderEnabledbooleanWhether a credential provider is enabled
categorystringSource category

SailPoint Get Task Status

Get the current status of a SailPoint background task by ID.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesTask ID

Output

ParameterTypeDescription
taskobjectSailPoint task status
idstringTask ID
typestringTask type
uniqueNamestringTask unique name
descriptionstringTask description
parentNamestringParent task name
launcherstringTask launcher
targetobjectTask target
idstringTarget ID
typestringAPPLICATION or IDENTITY
namestringTarget name
createdstringCreation timestamp
modifiedstringLast modification timestamp
launchedstringLaunch timestamp
completedstringCompletion timestamp
completionStatusstringTask completion status
messagesarrayTask messages
typestringINFO, WARN, or ERROR
localizedTextobjectLocalized task message
localestringMessage locale
messagestringMessage text
keystringMessage key
parametersarrayInternationalization parameters
returnsarrayTask return descriptors
namestringReturn value display name
attributeNamestringTask attribute name
attributesjsonTask-specific attributes
progressstringHuman-readable progress
percentCompletenumberCompletion percentage
taskDefinitionSummaryobjectTask definition summary
idstringTask-definition ID
uniqueNamestringTask-definition unique name
descriptionstringTask-definition description
parentNamestringParent task-definition name
executorstringTask-definition executor
argumentsjsonTask-definition arguments

SailPoint List Access Profiles

List access profiles with current visibility and segmentation controls.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
forSubadminstringNoSubadmin identity ID or 'me' whose visible resources should be returned
forSegmentIdsstringNoComma-separated segment IDs used to restrict the returned resources
includeUnsegmentedbooleanNoInclude resources not assigned to a segment (default true)
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayAccess profiles in this page
idstringAccess profile ID
namestringAccess profile name
descriptionstringAccess profile description
createdstringCreation timestamp
modifiedstringLast modification timestamp
enabledbooleanWhether the access profile is enabled
ownerjsonPrimary owner reference
sourcejsonSource reference
entitlementsarrayEntitlement references
requestablebooleanWhether the access profile is requestable
accessRequestConfigjsonAccess-request configuration
revocationRequestConfigjsonRevocation-request configuration
segmentsarraySegment IDs
accessModelMetadatajsonAccess-model metadata
provisioningCriteriajsonMulti-account provisioning criteria
additionalOwnersarrayAdditional owner references
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Account Activities

List provisioning activities with identity, filter, sort, and page controls.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
requestedForstringNoTarget identity ID or 'me'; mutually exclusive with regardingIdentity
requestedBystringNoRequester identity ID or 'me'; mutually exclusive with regardingIdentity
regardingIdentitystringNoRequester-or-target identity ID or 'me'; excludes requestedFor/requestedBy
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayAccount activities in this page
idstringAccount activity ID
namestringAccount activity name
createdstringCreation timestamp
modifiedstringLast modification timestamp
completedstringCompletion timestamp
completionStatusstringCompletion status
typestringActivity type
requesterIdentitySummaryjsonRequester identity summary
targetIdentitySummaryjsonTarget identity summary
errorsarrayProvisioning errors
warningsarrayProvisioning warnings
itemsarrayAccount activity items
executionStatusstringExecution status
clientMetadatajsonCaller-provided string metadata
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Accounts

List accounts with documented filtering, sorting, detail, and pagination.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
detailLevelstringNoSLIM or FULL (default FULL)
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayAccounts in this page
idstringAccount ID
namestringAccount name
createdstringCreation timestamp
modifiedstringLast modification timestamp
sourceIdstringSource ID
sourceNamestringSource name
identityIdstringCorrelated identity ID
cloudLifecycleStatestringCloud lifecycle state
identityStatestringIdentity state
connectionTypestringSource connection type
isMachinebooleanWhether this is a machine account
recommendationjsonCorrelation recommendation
attributesjsonSource-defined account attributes
authoritativebooleanWhether the account is authoritative
descriptionstringAccount description
disabledbooleanWhether the account is disabled
lockedbooleanWhether the account is locked
nativeIdentitystringNative account identifier
systemAccountbooleanWhether this is a system account
uncorrelatedbooleanWhether the account is uncorrelated
uuidstringAccount UUID
manuallyCorrelatedbooleanWhether the account was manually correlated
hasEntitlementsbooleanWhether the account has entitlements
identityjsonCorrelated identity reference
sourceOwnerjsonSource owner reference
featuresstringAccount features
originstringAccount origin
ownerIdentityjsonOwner identity reference
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Campaigns

List certification campaigns with detail, filtering, sorting, and pagination.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
detailstringNoSLIM (default) or FULL
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayCertification campaigns in this page
idstringCampaign ID
namestringCampaign name
descriptionstringCampaign description
deadlinestringCampaign deadline
typestringCampaign type
statusstringCampaign status
correlatedStatusstringCampaign correlation status
mandatoryCommentRequirementstringDecision comment requirement
createdstringCreation timestamp
modifiedstringLast modification timestamp
recommendationsEnabledbooleanWhether recommendations are enabled
emailNotificationEnabledbooleanWhether email notifications are enabled
autoRevokeAllowedbooleanWhether automatic revocation is allowed
totalCertificationsnumberTotal certifications
completedCertificationsnumberCompleted certifications
alertsarrayCampaign alerts
filterjsonCampaign filter reference
sunsetCommentsRequiredbooleanWhether sunset-date changes require comments
sourceOwnerCampaignInfojsonSource-owner campaign configuration
searchCampaignInfojsonSearch campaign configuration
roleCompositionCampaignInfojsonRole-composition campaign configuration
machineAccountCampaignInfojsonMachine-account campaign configuration
sourcesWithOrphanEntitlementsarraySources containing orphan entitlements
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Certification Review Items

List access-review items in one identity certification.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesCertification ID
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
entitlementsstringNoComma-separated entitlement IDs
accessProfilesstringNoComma-separated access profile IDs
rolesstringNoComma-separated role IDs
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayCertification access-review items in this page
accessSummaryjsonReviewed access summary
identitySummaryjsonReviewed identity summary
idstringReview item ID
completedbooleanWhether review is complete
newAccessbooleanWhether this is newly granted access
decisionstringCurrent certification decision
commentsstringReviewer comments
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Certifications

List identity certifications assigned to a reviewer.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
reviewerIdentitystringNoReviewer identity ID or 'me'
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayIdentity certifications in this page
idstringCertification ID
namestringCertification name
campaignjsonCampaign reference
completedbooleanWhether all decisions are complete
identitiesCompletednumberIdentities fully reviewed
identitiesTotalnumberTotal identities
createdstringCreation timestamp
modifiedstringLast modification timestamp
decisionsMadenumberDecisions made
decisionsTotalnumberTotal decisions
duestringCertification due timestamp
signedstringSign-off timestamp
reviewerjsonReviewer reference
reassignmentjsonReassignment details
hasErrorsbooleanWhether the certification has errors
errorMessagestringCertification error message
phasestringCertification phase
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Entitlements

List entitlements with current segmentation, cursor, filter, and page controls.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
segmentedForIdentitystringNoIdentity ID whose visible segments restrict the results
forSegmentIdsstringNoComma-separated segment IDs used to restrict the returned resources
includeUnsegmentedbooleanNoInclude resources not assigned to a segment (default true)
searchAfterstringNoOpaque search-after cursor from the previous entitlement page
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayEntitlements in this page
idstringEntitlement ID
namestringEntitlement name
attributestringSource entitlement attribute
valuestringSource entitlement value
sourceSchemaObjectTypestringSource schema object type
descriptionstringEntitlement description
privilegeLevelobjectPrivilege-level details
directstringDirect privilege level assigned to the entitlement
setBystringUser or process that set the privilege level
setByTypestringMethod by which the privilege level was set
inheritedstringInherited privilege level on the entitlement
effectivestringEffective privilege level assigned to the entitlement
tagsarrayEntitlement tags
cloudGovernedbooleanWhether SailPoint governs the entitlement
requestablebooleanWhether the entitlement is requestable
ownerobjectPrimary owner reference
idstringIdentity ID
typestringIDENTITY
namestringIdentity display name
manuallyUpdatedFieldsjsonFields manually updated in SailPoint
accessModelMetadataobjectAccess-model metadata
attributesarrayAccess-model metadata attributes
keystringMetadata type identifier
namestringMetadata type display name
multiselectbooleanWhether the metadata accepts multiple values
statusstringMetadata item status
typestringMetadata item type
objectTypesarrayApplicable object types
descriptionstringMetadata item description
valuesarrayMetadata values
valuestringMetadata value
namestringMetadata value display name
statusstringMetadata value status
createdstringCreation timestamp
modifiedstringLast modification timestamp
sourceobjectSource reference
idstringSource ID
typestringSOURCE
namestringSource name
attributesjsonSource-defined entitlement attributes
segmentsarraySegment IDs
directPermissionsarrayDirect permissions
rightsarrayRights granted on the target
targetstringPermission target
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Identities

List identities with documented filtering, sorting, and pagination.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
defaultFilterstringNoCORRELATED_ONLY (default) or NONE
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayIdentities in this page
idstringIdentity ID
namestringIdentity name
createdstringCreation timestamp
modifiedstringLast modification timestamp
aliasstringIdentity alias
emailAddressstringIdentity email address
processingStatestringIdentity processing state
identityStatusstringIdentity status
managerRefjsonManager reference
isManagerbooleanWhether the identity manages other identities
lastRefreshstringLast identity refresh timestamp
attributesjsonTenant-defined identity attributes
lifecycleStatejsonLifecycle-state reference
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Identity Entitlements

List tagged entitlement references held by one identity.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesIdentity ID
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayEntitlements held by this identity
objectRefjsonTagged entitlement reference
tagsarrayTags applied to the entitlement
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Pending Access Request Approvals

List pending access-request approvals visible to the caller.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
ownerIdstringNoApproval owner identity ID or 'me'; admins may omit it for all approvals
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayPending access-request approvals in this page
idstringApproval ID
accessRequestIdstringAccess request ID
namestringApproval name
createdstringCreation timestamp
modifiedstringLast modification timestamp
requestCreatedstringAccess-request creation timestamp
requestTypestringGRANT_ACCESS, REVOKE_ACCESS, or MODIFY_ACCESS
identityTypestringHUMAN or MACHINE
requesterjsonRequester reference
requestedForjsonRequested-for identity reference
ownerjsonAccess item owner
requestedObjectjsonRequested access object
requesterCommentjsonRequester comment
previousReviewersCommentsarrayPrevious reviewer comments
forwardHistoryarrayApproval forwarding history
commentRequiredWhenRejectedbooleanWhether rejection requires a comment
actionInProcessstringAsynchronous action in progress
removeDatestringRequested removal date
removeDateUpdateRequestedbooleanWhether this request changes the removal date
currentRemoveDatestringRemoval date at request time
startDatestringRequested start date
startUpdateRequestedbooleanWhether this request changes the start date
currentStartDatestringStart date at request time
sodViolationContextjsonSeparation-of-duties violation context
clientMetadatajsonCaller-provided metadata
requestedAccountsarraySelected account references
privilegeLevelstringRequested object privilege level
maxPermittedAccessDurationjsonMaximum allowed access duration
jitDetailsarrayJust-in-time access details
formjsonCompleted request form
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Roles

List roles with current visibility, segmentation, filtering, and pagination controls.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
forSubadminstringNoSubadmin identity ID or 'me' whose visible resources should be returned
forSegmentIdsstringNoComma-separated segment IDs used to restrict the returned resources
includeUnsegmentedbooleanNoInclude resources not assigned to a segment (default true)
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
limitnumberNoMaximum roles for this page (0-50; default 50)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarrayRoles in this page
idstringRole ID
namestringRole name
createdstringCreation timestamp
modifiedstringLast modification timestamp
descriptionstringRole description
ownerjsonPrimary owner reference
additionalOwnersarrayAdditional owner references
accessProfilesarrayAccess profile references
entitlementsarrayEntitlement references
membershipjsonRole membership selector
legacyMembershipInfojsonLegacy membership information
enabledbooleanWhether the role is enabled
requestablebooleanWhether the role is requestable
accessRequestConfigjsonAccess-request configuration
revocationRequestConfigjsonRevocation-request configuration
segmentsarraySegment IDs
dimensionalbooleanWhether the role is dimensional
dimensionRefsarrayDimension references
accessModelMetadatajsonAccess-model metadata
privilegeLevelstringRole privilege level
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint List Sources

List identity sources with visibility, filtering, sorting, and pagination controls.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
filtersstringNoSailPoint standard collection filter expression for this operation
sortersstringNoComma-separated supported sort fields, prefixed with - for descending order
forSubadminstringNoSubadmin identity ID or 'me' whose visible resources should be returned
includeIDNSourcebooleanNoInclude the built-in IdentityNow source (default false)
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
itemsarraySources in this page
idstringSource ID
namestringSource name
descriptionstringSource description
ownerjsonSource owner reference
clusterjsonVirtual appliance cluster reference
accountCorrelationConfigjsonAccount correlation configuration
accountCorrelationRulejsonAccount correlation rule reference
managerCorrelationMappingjsonManager correlation mapping
managerCorrelationRulejsonManager correlation rule reference
beforeProvisioningRulejsonBefore-provisioning rule reference
schemasarraySource schemas
passwordPoliciesarrayPassword policy references
featuresarraySource features
typestringSource type
connectorstringConnector name
connectorClassstringConnector implementation class
connectorAttributesjsonConnector-specific attributes
deleteThresholdnumberAccount deletion threshold
authoritativebooleanWhether the source is authoritative
managementWorkgroupjsonManagement workgroup reference
healthybooleanWhether the source is healthy
statusstringSource status
sincestringStatus start timestamp
connectorIdstringConnector ID
connectorNamestringConnector display name
connectionTypestringConnection type
connectorImplementationIdstringConnector implementation ID
createdstringCreation timestamp
modifiedstringLast modification timestamp
credentialProviderEnabledbooleanWhether a credential provider is enabled
categorystringSource category
countnumberNumber of records returned in this page
totalCountnumberTotal matching records when count=true

SailPoint Load Accounts

Start account aggregation for a source, optionally using a CSV file.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
sourceIdstringYesSource ID
filefileNoDelimited-file source account CSV
disableOptimizationbooleanNoReprocess every account instead of using optimized aggregation

Output

ParameterTypeDescription
successbooleanWhether SailPoint successfully created the task
taskobjectAccount aggregation task
idstringTask ID
typestringTask type
namestringTask name
descriptionstringTask description
launcherstringTask launcher
createdstringCreation timestamp
launchedstringLaunch timestamp
completedstringCompletion timestamp
completionStatusstringTask completion status
parentNamestringParent task name
messagesarrayTask messages
typestringINFO, WARN, or ERROR
errorbooleanWhether the message is an error
warningbooleanWhether the message is a warning
keystringMessage key
localizedTextstringLocalized message text
progressstringHuman-readable progress
attributesjsonTask-specific attributes
returnsarrayTask return descriptors
displayLabelstringReturn value display label
attributeNamestringTask attribute name

SailPoint Load Entitlements

Start entitlement aggregation for a source, optionally using a CSV file.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
sourceIdstringYesSource ID
filefileNoDelimited-file source entitlement CSV

Output

ParameterTypeDescription
taskobjectEntitlement aggregation task
idstringTask ID
typestringTask type
uniqueNamestringTask unique name
descriptionstringTask description
launcherstringTask launcher
createdstringCreation timestamp
returnsarrayTask return descriptors
displayLabelstringReturn value display label
attributeNamestringTask attribute name

SailPoint Reject Access Request

Reject one pending access-request approval with a reviewer comment.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
approvalIdstringYesApproval ID
commentstringYesReviewer rejection comment

Output

ParameterTypeDescription
acceptedbooleanWhether SailPoint accepted the asynchronous action
statusnumberProvider response status (normally 202)

SailPoint Request Access

Submit a current human or machine identity access request.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
requestTypestringNoGRANT_ACCESS (default), REVOKE_ACCESS, or MODIFY_ACCESS
requestedForarrayNoHuman identity IDs for the flat request shape
requestedItemsarrayNoFlat human request items
requestedForWithRequestedItemsarrayNoPer-identity request items for account selection and all machine identity requests
clientMetadatajsonNoArbitrary string-to-string metadata returned by related APIs

Output

ParameterTypeDescription
acceptedbooleanWhether SailPoint accepted the asynchronous action
statusnumberProvider response status (normally 202)
newRequestsarrayNew access request tracking records
requestedForstringRequested-for identity ID
requestedItemsDetailsarrayRequested item references
typestringACCESS_PROFILE, ROLE, or ENTITLEMENT
idstringRequested item ID
attributesHashnumberStable request attributes hash
accessRequestIdsarrayAccess request tracking IDs
existingRequestsarrayAlready-existing request tracking records
requestedForstringRequested-for identity ID
requestedItemsDetailsarrayRequested item references
typestringACCESS_PROFILE, ROLE, or ENTITLEMENT
idstringRequested item ID
attributesHashnumberStable request attributes hash
accessRequestIdsarrayAccess request tracking IDs

Search current SailPoint indices with every documented search query mode.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
indicesarrayNoIndices to search: accessprofiles, accountactivities, entitlements, events, identities, roles, or *. Omit to search all.
queryTypestringNoSAILPOINT (default), DSL, TEXT, or TYPEAHEAD
queryVersionstringNoElasticsearch query language version (default 5.2)
queryobjectNoSAILPOINT query object: {query?, fields?, timeZone?, innerHit?}
queryDsljsonNoElasticsearch Query DSL object used with queryType=DSL
textQueryobjectNoTEXT query object with required terms[] and fields[]
typeAheadQueryobjectNoTYPEAHEAD query with query, field, optional nestedType, maxExpansions (1-1000), size, sort, and sortByValue
includeNestedbooleanNoInclude nested objects in search results (default true)
queryResultFilterobjectNoResult projection object with includes[] and/or excludes[]
aggregationTypestringNoAggregation query language: DSL (default) or SAILPOINT
aggregationsVersionstringNoElasticsearch aggregation language version (default 5.2)
aggregationsDsljsonNoDynamic Elasticsearch aggregations DSL object
aggregationsjsonNoTyped SailPoint aggregation specification
sortarrayNoOrdered search fields; prefix + or - for direction
searchAfterarrayNoString values from the final sorted record of the previous search page
filtersjsonNoMap of result field names to filter objects
limitnumberNoMaximum search documents for this page (0-10,000; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
resultsarrayIndex-dependent search documents
countnumberDocuments returned in this page
totalCountnumberTotal matching documents when count=true

SailPoint Search Aggregate

Run an Elasticsearch DSL or SailPoint aggregation over current search indices.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
indicesarrayNoIndices to search: accessprofiles, accountactivities, entitlements, events, identities, roles, or *. Omit to search all.
queryTypestringNoSAILPOINT (default), DSL, TEXT, or TYPEAHEAD
queryVersionstringNoElasticsearch query language version (default 5.2)
queryobjectNoSAILPOINT query object: {query?, fields?, timeZone?, innerHit?}
queryDsljsonNoElasticsearch Query DSL object used with queryType=DSL
textQueryobjectNoTEXT query object with required terms[] and fields[]
typeAheadQueryobjectNoTYPEAHEAD query with query, field, optional nestedType, maxExpansions (1-1000), size, sort, and sortByValue
includeNestedbooleanNoInclude nested objects in search results (default true)
queryResultFilterobjectNoResult projection object with includes[] and/or excludes[]
aggregationTypestringNoAggregation query language: DSL (default) or SAILPOINT
aggregationsVersionstringNoElasticsearch aggregation language version (default 5.2)
aggregationsDsljsonNoDynamic Elasticsearch aggregations DSL object
aggregationsjsonNoTyped SailPoint aggregation specification
sortarrayNoOrdered search fields; prefix + or - for direction
searchAfterarrayNoString values from the final sorted record of the previous search page
filtersjsonNoMap of result field names to filter objects
limitnumberNoMaximum records for this page (0-250; default 250)
offsetnumberNoZero-based record offset (default 0)
countbooleanNoReturn the total matching count in X-Total-Count (default false)

Output

ParameterTypeDescription
aggregationsjsonDynamic Elasticsearch aggregation result document
hitsarrayIndex-dependent aggregation hits
totalCountnumberTotal matching documents when count=true

SailPoint Search Count

Count documents matching a complete SailPoint search body.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
indicesarrayNoIndices to search: accessprofiles, accountactivities, entitlements, events, identities, roles, or *. Omit to search all.
queryTypestringNoSAILPOINT (default), DSL, TEXT, or TYPEAHEAD
queryVersionstringNoElasticsearch query language version (default 5.2)
queryobjectNoSAILPOINT query object: {query?, fields?, timeZone?, innerHit?}
queryDsljsonNoElasticsearch Query DSL object used with queryType=DSL
textQueryobjectNoTEXT query object with required terms[] and fields[]
typeAheadQueryobjectNoTYPEAHEAD query with query, field, optional nestedType, maxExpansions (1-1000), size, sort, and sortByValue
includeNestedbooleanNoInclude nested objects in search results (default true)
queryResultFilterobjectNoResult projection object with includes[] and/or excludes[]
aggregationTypestringNoAggregation query language: DSL (default) or SAILPOINT
aggregationsVersionstringNoElasticsearch aggregation language version (default 5.2)
aggregationsDsljsonNoDynamic Elasticsearch aggregations DSL object
aggregationsjsonNoTyped SailPoint aggregation specification
sortarrayNoOrdered search fields; prefix + or - for direction
searchAfterarrayNoString values from the final sorted record of the previous search page
filtersjsonNoMap of result field names to filter objects

Output

ParameterTypeDescription
totalnumberNumber of matching documents

SailPoint Sign Off Certification

Sign off a completed identity certification.

Input

ParameterTypeRequiredDescription
clientIdstringYesSailPoint Personal Access Token client ID
clientSecretstringYesSailPoint Personal Access Token client secret
tenantstringYesSailPoint tenant name or full *.api.identitynow.com / *.api.identitynowgov.com host
idstringYesCertification ID

Output

ParameterTypeDescription
certificationobjectSigned-off identity certification
idstringCertification ID
namestringCertification name
campaignjsonCampaign reference
completedbooleanWhether all decisions are complete
identitiesCompletednumberIdentities fully reviewed
identitiesTotalnumberTotal identities
createdstringCreation timestamp
modifiedstringLast modification timestamp
decisionsMadenumberDecisions made
decisionsTotalnumberTotal decisions
duestringCertification due timestamp
signedstringSign-off timestamp
reviewerjsonReviewer reference
reassignmentjsonReassignment details
hasErrorsbooleanWhether the certification has errors
errorMessagestringCertification error message
phasestringCertification phase

On this page

MANUAL DESCRIPTION
Usage Instructions
Actions
SailPoint Approve Access Request
Input
Output
SailPoint Cancel Access Request
Input
Output
SailPoint Decide Certification Review Items
Input
Output
SailPoint Get Access Profile
Input
Output
SailPoint Get Access Profile Entitlements
Input
Output
SailPoint Get Access Request Config
Input
Output
SailPoint Get Access Request Status
Input
Output
SailPoint Get Account
Input
Output
SailPoint Get Account Activity
Input
Output
SailPoint Get Account Entitlements
Input
Output
SailPoint Get Account Selections
Input
Output
SailPoint Get Campaign
Input
Output
SailPoint Get Certification
Input
Output
SailPoint Get Entitlement
Input
Output
SailPoint Get Entitlement Request Config
Input
Output
SailPoint Get Identity
Input
Output
SailPoint Get Role
Input
Output
SailPoint Get Role Entitlements
Input
Output
SailPoint Get Source
Input
Output
SailPoint Get Task Status
Input
Output
SailPoint List Access Profiles
Input
Output
SailPoint List Account Activities
Input
Output
SailPoint List Accounts
Input
Output
SailPoint List Campaigns
Input
Output
SailPoint List Certification Review Items
Input
Output
SailPoint List Certifications
Input
Output
SailPoint List Entitlements
Input
Output
SailPoint List Identities
Input
Output
SailPoint List Identity Entitlements
Input
Output
SailPoint List Pending Access Request Approvals
Input
Output
SailPoint List Roles
Input
Output
SailPoint List Sources
Input
Output
SailPoint Load Accounts
Input
Output
SailPoint Load Entitlements
Input
Output
SailPoint Reject Access Request
Input
Output
SailPoint Request Access
Input
Output
SailPoint Search
Input
Output
SailPoint Search Aggregate
Input
Output
SailPoint Search Count
Input
Output
SailPoint Sign Off Certification
Input
Output