Sources

Use this API to implement and customize source functionality. With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way.

Sources refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure.

In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. Admins go to Connections > Sources to see a list of the existing source representations in their organizations. They can create new sources or select existing ones.

To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. Refer to Configuring a Source for more information about the source configuration process.

Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. Refer to Identity Security Cloud Connectors for more information about these SailPoint supported connectors. Refer to the following links for more information about two useful connectors:

JDBC Connector: This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity).
Web Services Connector: This connector can directly connect to databases that support Web Services.

Refer to SaaS Connectivity for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources.

When admins select existing sources, they can view the following information about the source:

Associated connections (any associated identity profiles, apps, or references to the source in a transform).
Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources.
Associated entitlements (sets of access rights on sources).
Associated access profiles (groupings of entitlements).

The user account data and the entitlements update with each data aggregation from the source. Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. Admins can view a history of these aggregations, and they can also run manual imports. Refer to Loading Account Data for more information about manual and scheduled aggregations.

Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. Refer to Managing Source Account Schemas for more information about source account schemas and how to edit them. To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. Refer to Assigning Source Accounts to Identities for more information about this correlation process between source accounts and identities.

Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. Refer to Deleting Sources for more information about deleting sources.

Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. Refer to Managing Sources for more information about all the different things admins can do with sources once they are connected.

All URIs are relative to https://sailpoint.api.identitynow.com/v2024

Method	HTTP request	Description
New-V2024ProvisioningPolicy	POST `/sources/{sourceId}/provisioning-policies`	Create Provisioning Policy
New-V2024Source	POST `/sources`	Creates a source in IdentityNow.
New-V2024SourceSchedule	POST `/sources/{sourceId}/schedules`	Create Schedule on Source
New-V2024SourceSchema	POST `/sources/{sourceId}/schemas`	Create Schema on Source
Remove-V2024AccountsAsync	POST `/sources/{id}/remove-accounts`	Remove All Accounts in a Source
Remove-V2024NativeChangeDetectionConfig	DELETE `/sources/{sourceId}/native-change-detection-config`	Delete Native Change Detection Configuration
Remove-V2024ProvisioningPolicy	DELETE `/sources/{sourceId}/provisioning-policies/{usageType}`	Delete Provisioning Policy by UsageType
Remove-V2024Source	DELETE `/sources/{id}`	Delete Source by ID
Remove-V2024SourceSchedule	DELETE `/sources/{sourceId}/schedules/{scheduleType}`	Delete Source Schedule by type.
Remove-V2024SourceSchema	DELETE `/sources/{sourceId}/schemas/{schemaId}`	Delete Source Schema by ID
Get-V2024AccountsSchema	GET `/sources/{id}/schemas/accounts`	Downloads source accounts schema template
Get-V2024CorrelationConfig	GET `/sources/{id}/correlation-config`	Get Source Correlation Configuration
Get-V2024EntitlementsSchema	GET `/sources/{id}/schemas/entitlements`	Downloads source entitlements schema template
Get-V2024NativeChangeDetectionConfig	GET `/sources/{sourceId}/native-change-detection-config`	Native Change Detection Configuration
Get-V2024ProvisioningPolicy	GET `/sources/{sourceId}/provisioning-policies/{usageType}`	Get Provisioning Policy by UsageType
Get-V2024Source	GET `/sources/{id}`	Get Source by ID
Get-V2024SourceAttrSyncConfig	GET `/sources/{id}/attribute-sync-config`	Attribute Sync Config
Get-V2024SourceConfig	GET `/sources/{id}/connectors/source-config`	Gets source config with language translations
Get-V2024SourceEntitlementRequestConfig	GET `/sources/{id}/entitlement-request-config`	Get Source Entitlement Request Configuration
Get-V2024SourceHealth	GET `/sources/{sourceId}/source-health`	Fetches source health by id
Get-V2024SourceSchedule	GET `/sources/{sourceId}/schedules/{scheduleType}`	Get Source Schedule by Type
Get-V2024SourceSchedules	GET `/sources/{sourceId}/schedules`	List Schedules on Source
Get-V2024SourceSchema	GET `/sources/{sourceId}/schemas/{schemaId}`	Get Source Schema by ID
Get-V2024SourceSchemas	GET `/sources/{sourceId}/schemas`	List Schemas on Source
Import-V2024Accounts	POST `/sources/{id}/load-accounts`	Account Aggregation
Import-V2024AccountsSchema	POST `/sources/{id}/schemas/accounts`	Uploads source accounts schema template
Import-V2024ConnectorFile	POST `/sources/{sourceId}/upload-connector-file`	Upload connector file to source
Import-V2024EntitlementsSchema	POST `/sources/{id}/schemas/entitlements`	Uploads source entitlements schema template
Import-V2024UncorrelatedAccounts	POST `/sources/{id}/load-uncorrelated-accounts`	Process Uncorrelated Accounts
Get-V2024ProvisioningPolicies	GET `/sources/{sourceId}/provisioning-policies`	Lists ProvisioningPolicies
Get-V2024Sources	GET `/sources`	Lists all sources in IdentityNow.
Receive-V2024ResourceObjects	POST `/sources/{sourceId}/connector/peek-resource-objects`	Peek source connector's resource objects
Ping-V2024Cluster	POST `/sources/{sourceId}/connector/ping-cluster`	Ping cluster for source connector
Send-V2024CorrelationConfig	PUT `/sources/{id}/correlation-config`	Update Source Correlation Configuration
Send-V2024NativeChangeDetectionConfig	PUT `/sources/{sourceId}/native-change-detection-config`	Update Native Change Detection Configuration
Send-V2024ProvisioningPolicy	PUT `/sources/{sourceId}/provisioning-policies/{usageType}`	Update Provisioning Policy by UsageType
Send-V2024Source	PUT `/sources/{id}`	Update Source (Full)
Send-V2024SourceAttrSyncConfig	PUT `/sources/{id}/attribute-sync-config`	Update Attribute Sync Config
Send-V2024SourceSchema	PUT `/sources/{sourceId}/schemas/{schemaId}`	Update Source Schema (Full)
Sync-V2024AttributesForSource	POST `/sources/{id}/synchronize-attributes`	Synchronize single source attributes.
Test-V2024SourceConfiguration	POST `/sources/{sourceId}/connector/test-configuration`	Test configuration for source connector
Test-V2024SourceConnection	POST `/sources/{sourceId}/connector/check-connection`	Check connection for source connector.
Update-V2024PasswordPolicyHolders	PATCH `/sources/{sourceId}/password-policies`	Update Password Policy
Update-V2024ProvisioningPoliciesInBulk	POST `/sources/{sourceId}/provisioning-policies/bulk-update`	Bulk Update Provisioning Policies
Update-V2024ProvisioningPolicy	PATCH `/sources/{sourceId}/provisioning-policies/{usageType}`	Partial update of Provisioning Policy
Update-V2024Source	PATCH `/sources/{id}`	Update Source (Partial)
Update-V2024SourceEntitlementRequestConfig	PUT `/sources/{id}/entitlement-request-config`	Update Source Entitlement Request Configuration
Update-V2024SourceSchedule	PATCH `/sources/{sourceId}/schedules/{scheduleType}`	Update Source Schedule (Partial)
Update-V2024SourceSchema	PATCH `/sources/{sourceId}/schemas/{schemaId}`	Update Source Schema (Partial)

