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 Python SDK for Beta endpoints:
Access_Model_Metadata
Use this API to create and manage metadata attributes for your Access Model.
Access_Profiles
Use this API to implement and customize access profile functionality.
Access_Request_Approvals
Use this API to implement and customize access request approval functionality.
Access_Request_Identity_Metrics
Use this API to implement access request identity metrics functionality.
Access_Requests
Use this API to implement and customize access request functionality.
Account_Activities
Use this API to implement account activity tracking functionality.
Account_Aggregations
Use this API to implement account aggregation progress tracking functionality.
Account_Usages
Use this API to implement account usage insight functionality.
Accounts
Use this API to implement and customize account functionality.
Application_Discovery
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.
Auth_Profile
Use this API to implement Auth Profile functionality.
Certification_Campaigns
Use this API to implement certification campaign functionality.
Certifications
Use this API to implement certification functionality.
Connector_Rule_Management
Use this API to implement connector rule management functionality.
Connectors
Use this API to implement connector functionality.
Custom_Forms
Use this API to build and manage custom forms.
Custom_Password_Instructions
Use this API to implement custom password instruction functionality.
Entitlements
Use this API to implement and customize entitlement functionality.
Governance_Groups
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.
IAI_Access_Request_Recommendations
All URIs are relative to https://sailpoint.api.identitynow.com/beta
IAI_Common_Access
All URIs are relative to https://sailpoint.api.identitynow.com/beta
IAI_Message_Catalogs
All URIs are relative to https://sailpoint.api.identitynow.com/beta
IAI_Outliers
All URIs are relative to https://sailpoint.api.identitynow.com/beta
IAI_Peer_Group_Strategies
All URIs are relative to https://sailpoint.api.identitynow.com/beta
IAI_Recommendations
All URIs are relative to https://sailpoint.api.identitynow.com/beta
IAI_Role_Mining
All URIs are relative to https://sailpoint.api.identitynow.com/beta
Icons
Use this API to implement functionality related to object icons (application icons for example).
Identities
Use this API to implement identity functionality.
Identity_Attributes
All URIs are relative to https://sailpoint.api.identitynow.com/beta
Identity_History
All URIs are relative to https://sailpoint.api.identitynow.com/beta
Identity_Profiles
Use this API to implement and customize identity profile functionality.
Launchers
Use this API to manage Launchers.
Lifecycle_States
Use this API to implement and customize lifecycle state functionality.
MFA_Configuration
Configure and test multifactor authentication (MFA) methods
MFA_Controller
This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method
Managed_Clients
Use this API to implement managed client functionality.
Managed_Clusters
Use this API to implement managed cluster functionality.
Multi_Host_Integration
Use this API to build a Multi-Host Integration.
Non_Employee_Lifecycle_Management
Use this API to implement non-employee lifecycle management functionality.
Notifications
All URIs are relative to https://sailpoint.api.identitynow.com/beta
OAuth_Clients
Use this API to implement OAuth client functionality.
Org_Config
Use this API to implement organization configuration functionality.
Password_Configuration
Use this API to implement organization password configuration functionality.
Password_Dictionary
Use this API to implement password dictionary functionality.
Password_Management
Use this API to implement password management functionality.
Password_Policies
Use these APIs to implement password policies functionality.
Password_Sync_Groups
Use this API to implement password sync group functionality.
Personal_Access_Tokens
Use this API to implement personal access token (PAT) functionality.
Public_Identities_Config
Use this API to implement public identity configuration functionality.
Requestable_Objects
Use this API to implement requestable object functionality.
Role_Insights
All URIs are relative to https://sailpoint.api.identitynow.com/beta
Roles
Use this API to implement and customize role functionality.
SIM_Integrations
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.
SOD_Policies
Use this API to implement and manage "separation of duties" (SOD) policies.
SOD_Violations
Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations.
SP_Config
Import and export configuration for some objects between tenants.
Search_Attribute_Configuration
Use this API to implement search attribute configuration functionality, along with Search.
Segments
Use this API to implement and customize access request segment functionality.
Service_Desk_Integration
Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution.
Source_Usages
Use this API to implement source usage insight functionality.
Sources
Use this API to implement and customize source functionality.
Suggested_Entitlement_Description
Use this API to implement Suggested Entitlement Description (SED) functionality.
Tagged_Objects
Use this API to implement object tagging functionality.
Tags
All URIs are relative to https://sailpoint.api.identitynow.com/beta
Task_Management
All URIs are relative to https://sailpoint.api.identitynow.com/beta
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.
UI_Metadata
API for managing UI Metadata. Use this API to manage metadata about your User Interface.
Vendor_Connector_Mappings
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.
Work_Items
Use this API to implement work item functionality.
Work_Reassignment
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.