Methods
Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it.
Key Features
- Purpose & Overview: Explains the purpose of the method and its role in the API.
- Parameters: Describe the required input parameters, including their data types.
- Response Format: Details the expected return format or structure.
- Error Scenarios: Outline potential errors or issues that may arise during method execution.
- Example: Provides a sample of how the API uses the method.
Available Methods
This is a list of the core methods available in the PowerShell SDK for V2024 endpoints:
AccessModelMetadata
Use this API to create and manage metadata attributes for your Access Model.
AccessProfiles
Use this API to implement and customize access profile functionality.
AccessRequestApprovals
Use this API to implement and customize access request approval functionality.
AccessRequestIdentityMetrics
Use this API to implement access request identity metrics functionality.
AccessRequests
Use this API to implement and customize access request functionality.
AccountActivities
Use this API to implement account activity tracking functionality.
AccountAggregations
Use this API to implement account aggregation progress tracking functionality.
AccountUsages
Use this API to implement account usage insight functionality.
Accounts
Use this API to implement and customize account functionality.
ApplicationDiscovery
Use this API to implement application discovery functionality.
Approvals
Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them.
Apps
Use this API to implement source application functionality.
AuthProfile
Use this API to implement Auth Profile functionality.
AuthUsers
Use this API to implement user authentication system functionality.
Branding
Use this API to implement and customize branding functionality.
CertificationCampaignFilters
Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify.
CertificationCampaigns
Use this API to implement certification campaign functionality.
CertificationSummaries
Use this API to implement certification summary functionality.
Certifications
Use this API to implement certification functionality.
ConfigurationHub
Use this API to implement and customize configuration settings management. With this functionality, you can access the Configuration Hub actions and build your own automated pipeline for Identity Security Cloud configuration change delivery and deployment.
ConnectorRuleManagement
Use this API to implement connector rule management functionality.
Connectors
Use this API to implement connector functionality.
CustomForms
Use this API to build and manage custom forms.
CustomPasswordInstructions
Use this API to implement custom password instruction functionality.
DataSegmentation
This service is responsible for creating segments that will determine how access is delegated to identities
Dimensions
Use this API to implement and customize dynamic role functionality. With this functionality in place, administrators can create dimensions and configure them for use throughout Identity Security Cloud. Identity Security Cloud can use established criteria to automatically assign the dimensions to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. Entitlements represent the most granular level of access in Identity Security Cloud.
Entitlements
Use this API to implement and customize entitlement functionality.
GlobalTenantSecuritySettings
Use this API to implement and customize global tenant security settings.
GovernanceGroups
Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud.
IAIAccessRequestRecommendations
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
IAICommonAccess
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
IAIOutliers
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
IAIPeerGroupStrategies
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
IAIRecommendations
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
IAIRoleMining
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
Icons
Use this API to implement functionality related to object icons (application icons for example).
Identities
Use this API to implement identity functionality.
IdentityAttributes
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
IdentityHistory
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
IdentityProfiles
Use this API to implement identity profile functionality.
LifecycleStates
Use this API to implement and customize lifecycle state functionality.
MFAConfiguration
Configure and test multifactor authentication (MFA) methods
ManagedClients
Use this API to implement managed client functionality.
ManagedClusters
Use this API to implement managed cluster functionality.
NonEmployeeLifecycleManagement
Use this API to implement non-employee lifecycle management functionality.
Notifications
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
OAuthClients
Use this API to implement OAuth client functionality.
OrgConfig
Use this API to implement organization configuration functionality.
PasswordConfiguration
Use this API to implement organization password configuration functionality.
PasswordDictionary
Use this API to implement password dictionary functionality.
PasswordManagement
Use this API to implement password management functionality.
PasswordPolicies
Use these APIs to implement password policies functionality.
PasswordSyncGroups
Use this API to implement password sync group functionality.
PersonalAccessTokens
Use this API to implement personal access token (PAT) functionality.
PublicIdentities
Use this API in conjunction with Public Identites Config to enable non-administrators to view identities' publicly visible attributes.
PublicIdentitiesConfig
Use this API to implement public identity configuration functionality.
ReportsDataExtraction
Use this API to implement reports lifecycle managing and monitoring.
RequestableObjects
Use this API to implement requestable object functionality.
RoleInsights
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
Roles
Use this API to implement and customize role functionality.
SIMIntegrations
Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow.
SODPolicies
Use this API to implement and manage "separation of duties" (SOD) policies.
SODViolations
Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations.
SPConfig
Import and export configuration for some objects between tenants.
SavedSearch
Use this API to implement saved search functionality.
ScheduledSearch
Use this API to implement scheduled search functionality.
Search
Use this API to implement search functionality.
SearchAttributeConfiguration
Use this API to implement search attribute configuration functionality, along with Search.
Segments
Use this API to implement and customize access request segment functionality.
ServiceDeskIntegration
Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution.
SourceUsages
Use this API to implement source usage insight functionality.
Sources
Use this API to implement and customize source functionality.
SuggestedEntitlementDescription
Use this API to implement Suggested Entitlement Description (SED) functionality.
TaggedObjects
Use this API to implement object tagging functionality.
TaskManagement
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
Tenant
API for reading tenant details.
Transforms
The purpose of this API is to expose functionality for the manipulation of Transform objects.
Triggers
Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions.
UIMetadata
API for managing UI Metadata. Use this API to manage metadata about your User Interface.
VendorConnectorMappings
Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats.
WorkItems
Use this API to implement work item functionality.
WorkReassignment
Use this API to implement work reassignment functionality.
Workflows
Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to event triggers and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST.