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 V3 endpoints:
AccessProfiles
Use this API to implement and customize access profile functionality.
AccessRequestApprovals
Use this API to implement and customize access request approval functionality.
AccessRequests
Use this API to implement and customize access request functionality.
AccountActivities
Use this API to implement account activity 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.
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
Upload configurations and manage object mappings between tenants.
Connectors
Use this API to implement connector functionality.
GlobalTenantSecuritySettings
Use this API to implement and customize global tenant security settings.
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
MFAController
This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method
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.
OAuthClients
Use this API to implement OAuth client 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.
Roles
Use this API to implement and customize role functionality.
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.
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.
TaggedObjects
Use this API to implement object tagging functionality.
Transforms
The purpose of this API is to expose functionality for the manipulation of Transform objects.
VendorConnectorMappings
All URIs are relative to https://sailpoint.api.identitynow.com/v3
WorkItems
Use this API to implement work item 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.