GovernanceGroupsApi
Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud.
A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user.
Refer to Creating and Managing Governance Groups for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| create-workgroup-v1 | POST /workgroups/v1 | Create a new governance group. |
| delete-workgroup-members-v1 | POST /workgroups/v1/{workgroupId}/members/bulk-delete | Remove members from governance group |
| delete-workgroup-v1 | DELETE /workgroups/v1/{id} | Delete a governance group |
| delete-workgroups-in-bulk-v1 | POST /workgroups/v1/bulk-delete | Delete governance group(s) |
| get-workgroup-v1 | GET /workgroups/v1/{id} | Get governance group by id |
| list-connections-v1 | GET /workgroups/v1/{workgroupId}/connections | List connections for governance group |
| list-workgroup-members-v1 | GET /workgroups/v1/{workgroupId}/members | List governance group members |
| list-workgroups-v1 | GET /workgroups/v1 | List governance groups |
| patch-workgroup-v1 | PATCH /workgroups/v1/{id} | Patch a governance group |
| update-workgroup-members-v1 | POST /workgroups/v1/{workgroupId}/members/bulk-add | Add members to governance group |
create-workgroup-v1
Create a new governance group. This API creates a new Governance Group.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workgroupdto | Workgroupdto |
Return type
Workgroupdto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const workgroupdto: Workgroupdto = ; //
const result = await apiInstance.createWorkgroupV1({ workgroupdto: workgroupdto });
console.log(result);
delete-workgroup-members-v1
Remove members from governance group This API removes one or more members from a Governance Group. A
Following field of Identity is an optional field in the request.
name
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workgroupId | string | ID of the Governance Group. | [default to undefined] |
| bulkworkgroupmembersrequestInner | Array<BulkworkgroupmembersrequestInner> | List of identities to be removed from a Governance Group members list. |
Return type
Array<Workgroupmemberdeleteitem>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const workgroupId: string = 2c91808a7813090a017814121919ecca; // ID of the Governance Group.
const bulkworkgroupmembersrequestInner: Array<BulkworkgroupmembersrequestInner> = ; // List of identities to be removed from a Governance Group members list.
const result = await apiInstance.deleteWorkgroupMembersV1({ workgroupId: workgroupId, bulkworkgroupmembersrequestInner: bulkworkgroupmembersrequestInner });
console.log(result);
delete-workgroup-v1
Delete a governance group This API deletes a Governance Group by its ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the Governance Group | [default to undefined] |
Return type
(empty response body)
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const id: string = 2c9180837ca6693d017ca8d097500149; // ID of the Governance Group
const result = await apiInstance.deleteWorkgroupV1({ id: id });
console.log(result);
delete-workgroups-in-bulk-v1
Delete governance group(s)
This API initiates a bulk deletion of one or more Governance Groups.
If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in inUse list of the response. Governance Group(s) marked as inUse can not be deleted.
If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in notFound list of the response. Governance Groups marked as notFound will not be deleted.
If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in deleted list of the response. A Governance Group marked as deleted will be deleted from current Organization.
If the request contains any inUse or notFound Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it.
This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workgroupbulkdeleterequest | Workgroupbulkdeleterequest |
Return type
Array<Workgroupdeleteitem>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const workgroupbulkdeleterequest: Workgroupbulkdeleterequest = {"ids":["567a697e-885b-495a-afc5-d55e1c23a302","c7b0f7b2-1e78-4063-b294-a555333dacd2"]}; //
const result = await apiInstance.deleteWorkgroupsInBulkV1({ workgroupbulkdeleterequest: workgroupbulkdeleterequest });
console.log(result);
get-workgroup-v1
Get governance group by id This API returns a Governance Groups by its ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the Governance Group | [default to undefined] |
Return type
Workgroupdto
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const id: string = 2c9180837ca6693d017ca8d097500149; // ID of the Governance Group
const result = await apiInstance.getWorkgroupV1({ id: id });
console.log(result);
list-connections-v1
List connections for governance group This API returns list of connections associated with a Governance Group.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workgroupId | string | ID of the Governance Group. | [default to undefined] |
| 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 | Note that for this API the maximum value for limit is 50. See V3 API Standard Collection Parameters for more information. | [optional] [default to 50] |
| 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] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, created, modified | [optional] [default to undefined] |
Return type
Array<Workgroupconnectiondto>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const workgroupId: string = 2c91808a7813090a017814121919ecca; // ID of the Governance Group.
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 = 50; // Note that for this API the maximum value for limit is 50. 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 sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
const result = await apiInstance.listConnectionsV1({ workgroupId: workgroupId });
console.log(result);
list-workgroup-members-v1
List governance group members This API returns list of members associated with a Governance Group.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workgroupId | string | ID of the Governance Group. | [default to undefined] |
| 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 | Note that for this API the maximum value for limit is 50. See V3 API Standard Collection Parameters for more information. | [optional] [default to 50] |
| 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] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, created, modified | [optional] [default to undefined] |
Return type
Array<ListWorkgroupMembersV1200ResponseInner>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const workgroupId: string = 2c91808a7813090a017814121919ecca; // ID of the Governance Group.
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 = 50; // Note that for this API the maximum value for limit is 50. 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 sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
const result = await apiInstance.listWorkgroupMembersV1({ workgroupId: workgroupId });
console.log(result);
list-workgroups-v1
List governance groups This API returns list of Governance Groups
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, in, sw name: eq, sw, in memberships.identityId: eq, in | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, created, modified, id, description | [optional] [default to undefined] |
Return type
Array<Workgroupdto>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(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 sw "Test"; // 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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional)
const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional)
const result = await apiInstance.listWorkgroupsV1({ });
console.log(result);
patch-workgroup-v1
Patch a governance group This API updates an existing governance group by ID. The following fields and objects are patchable:
- name
- description
- owner
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the Governance Group | [default to undefined] |
| jsonpatchoperation | Array<Jsonpatchoperation> | [optional] |
Return type
Workgroupdto
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const id: string = 2c9180837ca6693d017ca8d097500149; // ID of the Governance Group
const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"replace","path":"/description","value":"Governance Group new description."}]; // (optional)
const result = await apiInstance.patchWorkgroupV1({ id: id });
console.log(result);
update-workgroup-members-v1
Add members to governance group This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
Following field of Identity is an optional field in the request.
name
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workgroupId | string | ID of the Governance Group. | [default to undefined] |
| bulkworkgroupmembersrequestInner | Array<BulkworkgroupmembersrequestInner> | List of identities to be added to a Governance Group members list. |
Return type
Array<Workgroupmemberadditem>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { GovernanceGroupsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new GovernanceGroupsApi(configuration);
const workgroupId: string = 2c91808a7813090a017814121919ecca; // ID of the Governance Group.
const bulkworkgroupmembersrequestInner: Array<BulkworkgroupmembersrequestInner> = ; // List of identities to be added to a Governance Group members list.
const result = await apiInstance.updateWorkgroupMembersV1({ workgroupId: workgroupId, bulkworkgroupmembersrequestInner: bulkworkgroupmembersrequestInner });
console.log(result);