ManagedClientsApi

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.

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-managed-client-v1	POST /managed-clients/v1	Create managed client
delete-managed-client-v1	DELETE /managed-clients/v1/{id}	Delete managed client
get-managed-client-health-indicators-v1	GET /managed-clients/v1/{id}/health-indicators	Get managed client health indicators
get-managed-client-status-v1	GET /managed-clients/v1/{id}/status	Get managed client status
get-managed-client-v1	GET /managed-clients/v1/{id}	Get managed client
get-managed-clients-v1	GET /managed-clients/v1	Get managed clients
update-managed-client-v1	PATCH /managed-clients/v1/{id}	Update managed client

create-managed-client-v1

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

API Spec

Parameters

Name	Type	Description	Notes
managedclientrequest	Managedclientrequest

Return type

Managedclient

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { ManagedClientsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ManagedClientsApi(configuration);
const managedclientrequest: Managedclientrequest = ; // 
const result = await apiInstance.createManagedClientV1({ managedclientrequest: managedclientrequest });
console.log(result);

[Back to top]

delete-managed-client-v1

Delete managed client Delete an existing managed client.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Managed client ID.	[default to undefined]

Return type

(empty response body)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ManagedClientsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ManagedClientsApi(configuration);
const id: string = 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7; // Managed client ID.
const result = await apiInstance.deleteManagedClientV1({ id: id });
console.log(result);

[Back to top]

get-managed-client-health-indicators-v1

Get managed client health indicators Get a managed client's health indicators, using its ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Managed client ID to get health indicators for.	[default to undefined]

Return type

Managedclienthealthindicators

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ManagedClientsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ManagedClientsApi(configuration);
const id: string = 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7; // Managed client ID to get health indicators for.
const result = await apiInstance.getManagedClientHealthIndicatorsV1({ id: id });
console.log(result);

[Back to top]

get-managed-client-status-v1

Get managed client status Get a managed client's status, using its ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Managed client ID to get status for.	[default to undefined]
type	Managedclienttype	Managed client type to get status for.	[default to undefined]

Return type

Managedclientstatus

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ManagedClientsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ManagedClientsApi(configuration);
const id: string = aClientId; // Managed client ID to get status for.
const type: Managedclienttype = ; // Managed client type to get status for.
const result = await apiInstance.getManagedClientStatusV1({ id: id, type: type });
console.log(result);

[Back to top]

get-managed-client-v1

Get managed client Get managed client by ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Managed client ID.	[default to undefined]

Return type

Managedclient

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ManagedClientsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ManagedClientsApi(configuration);
const id: string = 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7; // Managed client ID.
const result = await apiInstance.getManagedClientV1({ id: id });
console.log(result);

[Back to top]

get-managed-clients-v1

Get managed clients List managed clients.

API Spec

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: id: eq name: eq clientId: eq clusterId: eq	[optional] [default to undefined]

Return type

Array<Managedclient>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ManagedClientsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ManagedClientsApi(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 = name eq "client name"; // 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)
const result = await apiInstance.getManagedClientsV1({  });
console.log(result);

[Back to top]

update-managed-client-v1

Update managed client Update an existing managed client.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Managed client ID.	[default to undefined]
jsonpatchoperation	Array<Jsonpatchoperation>	JSONPatch payload used to update the object.

Return type

Managedclient

HTTP request headers

• Content-Type: application/json-patch+json
• Accept: application/json

Example

import { ManagedClientsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ManagedClientsApi(configuration);
const id: string = 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7; // Managed client ID.
const jsonpatchoperation: Array<Jsonpatchoperation> = ; // JSONPatch payload used to update the object.
const result = await apiInstance.updateManagedClientV1({ id: id, jsonpatchoperation: jsonpatchoperation });
console.log(result);

[Back to top]