All URIs are relative to https://sailpoint.api.identitynow.com/beta
export-outliers-zip
This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported.
Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
API Spec
Parameters
Param Type | Name | Data Type | Required | Description |
---|
Query | Type | String | (optional) | Type of the identity outliers snapshot to filter on |
Return type
System.IO.FileInfo
Responses
Code | Description | Data Type |
---|
200 | Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers. | System.IO.FileInfo |
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: Not defined
- Accept: application/zip, application/json
Example
$Type = "LOW_SIMILARITY"
try {
Export-BetaOutliersZip
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip"
Write-Host $_.ErrorDetails
}
[Back to top]
get-identity-outlier-snapshots
This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
API Spec
Parameters
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 | Type | String | (optional) | Type of the identity outliers snapshot to filter on |
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: snapshotDate: ge, le |
Query | Sorters | String | (optional) | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: snapshotDate |
Return type
OutlierSummary[]
Responses
Code | Description | Data Type |
---|
200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | OutlierSummary[] |
202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable |
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: Not defined
- Accept: application/json
Example
$Limit = 250
$Offset = 0
$Type = "LOW_SIMILARITY"
$Filters = 'snapshotDate ge "2022-02-07T20:13:29.356648026Z"'
$Sorters = "snapshotDate"
try {
Get-BetaIdentityOutlierSnapshots
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots"
Write-Host $_.ErrorDetails
}
[Back to top]
get-identity-outliers
This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.
API Spec
Parameters
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 | Type | String | (optional) | Type of the identity outliers snapshot to filter on |
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: attributes: eq, sw, co, in firstDetectionDate: ge, le certStatus: eq ignored: eq score: ge, le |
Query | Sorters | String | (optional) | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: firstDetectionDate, attributes, score |
Return type
Outlier[]
Responses
Code | Description | Data Type |
---|
200 | Succeeded. Returns list of objects. Each object contains information about outliers. | Outlier[] |
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: Not defined
- Accept: application/json
Example
$Limit = 250
$Offset = 0
$Count = $true
$Type = "LOW_SIMILARITY"
$Filters = 'attributes.displayName sw "John" and certStatus eq "false"'
$Sorters = "attributes.displayName,firstDetectionDate,-score"
try {
Get-BetaIdentityOutliers
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers"
Write-Host $_.ErrorDetails
}
[Back to top]
get-latest-identity-outlier-snapshots
This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.
API Spec
Parameters
Param Type | Name | Data Type | Required | Description |
---|
Query | Type | String | (optional) | Type of the identity outliers snapshot to filter on |
Return type
LatestOutlierSummary[]
Responses
Code | Description | Data Type |
---|
200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | LatestOutlierSummary[] |
202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable |
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: Not defined
- Accept: application/json
Example
$Type = "LOW_SIMILARITY"
try {
Get-BetaLatestIdentityOutlierSnapshots
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots"
Write-Host $_.ErrorDetails
}
[Back to top]
get-outlier-contributing-feature-summary
This API returns a summary of a contributing feature for an identity outlier.
The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
API Spec
Parameters
Param Type | Name | Data Type | Required | Description |
---|
Path | OutlierFeatureId | String | True | Contributing feature id |
Return type
OutlierFeatureSummary
Responses
Code | Description | Data Type |
---|
200 | Succeeded. Returns selected contributing feature summary for an outlier. | OutlierFeatureSummary |
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: Not defined
- Accept: application/json
Example
$OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af"
try {
Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary"
Write-Host $_.ErrorDetails
}
[Back to top]
get-peer-group-outliers-contributing-features
This API returns a list of contributing feature objects for a single outlier.
The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
API Spec
Parameters
Param Type | Name | Data Type | Required | Description |
---|
Path | OutlierId | String | True | The outlier id |
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 | IncludeTranslationMessages | String | (optional) | Whether or not to include translation messages object in returned response |
Query | Sorters | String | (optional) | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: importance |
Return type
OutlierContributingFeature[]
Responses
Code | Description | Data Type |
---|
200 | Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature. | OutlierContributingFeature[] |
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: Not defined
- Accept: application/json
Example
$OutlierId = "2c918085842e69ae018432d22ccb212f"
$Limit = 250
$Offset = 0
$Count = $true
$IncludeTranslationMessages = "include-translation-messages="
$Sorters = "importance"
try {
Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures"
Write-Host $_.ErrorDetails
}
[Back to top]
ignore-identity-outliers
This API receives a list of identity IDs in the request, changes the outliers to be ignored.
API Spec
Parameters
Param Type | Name | Data Type | Required | Description |
---|
Body | RequestBody | []String | True | |
Return type
(empty response body)
Responses
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: application/json
- Accept: application/json
Example
$RequestBody = "MyRequestBody"
$RequestBody = @""@
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers"
Write-Host $_.ErrorDetails
}
[Back to top]
list-outliers-contributing-feature-access-items
This API returns a list of the enriched access items associated with each feature filtered by the access item type.
The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
API Spec
Parameters
Param Type | Name | Data Type | Required | Description |
---|
Path | OutlierId | String | True | The outlier id |
Path | ContributingFeatureName | String | True | The name of contributing feature |
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 | AccessType | String | (optional) | The type of access item for the identity outlier contributing feature. If not provided, it returns all. |
Query | Sorters | String | (optional) | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName |
Return type
OutliersContributingFeatureAccessItems[]
Responses
Code | Description | Data Type |
---|
200 | The list of access items. | OutliersContributingFeatureAccessItems[] |
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: Not defined
- Accept: application/json
Example
$OutlierId = "2c918085842e69ae018432d22ccb212f"
$ContributingFeatureName = "radical_entitlement_count"
$Limit = 250
$Offset = 0
$Count = $true
$AccessType = "ENTITLEMENT"
$Sorters = "displayName"
try {
Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems"
Write-Host $_.ErrorDetails
}
[Back to top]
un-ignore-identity-outliers
This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
API Spec
Parameters
Param Type | Name | Data Type | Required | Description |
---|
Body | RequestBody | []String | True | |
Return type
(empty response body)
Responses
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. | ListAccessModelMetadataAttribute401Response |
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. | ListAccessModelMetadataAttribute429Response |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
- Content-Type: application/json
- Accept: application/json
Example
$RequestBody = "MyRequestBody"
$RequestBody = @""@
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers"
Write-Host $_.ErrorDetails
}
[Back to top]