Update to powershell SDK docs: 13122455471

2025-12-09 20:37:47 +00:00 · 2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
--- a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md
+++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md
@@ -1,3 +1,4 @@
+
 ---
 id: managed-clients
 title: ManagedClients
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/managed-clients
 tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'ManagedClients']
 ---

-
 # ManagedClients
  Use this API to implement managed client functionality. 
 With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. 
@@ -27,9 +27,7 @@ Method | HTTP request | Description
 [**Get-ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients
 [**Update-ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client

-
 ## create-managed-client
-
 Create a new managed client.
 The API returns a result that includes the managed client ID.

@@ -39,7 +37,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | ManagedClientRequest | [**ManagedClientRequest**](../models/managed-client-request) | True  | 

 ### Return type
-
 [**ManagedClient**](../models/managed-client)

 ### Responses
@@ -53,7 +50,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -65,7 +61,9 @@ $ManagedClientRequest = @"{
  "clusterId" : "aClusterId",
  "type" : "VA"
 }"@
+
 # Create Managed Client
+
 try {
    $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
    New-ManagedClient-ManagedClientRequest $Result
@@ -77,11 +75,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## delete-managed-client
-
 Delete an existing managed client.

 ### Parameters 
@@ -90,7 +85,6 @@ Param Type | Name | Data Type | Required  | Description
 Path   | Id | **String** | True  | Managed client ID.

 ### Return type
-
 (empty response body)

 ### Responses
@@ -104,14 +98,15 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
 $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
+
 # Delete Managed Client
+
 try {
    Remove-ManagedClient-Id $Id 
    
@@ -122,11 +117,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-managed-client
-
 Get managed client by ID. 

 ### Parameters 
@@ -135,7 +127,6 @@ Param Type | Name | Data Type | Required  | Description
 Path   | Id | **String** | True  | Managed client ID.

 ### Return type
-
 [**ManagedClient**](../models/managed-client)

 ### Responses
@@ -150,14 +141,15 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
 $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
+
 # Get Managed Client
+
 try {
    Get-ManagedClient-Id $Id 
    
@@ -168,11 +160,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-managed-client-status
-
 Get a managed client's status, using its ID.

 ### Parameters 
@@ -182,7 +171,6 @@ Path   | Id | **String** | True  | Managed client ID to get status for.
  Query | Type | [**ManagedClientType**](../models/managed-client-type) | True  | Managed client type to get status for.

 ### Return type
-
 [**ManagedClientStatus**](../models/managed-client-status)

 ### Responses
@@ -197,7 +185,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -205,7 +192,9 @@ Code | Description  | Data Type
 ```powershell
 $Id = "aClientId" # String | Managed client ID to get status for.
 $Type = "CCG" # ManagedClientType | Managed client type to get status for.
+
 # Get Managed Client Status
+
 try {
    Get-ManagedClientStatus-Id $Id -Type $Type 
    
@@ -216,11 +205,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-managed-clients
-
 List managed clients.

 ### Parameters 
@@ -232,7 +218,6 @@ Param Type | Name | Data Type | Required  | Description
  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*  **name**: *eq*  **clientId**: *eq*  **clusterId**: *eq*

 ### Return type
-
 [**ManagedClient[]**](../models/managed-client)

 ### Responses
@@ -246,7 +231,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -256,7 +240,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
 $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)
 $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)
 $Filters = 'name eq "client name"' # 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*  **name**: *eq*  **clientId**: *eq*  **clusterId**: *eq* (optional)
+
 # Get Managed Clients
+
 try {
    Get-ManagedClients
    
@@ -267,11 +253,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## update-managed-client
-
 Update an existing managed client.

 ### Parameters 
@@ -281,7 +264,6 @@ Path   | Id | **String** | True  | Managed client ID.
 Body  | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True  | JSONPatch payload used to update the object.

 ### Return type
-
 [**ManagedClient**](../models/managed-client)

 ### Responses
@@ -296,21 +278,21 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json-patch+json
 - **Accept**: application/json

 ### Example
 ```powershell
 $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
- # JsonPatchOperation[] | JSONPatch payload used to update the object.
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
-}"@ 
+}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object.
+ 

 # Update Managed Client
+
 try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-ManagedClient-Id $Id -JsonPatchOperation $Result
@@ -322,7 +304,4 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
-