LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-managed-clients
title: ManagedClients
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/managed-clients
tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'BetaManagedClients']
---
# 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.
@@ -23,9 +23,7 @@ Method | HTTP request | Description
[**Get-BetaManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status.
[**Update-BetaManagedClientStatus**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client
## get-managed-client-status
Retrieve Managed Client Status by ID.
### Parameters
@@ -35,7 +33,6 @@ Path | Id | **String** | True | ID of the Managed Client Status to get
Query | Type | [**ManagedClientType**](../models/managed-client-type) | True | Type of the Managed Client Status to get
### Return type
[**ManagedClientStatus**](../models/managed-client-status)
### Responses
@@ -50,7 +47,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
@@ -58,7 +54,9 @@ Code | Description | Data Type
```powershell
$Id = "aClientId" # String | ID of the Managed Client Status to get
$Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get
# Specified Managed Client Status.
try {
Get-BetaManagedClientStatus-BetaId $Id -BetaType $Type
@@ -69,11 +67,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-client-status
Update a status detail passed in from the client
### Parameters
@@ -83,7 +78,6 @@ Path | Id | **String** | True | ID of the Managed Client Status to update
Body | ManagedClientStatus | [**ManagedClientStatus**](../models/managed-client-status) | True |
### Return type
[**ManagedClientStatusAggResponse**](../models/managed-client-status-agg-response)
### Responses
@@ -98,7 +92,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
@@ -131,7 +124,9 @@ $ManagedClientStatus = @"{
"status" : "NORMAL",
"timestamp" : "2020-01-01T00:00:00Z"
}"@
# Handle status request from client
try {
$Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus
Update-BetaManagedClientStatus-BetaId $Id -BetaManagedClientStatus $Result
@@ -143,7 +138,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)