Skip to content

Commit b411416

Browse files
developer-relations-spdeveloper-relations-sp
committed
Automated build 'Automated commit 'Merge pull request #2233 from sailpoint/cgaikwad/PLTCONN-8015
PLTCONN-8015 : Add API documentation for managed-clients/{{id}}/health-indicators API' by github action: 16773156287' powershell sdk: 16773168187
1 parent f30232e commit b411416

26 files changed

Lines changed: 1578 additions & 19 deletions

‎PSSailpoint/PSSailpoint.psd1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Sailpoint Developer Relations
55
#
6-
# Generated on: 08/01/2025
6+
# Generated on: 08/06/2025
77
#
88

99
@{

‎PSSailpoint/beta/src/PSSailpoint.Beta/PSSailpoint.Beta.psd1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: OpenAPI Generator Team
55
#
6-
# Generated on: 08/01/2025
6+
# Generated on: 08/06/2025
77
#
88

99
@{

‎PSSailpoint/v2024/src/PSSailpoint.V2024/PSSailpoint.V2024.psd1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: OpenAPI Generator Team
55
#
6-
# Generated on: 08/01/2025
6+
# Generated on: 08/06/2025
77
#
88

99
@{

‎PSSailpoint/v2025/.openapi-generator/FILES‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,8 @@ docs/GetReferenceIdentityAttribute.md
501501
docs/GetRoleAssignments200ResponseInner.md
502502
docs/GetTenantContext200ResponseInner.md
503503
docs/GrantType.md
504+
docs/HealthEvent.md
505+
docs/HealthIndicatorCategory.md
504506
docs/HierarchicalRightSet.md
505507
docs/HttpAuthenticationType.md
506508
docs/HttpConfig.md
@@ -641,6 +643,9 @@ docs/MachineIdentityDtoOwners.md
641643
docs/MailFromAttributes.md
642644
docs/MailFromAttributesDto.md
643645
docs/ManagedClient.md
646+
docs/ManagedClientHealthIndicators.md
647+
docs/ManagedClientHealthIndicatorsBody.md
648+
docs/ManagedClientHealthIndicatorsBodyHealthIndicators.md
644649
docs/ManagedClientRequest.md
645650
docs/ManagedClientStatus.md
646651
docs/ManagedClientStatusCode.md
@@ -2001,6 +2006,8 @@ src/PSSailpoint.V2025/Model/GetReferenceIdentityAttribute.ps1
20012006
src/PSSailpoint.V2025/Model/GetRoleAssignments200ResponseInner.ps1
20022007
src/PSSailpoint.V2025/Model/GetTenantContext200ResponseInner.ps1
20032008
src/PSSailpoint.V2025/Model/GrantType.ps1
2009+
src/PSSailpoint.V2025/Model/HealthEvent.ps1
2010+
src/PSSailpoint.V2025/Model/HealthIndicatorCategory.ps1
20042011
src/PSSailpoint.V2025/Model/HierarchicalRightSet.ps1
20052012
src/PSSailpoint.V2025/Model/HttpAuthenticationType.ps1
20062013
src/PSSailpoint.V2025/Model/HttpConfig.ps1
@@ -2141,6 +2148,9 @@ src/PSSailpoint.V2025/Model/MachineIdentityDtoOwners.ps1
21412148
src/PSSailpoint.V2025/Model/MailFromAttributes.ps1
21422149
src/PSSailpoint.V2025/Model/MailFromAttributesDto.ps1
21432150
src/PSSailpoint.V2025/Model/ManagedClient.ps1
2151+
src/PSSailpoint.V2025/Model/ManagedClientHealthIndicators.ps1
2152+
src/PSSailpoint.V2025/Model/ManagedClientHealthIndicatorsBody.ps1
2153+
src/PSSailpoint.V2025/Model/ManagedClientHealthIndicatorsBodyHealthIndicators.ps1
21442154
src/PSSailpoint.V2025/Model/ManagedClientRequest.ps1
21452155
src/PSSailpoint.V2025/Model/ManagedClientStatus.ps1
21462156
src/PSSailpoint.V2025/Model/ManagedClientStatusCode.ps1
@@ -3321,6 +3331,8 @@ tests/Model/GetReferenceIdentityAttribute.Tests.ps1
33213331
tests/Model/GetRoleAssignments200ResponseInner.Tests.ps1
33223332
tests/Model/GetTenantContext200ResponseInner.Tests.ps1
33233333
tests/Model/GrantType.Tests.ps1
3334+
tests/Model/HealthEvent.Tests.ps1
3335+
tests/Model/HealthIndicatorCategory.Tests.ps1
33243336
tests/Model/HierarchicalRightSet.Tests.ps1
33253337
tests/Model/HttpAuthenticationType.Tests.ps1
33263338
tests/Model/HttpConfig.Tests.ps1
@@ -3461,6 +3473,9 @@ tests/Model/MachineIdentityDtoOwners.Tests.ps1
34613473
tests/Model/MailFromAttributes.Tests.ps1
34623474
tests/Model/MailFromAttributesDto.Tests.ps1
34633475
tests/Model/ManagedClient.Tests.ps1
3476+
tests/Model/ManagedClientHealthIndicators.Tests.ps1
3477+
tests/Model/ManagedClientHealthIndicatorsBody.Tests.ps1
3478+
tests/Model/ManagedClientHealthIndicatorsBodyHealthIndicators.Tests.ps1
34643479
tests/Model/ManagedClientRequest.Tests.ps1
34653480
tests/Model/ManagedClientStatus.Tests.ps1
34663481
tests/Model/ManagedClientStatusCode.Tests.ps1

‎PSSailpoint/v2025/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,7 @@ Class | Method | HTTP request | Description
437437
*V2025ManagedClientsApi* | [**New-V2025ManagedClient**](docs/V2025ManagedClientsApi.md#New-V2025ManagedClient) | **POST** /managed-clients | Create managed client
438438
*V2025ManagedClientsApi* | [**Remove-V2025ManagedClient**](docs/V2025ManagedClientsApi.md#Remove-V2025ManagedClient) | **DELETE** /managed-clients/{id} | Delete managed client
439439
*V2025ManagedClientsApi* | [**Get-V2025ManagedClient**](docs/V2025ManagedClientsApi.md#Get-V2025ManagedClient) | **GET** /managed-clients/{id} | Get managed client
440+
*V2025ManagedClientsApi* | [**Get-V2025ManagedClientHealthIndicators**](docs/V2025ManagedClientsApi.md#Get-V2025ManagedClientHealthIndicators) | **GET** /managed-clients/{id}/health-indicators | Get managed client health indicators
440441
*V2025ManagedClientsApi* | [**Get-V2025ManagedClientStatus**](docs/V2025ManagedClientsApi.md#Get-V2025ManagedClientStatus) | **GET** /managed-clients/{id}/status | Get managed client status
441442
*V2025ManagedClientsApi* | [**Get-V2025ManagedClients**](docs/V2025ManagedClientsApi.md#Get-V2025ManagedClients) | **GET** /managed-clients | Get managed clients
442443
*V2025ManagedClientsApi* | [**Update-V2025ManagedClient**](docs/V2025ManagedClientsApi.md#Update-V2025ManagedClient) | **PATCH** /managed-clients/{id} | Update managed client
@@ -1282,6 +1283,8 @@ Class | Method | HTTP request | Description
12821283
- [PSSailpoint.V2025\Model.GetRoleAssignments200ResponseInner](docs/GetRoleAssignments200ResponseInner.md)
12831284
- [PSSailpoint.V2025\Model.GetTenantContext200ResponseInner](docs/GetTenantContext200ResponseInner.md)
12841285
- [PSSailpoint.V2025\Model.GrantType](docs/GrantType.md)
1286+
- [PSSailpoint.V2025\Model.HealthEvent](docs/HealthEvent.md)
1287+
- [PSSailpoint.V2025\Model.HealthIndicatorCategory](docs/HealthIndicatorCategory.md)
12851288
- [PSSailpoint.V2025\Model.HierarchicalRightSet](docs/HierarchicalRightSet.md)
12861289
- [PSSailpoint.V2025\Model.HttpAuthenticationType](docs/HttpAuthenticationType.md)
12871290
- [PSSailpoint.V2025\Model.HttpConfig](docs/HttpConfig.md)
@@ -1422,6 +1425,9 @@ Class | Method | HTTP request | Description
14221425
- [PSSailpoint.V2025\Model.MailFromAttributes](docs/MailFromAttributes.md)
14231426
- [PSSailpoint.V2025\Model.MailFromAttributesDto](docs/MailFromAttributesDto.md)
14241427
- [PSSailpoint.V2025\Model.ManagedClient](docs/ManagedClient.md)
1428+
- [PSSailpoint.V2025\Model.ManagedClientHealthIndicators](docs/ManagedClientHealthIndicators.md)
1429+
- [PSSailpoint.V2025\Model.ManagedClientHealthIndicatorsBody](docs/ManagedClientHealthIndicatorsBody.md)
1430+
- [PSSailpoint.V2025\Model.ManagedClientHealthIndicatorsBodyHealthIndicators](docs/ManagedClientHealthIndicatorsBodyHealthIndicators.md)
14251431
- [PSSailpoint.V2025\Model.ManagedClientRequest](docs/ManagedClientRequest.md)
14261432
- [PSSailpoint.V2025\Model.ManagedClientStatus](docs/ManagedClientStatus.md)
14271433
- [PSSailpoint.V2025\Model.ManagedClientStatusCode](docs/ManagedClientStatusCode.md)

‎PSSailpoint/v2025/docs/Examples/powershell_code_examples_overlay.yaml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10268,6 +10268,25 @@
1026810268
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClient"
1026910269
Write-Host $_.ErrorDetails
1027010270
}
10271+
- path: /managed-clients/{id}/health-indicators
10272+
method: GET
10273+
xCodeSample:
10274+
- lang: PowerShell
10275+
label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client-health-indicators
10276+
source: |
10277+
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID to get health indicators for.
10278+
10279+
# Get managed client health indicators
10280+
10281+
try {
10282+
Get-V2025ManagedClientHealthIndicators -Id $Id
10283+
10284+
# Below is a request that includes all optional parameters
10285+
# Get-V2025ManagedClientHealthIndicators -Id $Id
10286+
} catch {
10287+
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClientHealthIndicators"
10288+
Write-Host $_.ErrorDetails
10289+
}
1027110290
- path: /managed-clients/{id}/status
1027210291
method: GET
1027310292
xCodeSample:

‎PSSailpoint/v2025/docs/Methods/V2025ManagedClientsApi.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Method | HTTP request | Description
2222
[**New-V2025ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create managed client
2323
[**Remove-V2025ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete managed client
2424
[**Get-V2025ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get managed client
25+
[**Get-V2025ManagedClientHealthIndicators**](#get-managed-client-health-indicators) | **GET** `/managed-clients/{id}/health-indicators` | Get managed client health indicators
2526
[**Get-V2025ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get managed client status
2627
[**Get-V2025ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get managed clients
2728
[**Update-V2025ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update managed client
@@ -170,6 +171,52 @@ try {
170171
```
171172
[[Back to top]](#)
172173

174+
## get-managed-client-health-indicators
175+
Get a managed client's health indicators, using its ID.
176+
177+
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-client-health-indicators)
178+
179+
### Parameters
180+
Param Type | Name | Data Type | Required | Description
181+
------------- | ------------- | ------------- | ------------- | -------------
182+
Path | Id | **String** | True | Managed client ID to get health indicators for.
183+
184+
### Return type
185+
[**ManagedClientHealthIndicators**](../models/managed-client-health-indicators)
186+
187+
### Responses
188+
Code | Description | Data Type
189+
------------- | ------------- | -------------
190+
200 | Response with the managed client health indicators, with the given ID. | ManagedClientHealthIndicators
191+
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
192+
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
193+
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
194+
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
195+
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
196+
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
197+
198+
### HTTP request headers
199+
- **Content-Type**: Not defined
200+
- **Accept**: application/json
201+
202+
### Example
203+
```powershell
204+
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID to get health indicators for.
205+
206+
# Get managed client health indicators
207+
208+
try {
209+
Get-V2025ManagedClientHealthIndicators -Id $Id
210+
211+
# Below is a request that includes all optional parameters
212+
# Get-V2025ManagedClientHealthIndicators -Id $Id
213+
} catch {
214+
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClientHealthIndicators"
215+
Write-Host $_.ErrorDetails
216+
}
217+
```
218+
[[Back to top]](#)
219+
173220
## get-managed-client-status
174221
Get a managed client's status, using its ID.
175222

‎PSSailpoint/v2025/docs/Models/HealthEvent.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
id: v2025-health-event
3+
title: HealthEvent
4+
pagination_label: HealthEvent
5+
sidebar_label: HealthEvent
6+
sidebar_class_name: powershellsdk
7+
keywords: ['powershell', 'PowerShell', 'sdk', 'HealthEvent', 'V2025HealthEvent']
8+
slug: /tools/sdk/powershell/v2025/models/health-event
9+
tags: ['SDK', 'Software Development Kit', 'HealthEvent', 'V2025HealthEvent']
10+
---
11+
12+
13+
# HealthEvent
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**DetailedMessage** | **String** | Description of the issue | [optional]
20+
**Uuid** | **String** | Unique identifier for the health event | [optional]
21+
**Url** | **String** | Optional URL associated with the issue | [optional]
22+
**Timestamp** | **System.DateTime** | Time when the event occurred | [optional]
23+
**LastNotifiedTimeStamp** | **System.DateTime** | Last time notification was sent for this issue | [optional]
24+
**CpuUtilizationPercentage** | **Decimal** | CPU usage percentage | [optional]
25+
**FreeSpacePercentage** | **Decimal** | Free memory percentage | [optional]
26+
27+
## Examples
28+
29+
- Prepare the resource
30+
```powershell
31+
$HealthEvent = Initialize-V2025HealthEvent -DetailedMessage CPU utilization is high `
32+
-Uuid 5 `
33+
-Url https://sample.com:80/ `
34+
-Timestamp 2025-03-25T14:46:58.605Z `
35+
-LastNotifiedTimeStamp 2025-08-06T06:53:22.206956Z `
36+
-CpuUtilizationPercentage 80 `
37+
-FreeSpacePercentage 8
38+
```
39+
40+
- Convert the resource to JSON
41+
```powershell
42+
$HealthEvent | ConvertTo-JSON
43+
```
44+
45+
46+
[[Back to top]](#)
47+

‎PSSailpoint/v2025/docs/Models/HealthIndicatorCategory.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
id: v2025-health-indicator-category
3+
title: HealthIndicatorCategory
4+
pagination_label: HealthIndicatorCategory
5+
sidebar_label: HealthIndicatorCategory
6+
sidebar_class_name: powershellsdk
7+
keywords: ['powershell', 'PowerShell', 'sdk', 'HealthIndicatorCategory', 'V2025HealthIndicatorCategory']
8+
slug: /tools/sdk/powershell/v2025/models/health-indicator-category
9+
tags: ['SDK', 'Software Development Kit', 'HealthIndicatorCategory', 'V2025HealthIndicatorCategory']
10+
---
11+
12+
13+
# HealthIndicatorCategory
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**Errors** | [**[]HealthEvent**](health-event) | List of error events for this category | [optional]
20+
**Warnings** | [**[]HealthEvent**](health-event) | List of warning events for this category | [optional]
21+
22+
## Examples
23+
24+
- Prepare the resource
25+
```powershell
26+
$HealthIndicatorCategory = Initialize-V2025HealthIndicatorCategory -Errors null `
27+
-Warnings null
28+
```
29+
30+
- Convert the resource to JSON
31+
```powershell
32+
$HealthIndicatorCategory | ConvertTo-JSON
33+
```
34+
35+
36+
[[Back to top]](#)
37+

‎PSSailpoint/v2025/docs/Models/ManagedClientHealthIndicators.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: v2025-managed-client-health-indicators
3+
title: ManagedClientHealthIndicators
4+
pagination_label: ManagedClientHealthIndicators
5+
sidebar_label: ManagedClientHealthIndicators
6+
sidebar_class_name: powershellsdk
7+
keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientHealthIndicators', 'V2025ManagedClientHealthIndicators']
8+
slug: /tools/sdk/powershell/v2025/models/managed-client-health-indicators
9+
tags: ['SDK', 'Software Development Kit', 'ManagedClientHealthIndicators', 'V2025ManagedClientHealthIndicators']
10+
---
11+
12+
13+
# ManagedClientHealthIndicators
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**Body** | [**ManagedClientHealthIndicatorsBody**](managed-client-health-indicators-body) | | [required]
20+
**Status** | **Enum** [ "NORMAL", "UNDEFINED", "WARNING", "ERROR", "FAILED" ] | Top-level status of the Managed Client | [required]
21+
**Type** | **Enum** [ "VA", "CCG" ] | Type of the Managed Client | [required]
22+
**Timestamp** | **System.DateTime** | Timestamp when this report was generated | [required]
23+
24+
## Examples
25+
26+
- Prepare the resource
27+
```powershell
28+
$ManagedClientHealthIndicators = Initialize-V2025ManagedClientHealthIndicators -Body null `
29+
-Status NORMAL `
30+
-Type VA `
31+
-Timestamp 2025-08-06T07:35:28.722300Z
32+
```
33+
34+
- Convert the resource to JSON
35+
```powershell
36+
$ManagedClientHealthIndicators | ConvertTo-JSON
37+
```
38+
39+
40+
[[Back to top]](#)
41+

0 commit comments

Comments
 (0)