Update PowerShell SDK docs: 16626938468

2025-12-07 12:27:47 +00:00 · 2025-07-30 15:31:59 +00:00
parent ce49833099
commit 380f1a0949
3 changed files with 544 additions and 0 deletions
--- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md
@@ -17,11 +17,130 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*

 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**New-V2025MachineAccountSubtype**](#create-machine-account-subtype) | **POST** `/sources/{sourceId}/subtypes` | Create subtype
+[**Remove-V2025MachineAccountSubtype**](#delete-machine-account-subtype) | **DELETE** `/sources/{sourceId}/subtypes/{technicalName}` | Delete subtype
 [**Get-V2025MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine account details
+[**Get-V2025MachineAccountSubtypeById**](#get-machine-account-subtype-by-id) | **GET** `/sources/subtype/{subtypeId}` | Retrieve subtype by subtype id
+[**Get-V2025MachineAccountSubtypeByTechnicalName**](#get-machine-account-subtype-by-technical-name) | **GET** `/sources/{sourceId}/subtypes/{technicalName}` | Retrieve subtype by source and technicalName
+[**Get-V2025MachineAccountSubtypes**](#list-machine-account-subtypes) | **GET** `/sources/{sourceId}/subtypes` | Retrieve all subtypes by source
 [**Get-V2025MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine accounts list
+[**Update-V2025MachineAccountSubtype**](#patch-machine-account-subtype) | **PATCH** `/sources/{sourceId}/subtypes/{technicalName}` | Patch subtype
 [**Update-V2025MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a machine account


+## create-machine-account-subtype
+:::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.
+:::
+Create a new machine account subtype for a source.
+
+[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-machine-account-subtype)
+
+### Parameters 
+Param Type | Name | Data Type | Required  | Description
+------------- | ------------- | ------------- | ------------- | ------------- 
+Path   | SourceId | **String** | True  | The ID of the source.
+   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.
+ Body  | SourceSubtype | [**SourceSubtype**](../models/source-subtype) | True  | 
+
+### Return type
+[**SourceSubtype**](../models/source-subtype)
+
+### Responses
+Code | Description  | Data Type
+------------- | ------------- | -------------
+201 | Created machine account subtype. | SourceSubtype
+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&#39;t have access to this end-point. | ErrorResponseDto
+429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
+500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
+
+### HTTP request headers
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### Example
+```powershell
+$SourceId = "6d0458373bec4b4b80460992b76016da" # String | The ID of the source.
+$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+$SourceSubtype = @"{
+  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "displayName" : "Mr Foo",
+  "created" : "2025-07-28T16:13:42.8013Z",
+  "description" : "fighters",
+  "modified" : "2025-07-28T16:13:42.75085Z",
+  "id" : "43bdd144-4b17-4fce-a744-17c7fd3e717b",
+  "technicalName" : "foo"
+}"@
+
+# Create subtype
+
+try {
+    $Result = ConvertFrom-JsonToSourceSubtype -Json $SourceSubtype
+    New-V2025MachineAccountSubtype -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -SourceSubtype $Result 
+    
+    # Below is a request that includes all optional parameters
+    # New-V2025MachineAccountSubtype -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -SourceSubtype $Result  
+} catch {
+    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MachineAccountSubtype"
+    Write-Host $_.ErrorDetails
+}
+```
+[[Back to top]](#) 
+
+## delete-machine-account-subtype
+:::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.
+:::
+Delete a machine account subtype by its ID.
+
+[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-machine-account-subtype)
+
+### Parameters 
+Param Type | Name | Data Type | Required  | Description
+------------- | ------------- | ------------- | ------------- | ------------- 
+Path   | SubtypeId | **String** | True  | The ID of the machine account subtype.
+Path   | TechnicalName | **String** | True  | The technical name of the subtype.
+   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.
+
+### Return type
+ (empty response body)
+
+### Responses
+Code | Description  | Data Type
+------------- | ------------- | -------------
+204 | Subtype deleted successfully. | 
+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&#39;t have access to this end-point. | ErrorResponseDto
+429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
+500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
+
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### Example
+```powershell
+$SubtypeId = "43bdd144-4b17-4fce-a744-17c7fd3e717b" # String | The ID of the machine account subtype.
+$TechnicalName = "foo" # String | The technical name of the subtype.
+$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
+# Delete subtype
+
+try {
+    Remove-V2025MachineAccountSubtype -SubtypeId $SubtypeId -TechnicalName $TechnicalName -XSailPointExperimental $XSailPointExperimental 
+    
+    # Below is a request that includes all optional parameters
+    # Remove-V2025MachineAccountSubtype -SubtypeId $SubtypeId -TechnicalName $TechnicalName -XSailPointExperimental $XSailPointExperimental  
+} catch {
+    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MachineAccountSubtype"
+    Write-Host $_.ErrorDetails
+}
+```
+[[Back to top]](#) 
+
 ## get-machine-account
 :::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.
@@ -73,6 +192,168 @@ try {
 ```
 [[Back to top]](#) 

+## get-machine-account-subtype-by-id
+:::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.
+:::
+Get a machine account subtype by its unique ID.
+
+[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-machine-account-subtype-by-id)
+
+### Parameters 
+Param Type | Name | Data Type | Required  | Description
+------------- | ------------- | ------------- | ------------- | ------------- 
+Path   | SubtypeId | **String** | True  | The ID of the machine account subtype.
+   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.
+
+### Return type
+[**SourceSubtype**](../models/source-subtype)
+
+### Responses
+Code | Description  | Data Type
+------------- | ------------- | -------------
+200 | Machine account subtype object. | SourceSubtype
+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&#39;t have access to this end-point. | ErrorResponseDto
+429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
+500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
+
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### Example
+```powershell
+$SubtypeId = "43bdd144-4b17-4fce-a744-17c7fd3e717b" # String | The ID of the machine account subtype.
+$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
+# Retrieve subtype by subtype id
+
+try {
+    Get-V2025MachineAccountSubtypeById -SubtypeId $SubtypeId -XSailPointExperimental $XSailPointExperimental 
+    
+    # Below is a request that includes all optional parameters
+    # Get-V2025MachineAccountSubtypeById -SubtypeId $SubtypeId -XSailPointExperimental $XSailPointExperimental  
+} catch {
+    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccountSubtypeById"
+    Write-Host $_.ErrorDetails
+}
+```
+[[Back to top]](#) 
+
+## get-machine-account-subtype-by-technical-name
+:::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.
+:::
+Get a machine account subtype by source ID and technical name.
+
+[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-machine-account-subtype-by-technical-name)
+
+### Parameters 
+Param Type | Name | Data Type | Required  | Description
+------------- | ------------- | ------------- | ------------- | ------------- 
+Path   | SourceId | **String** | True  | The ID of the source.
+Path   | TechnicalName | **String** | True  | The technical name of the subtype.
+   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.
+
+### Return type
+[**SourceSubtype**](../models/source-subtype)
+
+### Responses
+Code | Description  | Data Type
+------------- | ------------- | -------------
+200 | Machine account subtype object. | SourceSubtype
+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&#39;t have access to this end-point. | ErrorResponseDto
+429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
+500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
+
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### Example
+```powershell
+$SourceId = "6d0458373bec4b4b80460992b76016da" # String | The ID of the source.
+$TechnicalName = "foo" # String | The technical name of the subtype.
+$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
+# Retrieve subtype by source and technicalName
+
+try {
+    Get-V2025MachineAccountSubtypeByTechnicalName -SourceId $SourceId -TechnicalName $TechnicalName -XSailPointExperimental $XSailPointExperimental 
+    
+    # Below is a request that includes all optional parameters
+    # Get-V2025MachineAccountSubtypeByTechnicalName -SourceId $SourceId -TechnicalName $TechnicalName -XSailPointExperimental $XSailPointExperimental  
+} catch {
+    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccountSubtypeByTechnicalName"
+    Write-Host $_.ErrorDetails
+}
+```
+[[Back to top]](#) 
+
+## list-machine-account-subtypes
+:::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.
+:::
+Get all machine account subtypes for a given source.
+
+[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-machine-account-subtypes)
+
+### Parameters 
+Param Type | Name | Data Type | Required  | Description
+------------- | ------------- | ------------- | ------------- | ------------- 
+Path   | SourceId | **String** | True  | The ID of the source.
+   | 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:  **displayName**: *eq, sw*  **technicalName**: *eq, 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: **displayName, technicalName**
+  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
+[**SourceSubtype[]**](../models/source-subtype)
+
+### Responses
+Code | Description  | Data Type
+------------- | ------------- | -------------
+200 | List of machine account subtypes. | SourceSubtype[]
+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&#39;t have access to this end-point. | ErrorResponseDto
+429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
+500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
+
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### Example
+```powershell
+$SourceId = "6d0458373bec4b4b80460992b76016da" # String | The ID of the 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:  **displayName**: *eq, sw*  **technicalName**: *eq, sw* (optional)
+$Sorters = "displayName" # 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: **displayName, technicalName** (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)
+
+# Retrieve all subtypes by source
+
+try {
+    Get-V2025MachineAccountSubtypes -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental 
+    
+    # Below is a request that includes all optional parameters
+    # Get-V2025MachineAccountSubtypes -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset  
+} catch {
+    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccountSubtypes"
+    Write-Host $_.ErrorDetails
+}
+```
+[[Back to top]](#) 
+
 ## list-machine-accounts
 :::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.
@@ -132,6 +413,70 @@ try {
 ```
 [[Back to top]](#) 

+## patch-machine-account-subtype
+:::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.
+:::
+Update fields of a machine account subtype by its ID.
+Patchable fields include: `displayName`, `description`, `technicalName`.
+
+[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-machine-account-subtype)
+
+### Parameters 
+Param Type | Name | Data Type | Required  | Description
+------------- | ------------- | ------------- | ------------- | ------------- 
+Path   | SubtypeId | **String** | True  | The ID of the machine account subtype.
+Path   | TechnicalName | **String** | True  | The technical name of the subtype.
+   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.
+ Body  | SourceSubtype | [**SourceSubtype**](../models/source-subtype) | True  | 
+
+### Return type
+[**SourceSubtype**](../models/source-subtype)
+
+### Responses
+Code | Description  | Data Type
+------------- | ------------- | -------------
+200 | Updated machine account subtype. | SourceSubtype
+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&#39;t have access to this end-point. | ErrorResponseDto
+429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
+500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
+
+### HTTP request headers
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### Example
+```powershell
+$SubtypeId = "43bdd144-4b17-4fce-a744-17c7fd3e717b" # String | The ID of the machine account subtype.
+$TechnicalName = "foo" # String | The technical name of the subtype.
+$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+$SourceSubtype = @"{
+  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+  "displayName" : "Mr Foo",
+  "created" : "2025-07-28T16:13:42.8013Z",
+  "description" : "fighters",
+  "modified" : "2025-07-28T16:13:42.75085Z",
+  "id" : "43bdd144-4b17-4fce-a744-17c7fd3e717b",
+  "technicalName" : "foo"
+}"@
+
+# Patch subtype
+
+try {
+    $Result = ConvertFrom-JsonToSourceSubtype -Json $SourceSubtype
+    Update-V2025MachineAccountSubtype -SubtypeId $SubtypeId -TechnicalName $TechnicalName -XSailPointExperimental $XSailPointExperimental -SourceSubtype $Result 
+    
+    # Below is a request that includes all optional parameters
+    # Update-V2025MachineAccountSubtype -SubtypeId $SubtypeId -TechnicalName $TechnicalName -XSailPointExperimental $XSailPointExperimental -SourceSubtype $Result  
+} catch {
+    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineAccountSubtype"
+    Write-Host $_.ErrorDetails
+}
+```
+[[Back to top]](#) 
+
 ## update-machine-account
 :::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.
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceSubtype.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceSubtype.md
@@ -0,0 +1,47 @@
+---
+id: v2025-source-subtype
+title: SourceSubtype
+pagination_label: SourceSubtype
+sidebar_label: SourceSubtype
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSubtype', 'V2025SourceSubtype'] 
+slug: /tools/sdk/powershell/v2025/models/source-subtype
+tags: ['SDK', 'Software Development Kit', 'SourceSubtype', 'V2025SourceSubtype']
+---
+
+
+# SourceSubtype
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Id** | **String** | Unique identifier for the subtype. | [optional] 
+**SourceId** | **String** | The ID of the source. | [optional] [readonly] 
+**TechnicalName** | **String** | Technical name of the subtype. | [required]
+**DisplayName** | **String** | Display name of the subtype. | [required]
+**Description** | **String** | Description of the subtype. | [required]
+**Created** | **System.DateTime** | Creation timestamp. | [optional] 
+**Modified** | **System.DateTime** | Last modified timestamp. | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$SourceSubtype = Initialize-V2025SourceSubtype  -Id 43bdd144-4b17-4fce-a744-17c7fd3e717b `
+ -SourceId null `
+ -TechnicalName foo `
+ -DisplayName Mr Foo `
+ -Description fighters `
+ -Created 2025-07-28T16:13:42.801300Z `
+ -Modified 2025-07-28T16:13:42.750850Z
+```
+
+- Convert the resource to JSON
+```powershell
+$SourceSubtype | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+