create-provisioning-policy

This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to Transforms in Provisioning Policies for more information.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	SourceId	String	True	The Source id
Body	ProvisioningPolicyDto	ProvisioningPolicyDto	True

Return type

ProvisioningPolicyDto

Responses

Code	Description	Data Type
201	Created ProvisioningPolicyDto object	ProvisioningPolicyDto
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id
$ProvisioningPolicyDto = @"{
  "name" : "example provisioning policy for inactive identities",
  "description" : "this provisioning policy creates access based on an identity going inactive",
  "fields" : [ {
    "isRequired" : false,
    "transform" : {
      "type" : "rule",
      "attributes" : {
        "name" : "Create Unique LDAP Attribute"
      }
    },
    "isMultiValued" : false,
    "name" : "userName",
    "attributes" : {
      "template" : "${firstname}.${lastname}${uniqueCounter}",
      "cloudMaxUniqueChecks" : "50",
      "cloudMaxSize" : "20",
      "cloudRequired" : "true"
    },
    "type" : "string"
  }, {
    "isRequired" : false,
    "transform" : {
      "type" : "rule",
      "attributes" : {
        "name" : "Create Unique LDAP Attribute"
      }
    },
    "isMultiValued" : false,
    "name" : "userName",
    "attributes" : {
      "template" : "${firstname}.${lastname}${uniqueCounter}",
      "cloudMaxUniqueChecks" : "50",
      "cloudMaxSize" : "20",
      "cloudRequired" : "true"
    },
    "type" : "string"
  } ],
  "usageType" : "CREATE"
}"@

# Create Provisioning Policy

try {
    $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
    New-V2024ProvisioningPolicy -SourceId $SourceId -V2024ProvisioningPolicyDto $Result 
    
    # Below is a request that includes all optional parameters
    # New-V2024ProvisioningPolicy -SourceId $SourceId -V2024ProvisioningPolicyDto $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy"
    Write-Host $_.ErrorDetails
}

