diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md index bfd4ed76c..fbb51a392 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md @@ -200,7 +200,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* + 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* 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** 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. @@ -227,7 +227,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* (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* (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** (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) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md index ef1658eb6..6f6bd7446 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md @@ -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. diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationRequest.md new file mode 100644 index 000000000..658a77755 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationRequest.md @@ -0,0 +1,35 @@ +--- +id: v2025-machine-identity-aggregation-request +title: MachineIdentityAggregationRequest +pagination_label: MachineIdentityAggregationRequest +sidebar_label: MachineIdentityAggregationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityAggregationRequest', 'V2025MachineIdentityAggregationRequest'] +slug: /tools/sdk/powershell/v2025/models/machine-identity-aggregation-request +tags: ['SDK', 'Software Development Kit', 'MachineIdentityAggregationRequest', 'V2025MachineIdentityAggregationRequest'] +--- + + +# MachineIdentityAggregationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DatasetIds** | **[]String** | List of dataset Ids to aggregate machine identities | [required] + +## Examples + +- Prepare the resource +```powershell +$MachineIdentityAggregationRequest = Initialize-V2025MachineIdentityAggregationRequest -DatasetIds null +``` + +- Convert the resource to JSON +```powershell +$MachineIdentityAggregationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationResponse.md new file mode 100644 index 000000000..96bd539cb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationResponse.md @@ -0,0 +1,69 @@ +--- +id: v2025-machine-identity-aggregation-response +title: MachineIdentityAggregationResponse +pagination_label: MachineIdentityAggregationResponse +sidebar_label: MachineIdentityAggregationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityAggregationResponse', 'V2025MachineIdentityAggregationResponse'] +slug: /tools/sdk/powershell/v2025/models/machine-identity-aggregation-response +tags: ['SDK', 'Software Development Kit', 'MachineIdentityAggregationResponse', 'V2025MachineIdentityAggregationResponse'] +--- + + +# MachineIdentityAggregationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | System-generated unique ID of the Object | [optional] +**Type** | **Enum** [ "QUARTZ", "QPOC", "QUEUED_TASK" ] | Type of task for aggregation | [optional] +**UniqueName** | **String** | Name of the task for aggregation | [optional] +**Description** | **String** | Description of the aggregation | [optional] +**ParentName** | **String** | Name of the parent of the task for aggregation | [optional] +**Launcher** | **String** | Service to execute the aggregation | [optional] +**Target** | [**MachineIdentityAggregationResponseTarget**](machine-identity-aggregation-response-target) | | [optional] +**Created** | **System.DateTime** | Creation date of the aggregation | [optional] +**Modified** | **System.DateTime** | Last modification date of the aggregation | [optional] +**Launched** | **System.DateTime** | Launch date of the aggregation | [optional] +**Completed** | **System.DateTime** | Completion date of the aggregation | [optional] +**TaskDefinitionSummary** | [**TaskDefinitionSummary**](task-definition-summary) | | [optional] +**CompletionStatus** | **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMPERROR" ] | Completion status of the aggregation | [optional] +**Messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the aggregation | [optional] +**Returns** | [**[]TaskReturnDetails**](task-return-details) | Return values associated with the aggregation | [optional] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes of the aggregation | [optional] +**Progress** | **String** | Current progress of aggregation | [optional] +**PercentComplete** | **Int32** | Current percentage completion of aggregation | [optional] + +## Examples + +- Prepare the resource +```powershell +$MachineIdentityAggregationResponse = Initialize-V2025MachineIdentityAggregationResponse -Id 8886e5e3-63d0-462f-a195-d98da885b8dc ` + -Type QUARTZ ` + -UniqueName AI Agent Aggregation - ID123 ` + -Description AI Agent Aggregation - From given dataset IDs ` + -ParentName Parent Task ` + -Launcher System ` + -Target null ` + -Created 2020-07-11T21:23:15Z ` + -Modified 2020-07-11T21:23:15Z ` + -Launched 2020-07-11T21:23:15Z ` + -Completed 2020-07-11T21:23:15Z ` + -TaskDefinitionSummary null ` + -CompletionStatus SUCCESS ` + -Messages null ` + -Returns null ` + -Attributes {creatorRequestId=ed5a371bbaba411fb8f1f6970b842334} ` + -Progress Started ` + -PercentComplete 100 +``` + +- Convert the resource to JSON +```powershell +$MachineIdentityAggregationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationResponseTarget.md b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationResponseTarget.md new file mode 100644 index 000000000..4962b8d3f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityAggregationResponseTarget.md @@ -0,0 +1,39 @@ +--- +id: v2025-machine-identity-aggregation-response-target +title: MachineIdentityAggregationResponseTarget +pagination_label: MachineIdentityAggregationResponseTarget +sidebar_label: MachineIdentityAggregationResponseTarget +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityAggregationResponseTarget', 'V2025MachineIdentityAggregationResponseTarget'] +slug: /tools/sdk/powershell/v2025/models/machine-identity-aggregation-response-target +tags: ['SDK', 'Software Development Kit', 'MachineIdentityAggregationResponseTarget', 'V2025MachineIdentityAggregationResponseTarget'] +--- + + +# MachineIdentityAggregationResponseTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$MachineIdentityAggregationResponseTarget = Initialize-V2025MachineIdentityAggregationResponseTarget -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$MachineIdentityAggregationResponseTarget | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponse.md new file mode 100644 index 000000000..ea05170c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponse.md @@ -0,0 +1,43 @@ +--- +id: v2025-machine-identity-user-entitlement-response +title: MachineIdentityUserEntitlementResponse +pagination_label: MachineIdentityUserEntitlementResponse +sidebar_label: MachineIdentityUserEntitlementResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityUserEntitlementResponse', 'V2025MachineIdentityUserEntitlementResponse'] +slug: /tools/sdk/powershell/v2025/models/machine-identity-user-entitlement-response +tags: ['SDK', 'Software Development Kit', 'MachineIdentityUserEntitlementResponse', 'V2025MachineIdentityUserEntitlementResponse'] +--- + + +# MachineIdentityUserEntitlementResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | System-generated unique ID of the Object | [optional] +**MachineIdentityId** | **String** | System-generated unique ID of the Machine Identity | [optional] +**Source** | [**MachineIdentityUserEntitlementResponseSource**](machine-identity-user-entitlement-response-source) | | [optional] +**Entitlement** | [**MachineIdentityUserEntitlementResponseEntitlement**](machine-identity-user-entitlement-response-entitlement) | | [optional] +**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$MachineIdentityUserEntitlementResponse = Initialize-V2025MachineIdentityUserEntitlementResponse -Id 8886e5e3-63d0-462f-a195-d98da885b8dc ` + -MachineIdentityId 8886e5e3-63d0-462f-a195-d98da885b8dc ` + -Source null ` + -Entitlement null ` + -Created 2015-05-28T14:07:17Z +``` + +- Convert the resource to JSON +```powershell +$MachineIdentityUserEntitlementResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponseEntitlement.md b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponseEntitlement.md new file mode 100644 index 000000000..aeeb2307d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponseEntitlement.md @@ -0,0 +1,39 @@ +--- +id: v2025-machine-identity-user-entitlement-response-entitlement +title: MachineIdentityUserEntitlementResponseEntitlement +pagination_label: MachineIdentityUserEntitlementResponseEntitlement +sidebar_label: MachineIdentityUserEntitlementResponseEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityUserEntitlementResponseEntitlement', 'V2025MachineIdentityUserEntitlementResponseEntitlement'] +slug: /tools/sdk/powershell/v2025/models/machine-identity-user-entitlement-response-entitlement +tags: ['SDK', 'Software Development Kit', 'MachineIdentityUserEntitlementResponseEntitlement', 'V2025MachineIdentityUserEntitlementResponseEntitlement'] +--- + + +# MachineIdentityUserEntitlementResponseEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$MachineIdentityUserEntitlementResponseEntitlement = Initialize-V2025MachineIdentityUserEntitlementResponseEntitlement -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$MachineIdentityUserEntitlementResponseEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponseSource.md b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponseSource.md new file mode 100644 index 000000000..3b372a155 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineIdentityUserEntitlementResponseSource.md @@ -0,0 +1,39 @@ +--- +id: v2025-machine-identity-user-entitlement-response-source +title: MachineIdentityUserEntitlementResponseSource +pagination_label: MachineIdentityUserEntitlementResponseSource +sidebar_label: MachineIdentityUserEntitlementResponseSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentityUserEntitlementResponseSource', 'V2025MachineIdentityUserEntitlementResponseSource'] +slug: /tools/sdk/powershell/v2025/models/machine-identity-user-entitlement-response-source +tags: ['SDK', 'Software Development Kit', 'MachineIdentityUserEntitlementResponseSource', 'V2025MachineIdentityUserEntitlementResponseSource'] +--- + + +# MachineIdentityUserEntitlementResponseSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$MachineIdentityUserEntitlementResponseSource = Initialize-V2025MachineIdentityUserEntitlementResponseSource -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$MachineIdentityUserEntitlementResponseSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index e6afcda9c..70b360d33 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -9552,7 +9552,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities source: | $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* (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* (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** (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) diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index 0389fe72b..41078777f 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -10316,7 +10316,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#list-machine-identities source: | $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) @@ -10333,6 +10333,55 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentities" Write-Host $_.ErrorDetails } +- path: /machine-identity-user-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#list-machine-identity-user-entitlements + source: | + $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 + } +- path: /sources/{sourceId}/aggregate-agents + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#start-machine-identity-aggregation + source: | + $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 + } - path: /machine-identities/{id} method: PATCH xCodeSample: