Skip to main content

Intelligence

Read-only HTTP API that returns the Intelligence (identity context) for SecOps enrichment use cases (SIEM/SOAR connectors, MCP, browser extension). Backed by Atlas internal-REST calls to MICE, Shelby List Accounts, SDS Search, IDA-outliers, and identity-history.

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

MethodHTTP requestDescription
Get-IdentityIntelligenceV1GET /intelligence/v1/identitiesGet identity by filter
Get-IntelIdentityAccessItemHistoryV1GET /intelligence/v1/identities/{id}/access-history/access-itemsList identity access item history
Get-IntelIdentityAccountsV1GET /intelligence/v1/identities/{id}/accountsList identity accounts
Get-IntelIdentityCertificationHistoryV1GET /intelligence/v1/identities/{id}/access-history/certificationsList identity certification history
Get-IntelIdentityRareAccessV1GET /intelligence/v1/identities/{id}/outliers/rare-accessList identity rare access

get-identity-intelligence-v1

Requires tenant license idn:response-and-remediation.

Resolves exactly one identity by SCIM-style filters expression and returns the Intelligence envelope. Supported queryable fields are id and email only. The response embeds the first page of accounts, rare access, access-history access items, and access-history certifications. Paged slices include a next link only when more results exist. The privilegedAccess slice contains the full result and is not paged. The outliers slice is omitted when the tenant lacks the IDA-outliers license.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
QueryFiltersStringTrueFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq email: eq

Return type

Intelidentityaggregate

Responses

CodeDescriptionData Type
200Exactly one identity matched.Intelidentityaggregate
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetIdentityIntelligenceV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorresponsedto
409Multiple identities matched the filter.Errorresponsedto
429Too 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.GetIdentityIntelligenceV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq*  **email**: *eq*

# Get identity by filter

try {
Get-IdentityIntelligenceV1 -Filters $Filters

# Below is a request that includes all optional parameters
# Get-IdentityIntelligenceV1 -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityIntelligenceV1"
Write-Host $_.ErrorDetails
}

[Back to top]

get-intel-identity-access-item-history-v1

Continuation endpoint for the parent response's accessHistory.accessItems.next link. Returns one page of access-item history events for the supplied limit and offset values. Unsupported event types and per-record decode failures are dropped server-side. Requires tenant license idn:response-and-remediation.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdStringTrueNon-empty identity id path segment for Intelligence sub-resources.
QueryLimitInt32(optional) (default to 250)Page size. Defaults to 250; values above 250 are rejected with 400.
QueryOffsetInt32(optional) (default to 0)Zero-based page offset. Defaults to 0.

Return type

Intelaccessitemhistoryevent[]

Responses

CodeDescriptionData Type
200One page of access-item history events.Intelaccessitemhistoryevent[]
400Invalid path or query parameters.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetIdentityIntelligenceV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
429Too 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.GetIdentityIntelligenceV1429Response
500Internal or upstream server failure.Errorresponsedto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-empty identity id path segment for Intelligence sub-resources.
$Limit = 250 # Int32 | Page size. Defaults to 250; values above 250 are rejected with 400. (optional) (default to 250)
$Offset = 0 # Int32 | Zero-based page offset. Defaults to 0. (optional) (default to 0)

# List identity access item history

try {
Get-IntelIdentityAccessItemHistoryV1 -Id $Id

# Below is a request that includes all optional parameters
# Get-IntelIdentityAccessItemHistoryV1 -Id $Id -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IntelIdentityAccessItemHistoryV1"
Write-Host $_.ErrorDetails
}

[Back to top]

get-intel-identity-accounts-v1

Continuation endpoint for the parent response's accounts.next link. Returns one page of account rows for the supplied limit and offset values. Requires tenant license idn:response-and-remediation.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdStringTrueNon-empty identity id path segment for Intelligence sub-resources.
QueryLimitInt32(optional) (default to 250)Page size. Defaults to 250; values above 250 are rejected with 400.
QueryOffsetInt32(optional) (default to 0)Zero-based page offset. Defaults to 0.