Param Type	Name	Data Type	Required	Description
Body	Source	Source	True
Query	ProvisionAsCsv	Boolean	(optional)	If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source.

Code	Description	Data Type
201	Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.	Source
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
201	The schedule was successfully created on the specified source.	Schedule1
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
201	The schema was successfully created on the specified source.	Schema
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
202	Accepted. Returns task result details of removal request.	TaskResultDto
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
204	No content - indicates the request was successful but there is no content to be returned in the response.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
202	Accepted - Returned if the request was successfully accepted into the system.	DeleteSource202Response
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Successfully downloaded the file
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Correlation configuration for a source	CorrelationConfig
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Native change detection configuration for a source	NativeChangeDetectionConfig
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	The requested ProvisioningPolicyDto was successfully retrieved.	ProvisioningPolicyDto
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Source object.	Source
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Attribute synchronization configuration for a source	AttrSyncSourceConfig
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	A Connector Detail object	ConnectorDetail1
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Source Entitlement Request Configuration Details.	SourceEntitlementRequestConfig
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Fetched source health successfully	SourceHealthDto
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	The requested Schedule was successfully retrieved.	Schedule1
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	The schedules were successfully retrieved.	Schedule1[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	The requested Schema was successfully retrieved.	Schema
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	The schemas were successfully retrieved.	Schema[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

create-provisioning-policy​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-source​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-source-schedule​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-source-schema​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-accounts-async​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-native-change-detection-config​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-provisioning-policy​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-source​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-source-schedule​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-source-schema​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-accounts-schema​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-correlation-config​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-entitlements-schema​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-native-change-detection-config​

Parameters​

create-provisioning-policy

Parameters

Return type

Responses

HTTP request headers

Example

create-source

Parameters

Return type

Responses

HTTP request headers

Example

create-source-schedule

Parameters

Return type

Responses

HTTP request headers

Example

create-source-schema

Parameters

Return type

Responses

HTTP request headers

Example

delete-accounts-async

Parameters

Return type

Responses

HTTP request headers

Example

delete-native-change-detection-config

Parameters

Return type

Responses

HTTP request headers

Example

delete-provisioning-policy

Parameters

Return type

Responses

HTTP request headers

Example

delete-source

Parameters

Return type

Responses

HTTP request headers

Example

delete-source-schedule

Parameters

Return type

Responses

HTTP request headers

Example

delete-source-schema

Parameters

Return type

Responses

HTTP request headers

Example

get-accounts-schema

Parameters

Return type

Responses

HTTP request headers

Example

get-correlation-config

Parameters

Return type

Responses

HTTP request headers

Example

get-entitlements-schema

Parameters

Return type

Responses

HTTP request headers

Example

get-native-change-detection-config

Parameters

Code	Description	Data Type
202	Aggregate Accounts Task	LoadAccountsTask
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Successfully uploaded the file	Schema
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Uploaded the file successfully and sent all post-upload events	Source
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
202	Uncorrelated Accounts Task	LoadUncorrelatedAccountsTask
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	List of ProvisioningPolicyDto objects	ProvisioningPolicyDto[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Param Type	Name	Data Type	Required	Description
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Count	Boolean	(optional) (default to $false)	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.
Query	Filters	String	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in, ge, gt, le, lt, ne, isnull, sw name: co, eq, in, sw, ge, gt, ne, isnull type: eq, in, ge, gt, ne, isnull, sw owner.id: eq, in, ge, gt, le, lt, ne, isnull, sw features: ca, co created: eq, ge, gt, in, le, lt, ne, isnull, sw modified: eq, ge, gt, in, le, lt, ne, isnull, sw managementWorkgroup.id: eq, ge, gt, in, le, lt, ne, isnull, sw description: eq, sw authoritative: eq, ne, isnull healthy: isnull status: eq, in, ge, gt, le, lt, ne, isnull, sw connectionType: eq, ge, gt, in, le, lt, ne, isnull, sw connectorName: eq, ge, gt, in, ne, isnull, sw category: co, eq, ge, gt, in, le, lt, ne, sw
Query	Sorters	String	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType
Query	ForSubadmin	String	(optional)	Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value me indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned.
Query	IncludeIDNSource	Boolean	(optional) (default to $false)	Include the IdentityNow source in the response.

Code	Description	Data Type
200	List of Source objects	Source[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	List of resource objects that was fetched from the source connector.	ResourceObjectsResponse
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	The result of pinging connection with the source connector.	StatusResponse
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

Code	Description	Data Type
200	Updated correlation configuration for a source	CorrelationConfig
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto