|
|
|
|
@@ -21,6 +21,8 @@ Method | HTTP request | Description
|
|
|
|
|
[**Remove-V2025MachineIdentity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity
|
|
|
|
|
[**Get-V2025MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine identity details
|
|
|
|
|
[**Get-V2025MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List machine identities
|
|
|
|
|
[**Get-V2025MachineIdentityUserEntitlements**](#list-machine-identity-user-entitlements) | **GET** `/machine-identity-user-entitlements` | List machine identity's user entitlements
|
|
|
|
|
[**Start-V2025MachineIdentityAggregation**](#start-machine-identity-aggregation) | **POST** `/sources/{sourceId}/aggregate-agents` | Start Machine Identity (AI Agent) Aggregation
|
|
|
|
|
[**Update-V2025MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a machine identity
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -222,7 +224,7 @@ This API returns a list of machine identities.
|
|
|
|
|
Param Type | Name | Data Type | Required | Description
|
|
|
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
|
|
|
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
|
|
|
|
Query | Filters | **String** | (optional) | 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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw*
|
|
|
|
|
Query | Filters | **String** | (optional) | 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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw*
|
|
|
|
|
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name, source.name**
|
|
|
|
|
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
|
|
|
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
|
|
|
@@ -249,7 +251,7 @@ Code | Description | Data Type
|
|
|
|
|
### Example
|
|
|
|
|
```powershell
|
|
|
|
|
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
|
|
|
|
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* (optional)
|
|
|
|
|
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* (optional)
|
|
|
|
|
$Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name, source.name** (optional)
|
|
|
|
|
$Count = $true # Boolean | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
|
|
|
@@ -269,6 +271,119 @@ try {
|
|
|
|
|
```
|
|
|
|
|
[[Back to top]](#)
|
|
|
|
|
|
|
|
|
|
## list-machine-identity-user-entitlements
|
|
|
|
|
:::warning experimental
|
|
|
|
|
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
|
|
|
|
:::
|
|
|
|
|
This API returns a list of user entitlements associated with machine identities.
|
|
|
|
|
|
|
|
|
|
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-machine-identity-user-entitlements)
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
Param Type | Name | Data Type | Required | Description
|
|
|
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
|
|
|
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
|
|
|
|
Query | Filters | **String** | (optional) | 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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw*
|
|
|
|
|
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **machineIdentityName, entitlement.name, source.name**
|
|
|
|
|
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
|
|
|
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
|
|
|
|
|
|
|
|
### Return type
|
|
|
|
|
[**MachineIdentityUserEntitlementResponse[]**](../models/machine-identity-user-entitlement-response)
|
|
|
|
|
|
|
|
|
|
### Responses
|
|
|
|
|
Code | Description | Data Type
|
|
|
|
|
------------- | ------------- | -------------
|
|
|
|
|
200 | List of machine identity user entitlements. | MachineIdentityUserEntitlementResponse[]
|
|
|
|
|
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**: Not defined
|
|
|
|
|
- **Accept**: application/json
|
|
|
|
|
|
|
|
|
|
### Example
|
|
|
|
|
```powershell
|
|
|
|
|
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
|
|
|
|
$Filters = 'machineIdentityId eq "2c9180858082150f0180893dbaf44201"' # 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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* (optional)
|
|
|
|
|
$Sorters = "machineIdentityName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **machineIdentityName, entitlement.name, source.name** (optional)
|
|
|
|
|
$Count = $true # Boolean | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
|
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
|
|
|
|
|
|
|
|
# List machine identity's user entitlements
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
Get-V2025MachineIdentityUserEntitlements -XSailPointExperimental $XSailPointExperimental
|
|
|
|
|
|
|
|
|
|
# Below is a request that includes all optional parameters
|
|
|
|
|
# Get-V2025MachineIdentityUserEntitlements -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset
|
|
|
|
|
} catch {
|
|
|
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentityUserEntitlements"
|
|
|
|
|
Write-Host $_.ErrorDetails
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
[[Back to top]](#)
|
|
|
|
|
|
|
|
|
|
## start-machine-identity-aggregation
|
|
|
|
|
:::warning experimental
|
|
|
|
|
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
|
|
|
|
:::
|
|
|
|
|
Use this API to aggregate machine identities (AI Agents).
|
|
|
|
|
|
|
|
|
|
[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-machine-identity-aggregation)
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
Param Type | Name | Data Type | Required | Description
|
|
|
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
|
|
|
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
|
|
|
|
Body | MachineIdentityAggregationRequest | [**MachineIdentityAggregationRequest**](../models/machine-identity-aggregation-request) | True |
|
|
|
|
|
|
|
|
|
|
### Return type
|
|
|
|
|
[**MachineIdentityAggregationResponse**](../models/machine-identity-aggregation-response)
|
|
|
|
|
|
|
|
|
|
### Responses
|
|
|
|
|
Code | Description | Data Type
|
|
|
|
|
------------- | ------------- | -------------
|
|
|
|
|
200 | Machine Identity Aggregation was started successfully. | MachineIdentityAggregationResponse
|
|
|
|
|
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
|
|
|
|
|
```powershell
|
|
|
|
|
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
|
|
|
|
$MachineIdentityAggregationRequest = @"{
|
|
|
|
|
"datasetIds" : [ "source:datasetId12345", "source:datasetId12345" ]
|
|
|
|
|
}"@
|
|
|
|
|
|
|
|
|
|
# Start Machine Identity (AI Agent) Aggregation
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
$Result = ConvertFrom-JsonToMachineIdentityAggregationRequest -Json $MachineIdentityAggregationRequest
|
|
|
|
|
Start-V2025MachineIdentityAggregation -XSailPointExperimental $XSailPointExperimental -MachineIdentityAggregationRequest $Result
|
|
|
|
|
|
|
|
|
|
# Below is a request that includes all optional parameters
|
|
|
|
|
# Start-V2025MachineIdentityAggregation -XSailPointExperimental $XSailPointExperimental -MachineIdentityAggregationRequest $Result
|
|
|
|
|
} catch {
|
|
|
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025MachineIdentityAggregation"
|
|
|
|
|
Write-Host $_.ErrorDetails
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
[[Back to top]](#)
|
|
|
|
|
|
|
|
|
|
## update-machine-identity
|
|
|
|
|
:::warning experimental
|
|
|
|
|
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
|
|
|
|
|