Return type

Intelaccessaccountwire[]

Responses

CodeDescriptionData Type
200One page of accounts.Intelaccessaccountwire[]
400Invalid path or query parameters.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetIdentityIntelligenceV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
429Too 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.GetIdentityIntelligenceV1429Response
500Internal or upstream server failure.Errorresponsedto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-empty identity id path segment for Intelligence sub-resources.
$Limit = 250 # Int32 | Page size. Defaults to 250; values above 250 are rejected with 400. (optional) (default to 250)
$Offset = 0 # Int32 | Zero-based page offset. Defaults to 0. (optional) (default to 0)

# List identity accounts

try {
Get-IntelIdentityAccountsV1 -Id $Id

# Below is a request that includes all optional parameters
# Get-IntelIdentityAccountsV1 -Id $Id -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IntelIdentityAccountsV1"
Write-Host $_.ErrorDetails
}

[Back to top]

get-intel-identity-certification-history-v1

Continuation endpoint for the parent response's accessHistory.certifications.next link. Returns one page of certification history events for the supplied limit and offset values. Per-record decode failures are dropped server-side. Requires tenant license idn:response-and-remediation.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdStringTrueNon-empty identity id path segment for Intelligence sub-resources.
QueryLimitInt32(optional) (default to 250)Page size. Defaults to 250; values above 250 are rejected with 400.
QueryOffsetInt32(optional) (default to 0)Zero-based page offset. Defaults to 0.

Return type

Intelcertificationhistoryevent[]

Responses

CodeDescriptionData Type
200One page of certification history events.Intelcertificationhistoryevent[]
400Invalid path or query parameters.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetIdentityIntelligenceV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
429Too 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.GetIdentityIntelligenceV1429Response
500Internal or upstream server failure.Errorresponsedto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-empty identity id path segment for Intelligence sub-resources.
$Limit = 250 # Int32 | Page size. Defaults to 250; values above 250 are rejected with 400. (optional) (default to 250)
$Offset = 0 # Int32 | Zero-based page offset. Defaults to 0. (optional) (default to 0)

# List identity certification history

try {
Get-IntelIdentityCertificationHistoryV1 -Id $Id

# Below is a request that includes all optional parameters
# Get-IntelIdentityCertificationHistoryV1 -Id $Id -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IntelIdentityCertificationHistoryV1"
Write-Host $_.ErrorDetails
}

[Back to top]

get-intel-identity-rare-access-v1

Continuation endpoint for the parent response's outliers.rareAccess.next link. Resolves the identity's first outlier, then returns one page of rare access items for the supplied limit and offset values. An identity with no outlier returns an empty array. Requires tenant license idn:response-and-remediation and the IDA-outliers license.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdStringTrueNon-empty identity id path segment for Intelligence sub-resources.
QueryLimitInt32(optional) (default to 250)Page size. Defaults to 250; values above 250 are rejected with 400.
QueryOffsetInt32(optional) (default to 0)Zero-based page offset. Defaults to 0.

Return type

Inteloutlieraccessitem[]

Responses

CodeDescriptionData Type
200One page of rare access items.Inteloutlieraccessitem[]
400Invalid path or query parameters.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetIdentityIntelligenceV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
429Too 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.GetIdentityIntelligenceV1429Response
500Internal or upstream server failure.Errorresponsedto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-empty identity id path segment for Intelligence sub-resources.
$Limit = 250 # Int32 | Page size. Defaults to 250; values above 250 are rejected with 400. (optional) (default to 250)
$Offset = 0 # Int32 | Zero-based page offset. Defaults to 0. (optional) (default to 0)

# List identity rare access

try {
Get-IntelIdentityRareAccessV1 -Id $Id

# Below is a request that includes all optional parameters
# Get-IntelIdentityRareAccessV1 -Id $Id -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IntelIdentityRareAccessV1"
Write-Host $_.ErrorDetails
}

[Back to top]