ManagedClustersApi
Use this API to implement managed cluster functionality. With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| create-managed-cluster-v1 | POST /managed-clusters/v1 | Create create managed cluster |
| delete-managed-cluster-v1 | DELETE /managed-clusters/v1/{id} | Delete managed cluster |
| get-client-log-configuration-v1 | GET /managed-clusters/v1/{id}/log-config | Get managed cluster log configuration |
| get-managed-cluster-v1 | GET /managed-clusters/v1/{id} | Get managed cluster |
| get-managed-clusters-v1 | GET /managed-clusters/v1 | Get managed clusters |
| put-client-log-configuration-v1 | PUT /managed-clusters/v1/{id}/log-config | Update managed cluster log configuration |
| update-managed-cluster-v1 | PATCH /managed-clusters/v1/{id} | Update managed cluster |
| update-v1 | POST /managed-clusters/v1/{id}/manualUpgrade | Trigger manual upgrade for managed cluster |
create-managed-cluster-v1
Create create managed cluster Create a new Managed Cluster. The API returns a result that includes the managed cluster ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| managedclusterrequest | Managedclusterrequest |
Return type
Managedcluster
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { ManagedClustersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ManagedClustersApi(configuration);
const managedclusterrequest: Managedclusterrequest = ; //
const result = await apiInstance.createManagedClusterV1({ managedclusterrequest: managedclusterrequest });
console.log(result);
delete-managed-cluster-v1
Delete managed cluster Delete an existing managed cluster.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Managed cluster ID. | [default to undefined] |
| removeClients | boolean | Flag to determine the need to delete a cluster with clients. | [optional] [default to false] |
Return type
(empty response body)
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ManagedClustersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ManagedClustersApi(configuration);
const id: string = 2c9180897de347a2017de8859e8c5039; // Managed cluster ID.
const removeClients: boolean = false; // Flag to determine the need to delete a cluster with clients. (optional)
const result = await apiInstance.deleteManagedClusterV1({ id: id });
console.log(result);
get-client-log-configuration-v1
Get managed cluster log configuration Get a managed cluster's log configuration.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of managed cluster to get log configuration for. | [default to undefined] |
Return type
Clientlogconfiguration
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ManagedClustersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ManagedClustersApi(configuration);
const id: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // ID of managed cluster to get log configuration for.
const result = await apiInstance.getClientLogConfigurationV1({ id: id });
console.log(result);
get-managed-cluster-v1
Get managed cluster Get a managed cluster by ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Managed cluster ID. | [default to undefined] |
Return type
Managedcluster
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ManagedClustersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ManagedClustersApi(configuration);
const id: string = 2c9180897de347a2017de8859e8c5039; // Managed cluster ID.
const result = await apiInstance.getManagedClusterV1({ id: id });
console.log(result);
get-managed-clusters-v1
Get managed clusters List current organization's managed clusters, based on request context.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 0] |
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| count | 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 for more information. | [optional] [default to false] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: operational: eq name: eq type: eq status: eq | [optional] [default to undefined] |
Return type
Array<Managedcluster>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ManagedClustersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ManagedClustersApi(configuration);
const offset: number = 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. (optional)
const limit: number = 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. (optional)
const count: boolean = true; // 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)
const filters: string = operational eq "operation"; // 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional)
const result = await apiInstance.getManagedClustersV1({ });
console.log(result);
put-client-log-configuration-v1
Update managed cluster log configuration
Update a managed cluster's log configuration. You may only specify one of durationMinutes or expiration, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for durationMinutes is 240.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the managed cluster to update the log configuration for. | [default to undefined] |
| putClientLogConfigurationV1Request | PutClientLogConfigurationV1Request | Client log configuration for the given managed cluster. |
Return type
Clientlogconfiguration
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { ManagedClustersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ManagedClustersApi(configuration);
const id: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // ID of the managed cluster to update the log configuration for.
const putClientLogConfigurationV1Request: PutClientLogConfigurationV1Request = ; // Client log configuration for the given managed cluster.
const result = await apiInstance.putClientLogConfigurationV1({ id: id, putClientLogConfigurationV1Request: putClientLogConfigurationV1Request });
console.log(result);
update-managed-cluster-v1
Update managed cluster Update an existing managed cluster.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Managed cluster ID. | [default to undefined] |
| jsonpatchoperation | Array<Jsonpatchoperation> | JSONPatch payload used to update the object. |
Return type
Managedcluster
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { ManagedClustersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ManagedClustersApi(configuration);
const id: string = 2c9180897de347a2017de8859e8c5039; // Managed cluster ID.
const jsonpatchoperation: Array<Jsonpatchoperation> = ; // JSONPatch payload used to update the object.
const result = await apiInstance.updateManagedClusterV1({ id: id, jsonpatchoperation: jsonpatchoperation });
console.log(result);
update-v1
Trigger manual upgrade for managed cluster Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of managed cluster to trigger manual upgrade. | [default to undefined] |
Return type
Clustermanualupgrade
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ManagedClustersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ManagedClustersApi(configuration);
const id: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // ID of managed cluster to trigger manual upgrade.
const result = await apiInstance.updateV1({ id: id });
console.log(result);