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

Update PowerShell SDK docs: 16773201482

Browse Source
This commit is contained in:
developer-relations-sp
2025-08-06 09:35:52 +00:00
parent 18ca546c59
commit 8289556a78
7 changed files with 317 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClientsApi.md
View File

@@ -22,6 +22,7 @@ Method | HTTP request | Description
[**New-V2025ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create managed client
[**Remove-V2025ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete managed client
[**Get-V2025ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get managed client
[**Get-V2025ManagedClientHealthIndicators**](#get-managed-client-health-indicators) | **GET** `/managed-clients/{id}/health-indicators` | Get managed client health indicators
[**Get-V2025ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get managed client status
[**Get-V2025ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get managed clients
[**Update-V2025ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update managed client
@@ -170,6 +171,52 @@ try {
```
[[Back to top]](#)
## get-managed-client-health-indicators
Get a managed client's health indicators, using its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-client-health-indicators)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Managed client ID to get health indicators for.
### Return type
[**ManagedClientHealthIndicators**](../models/managed-client-health-indicators)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Response with the managed client health indicators, with the given ID. | ManagedClientHealthIndicators
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
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID to get health indicators for.
# Get managed client health indicators
try {
Get-V2025ManagedClientHealthIndicators -Id $Id
# Below is a request that includes all optional parameters
# Get-V2025ManagedClientHealthIndicators -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClientHealthIndicators"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-client-status
Get a managed client's status, using its ID.

47
docs/tools/sdk/powershell/Reference/V2025/Models/HealthEvent.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: v2025-health-event
title: HealthEvent
pagination_label: HealthEvent
sidebar_label: HealthEvent
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'HealthEvent', 'V2025HealthEvent']
slug: /tools/sdk/powershell/v2025/models/health-event
tags: ['SDK', 'Software Development Kit', 'HealthEvent', 'V2025HealthEvent']
---
# HealthEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**DetailedMessage** | **String** | Description of the issue | [optional]
**Uuid** | **String** | Unique identifier for the health event | [optional]
**Url** | **String** | Optional URL associated with the issue | [optional]
**Timestamp** | **System.DateTime** | Time when the event occurred | [optional]
**LastNotifiedTimeStamp** | **System.DateTime** | Last time notification was sent for this issue | [optional]
**CpuUtilizationPercentage** | **Decimal** | CPU usage percentage | [optional]
**FreeSpacePercentage** | **Decimal** | Free memory percentage | [optional]
## Examples
- Prepare the resource
```powershell
$HealthEvent = Initialize-V2025HealthEvent -DetailedMessage CPU utilization is high `
-Uuid 5 `
-Url https://sample.com:80/ `
-Timestamp 2025-03-25T14:46:58.605Z `
-LastNotifiedTimeStamp 2025-08-06T06:53:22.206956Z `
-CpuUtilizationPercentage 80 `
-FreeSpacePercentage 8
```
- Convert the resource to JSON
```powershell
$HealthEvent | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2025/Models/HealthIndicatorCategory.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2025-health-indicator-category
title: HealthIndicatorCategory
pagination_label: HealthIndicatorCategory
sidebar_label: HealthIndicatorCategory
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'HealthIndicatorCategory', 'V2025HealthIndicatorCategory']
slug: /tools/sdk/powershell/v2025/models/health-indicator-category
tags: ['SDK', 'Software Development Kit', 'HealthIndicatorCategory', 'V2025HealthIndicatorCategory']
---
# HealthIndicatorCategory
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Errors** | [**[]HealthEvent**](health-event) | List of error events for this category | [optional]
**Warnings** | [**[]HealthEvent**](health-event) | List of warning events for this category | [optional]
## Examples
- Prepare the resource
```powershell
$HealthIndicatorCategory = Initialize-V2025HealthIndicatorCategory -Errors null `
-Warnings null
```
- Convert the resource to JSON
```powershell
$HealthIndicatorCategory | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2025/Models/ManagedClientHealthIndicators.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2025-managed-client-health-indicators
title: ManagedClientHealthIndicators
pagination_label: ManagedClientHealthIndicators
sidebar_label: ManagedClientHealthIndicators
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientHealthIndicators', 'V2025ManagedClientHealthIndicators']
slug: /tools/sdk/powershell/v2025/models/managed-client-health-indicators
tags: ['SDK', 'Software Development Kit', 'ManagedClientHealthIndicators', 'V2025ManagedClientHealthIndicators']
---
# ManagedClientHealthIndicators
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Body** | [**ManagedClientHealthIndicatorsBody**](managed-client-health-indicators-body) | | [required]
**Status** | **Enum** [ "NORMAL", "UNDEFINED", "WARNING", "ERROR", "FAILED" ] | Top-level status of the Managed Client | [required]
**Type** | **Enum** [ "VA", "CCG" ] | Type of the Managed Client | [required]
**Timestamp** | **System.DateTime** | Timestamp when this report was generated | [required]
## Examples
- Prepare the resource
```powershell
$ManagedClientHealthIndicators = Initialize-V2025ManagedClientHealthIndicators -Body null `
-Status NORMAL `
-Type VA `
-Timestamp 2025-08-06T07:35:28.722300Z
```
- Convert the resource to JSON
```powershell
$ManagedClientHealthIndicators | ConvertTo-JSON
```
[[Back to top]](#)

87
docs/tools/sdk/powershell/Reference/V2025/Models/ManagedClientHealthIndicatorsBody.md Normal file
View File

@@ -0,0 +1,87 @@
---
id: v2025-managed-client-health-indicators-body
title: ManagedClientHealthIndicatorsBody
pagination_label: ManagedClientHealthIndicatorsBody
sidebar_label: ManagedClientHealthIndicatorsBody
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientHealthIndicatorsBody', 'V2025ManagedClientHealthIndicatorsBody']
slug: /tools/sdk/powershell/v2025/models/managed-client-health-indicators-body
tags: ['SDK', 'Software Development Kit', 'ManagedClientHealthIndicatorsBody', 'V2025ManagedClientHealthIndicatorsBody']
---
# ManagedClientHealthIndicatorsBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AlertKey** | **String** | Health indicator alert key | [optional] [readonly]
**Id** | **String** | Unique identifier for the health report | [required]
**ClusterId** | **String** | Cluster ID the health report belongs to | [required]
**ApiUser** | **String** | API user ID sending the health data | [required]
**CcgEtag** | **String** | ETag value for CCG version control | [optional]
**CcgPin** | **String** | PIN value for CCG validation | [optional]
**CookbookEtag** | **String** | ETag for cookbook version | [optional]
**Hostname** | **String** | Hostname of the Managed Client | [required]
**InternalIp** | **String** | Internal IP address of the Managed Client | [optional]
**LastSeen** | **String** | Epoch timestamp (in millis) when last seen | [optional]
**SinceSeen** | **String** | Seconds since last seen | [optional]
**SinceSeenMillis** | **String** | Milliseconds since last seen | [optional]
**LocalDev** | **Boolean** | Indicates if this is a local development instance | [optional] [default to $false]
**VarStacktrace** | **String** | Stacktrace associated with any error, if available | [optional]
**State** | **String** | Optional state value from the client | [optional]
**Status** | **Enum** [ "NORMAL", "UNDEFINED", "WARNING", "ERROR", "FAILED" ] | Status of the client at the time of report | [required]
**Uuid** | **String** | Optional UUID from the client | [optional]
**Product** | **String** | Product type (e.g., idn) | [required]
**VaVersion** | **String** | VA version installed on the client | [optional]
**PlatformVersion** | **String** | Version of the platform on which VA is running | [required]
**OsVersion** | **String** | Operating system version | [required]
**OsType** | **String** | Operating system type | [required]
**Hypervisor** | **String** | Virtualization platform used | [required]
**ConsolidatedHealthIndicatorsStatus** | **Enum** [ "NORMAL", "WARNING", "ERROR" ] | Consolidated health indicator status | [required]
**LastNotifiedCcgVersion** | **String** | The last CCG version for which notification was sent | [optional]
**DeployedProcesses** | **String** | Information about deployed processes | [optional]
**HealthIndicators** | [**ManagedClientHealthIndicatorsBodyHealthIndicators**](managed-client-health-indicators-body-health-indicators) | | [required]
## Examples
- Prepare the resource
```powershell
$ManagedClientHealthIndicatorsBody = Initialize-V2025ManagedClientHealthIndicatorsBody -AlertKey `
-Id 9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2 `
-ClusterId c2a2139cbc754e42b4279a69ec5f58ec `
-ApiUser 9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2 `
-CcgEtag c95e5c4417952dbcc9b4974999ece14e `
-CcgPin NONE `
-CookbookEtag 3018-master-2ce6ac16-20250717124641-3077-master-a101b5fe-20250722162527 `
-Hostname Testing1 `
-InternalIp 172.18.54.5 `
-LastSeen 1754465728720 `
-SinceSeen 23195 `
-SinceSeenMillis 23195 `
-LocalDev false `
-VarStacktrace null `
-State null `
-Status NORMAL `
-Uuid null `
-Product idn `
-VaVersion null `
-PlatformVersion 2 `
-OsVersion 4230.2.1 `
-OsType flatcar `
-Hypervisor vmware `
-ConsolidatedHealthIndicatorsStatus ERROR `
-LastNotifiedCcgVersion 1068 `
-DeployedProcesses null `
-HealthIndicators null
```
- Convert the resource to JSON
```powershell
$ManagedClientHealthIndicatorsBody | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2025/Models/ManagedClientHealthIndicatorsBodyHealthIndicators.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2025-managed-client-health-indicators-body-health-indicators
title: ManagedClientHealthIndicatorsBodyHealthIndicators
pagination_label: ManagedClientHealthIndicatorsBodyHealthIndicators
sidebar_label: ManagedClientHealthIndicatorsBodyHealthIndicators
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientHealthIndicatorsBodyHealthIndicators', 'V2025ManagedClientHealthIndicatorsBodyHealthIndicators']
slug: /tools/sdk/powershell/v2025/models/managed-client-health-indicators-body-health-indicators
tags: ['SDK', 'Software Development Kit', 'ManagedClientHealthIndicatorsBodyHealthIndicators', 'V2025ManagedClientHealthIndicatorsBodyHealthIndicators']
---
# ManagedClientHealthIndicatorsBodyHealthIndicators
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Container** | [**HealthIndicatorCategory**](health-indicator-category) | | [optional]
**Memory** | [**HealthIndicatorCategory**](health-indicator-category) | | [optional]
**Cpu** | [**HealthIndicatorCategory**](health-indicator-category) | | [optional]
## Examples
- Prepare the resource
```powershell
$ManagedClientHealthIndicatorsBodyHealthIndicators = Initialize-V2025ManagedClientHealthIndicatorsBodyHealthIndicators -Container null `
-Memory null `
-Cpu null
```
- Convert the resource to JSON
```powershell
$ManagedClientHealthIndicatorsBodyHealthIndicators | ConvertTo-JSON
```
[[Back to top]](#)