All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| groupBuilderCancelImportGroup | DELETE /api/v3/groups_import | Summary: Cancel import group Description: Cancel import refresh for selected groups. |
| groupBuilderCreateGroup | POST /api/v3/groups | Summary: Create group Description: Create new groups. |
| groupBuilderDeleteGroup | DELETE /api/v3/groups | Summary: Delete group Description: Delete specified groups if the group ID is not used for reports. |
| groupBuilderEditGroup | PATCH /api/v3/groups/{group_id} | Summary: Edit group Description: Add or delete group members. |
| groupBuilderExportGroup | POST /api/v3/groups_export | Summary: Export group Description: Export group content to a file based on a group ID. |
| groupBuilderGetGroupDetails | GET /api/v3/groups/{group_id} | Summary: Get group details Description: Get details of group specified by group ID. |
| groupBuilderGetGroupMembers | POST /api/v3/groups/search | Summary: Get group members Description: Get members of all the group ids provided in the request. To be consumed by policy builder ms. |
| groupBuilderGetGroupSyncMapping | GET /api/v3/groups/mappings/sync | Summary: Get GDP to gi group mapping Description: Get GDSC to GDP group sync mapping. |
| groupBuilderGetGroupTypeMapping | GET /api/v3/groups-mappings | Summary: Get group type mapping Description: Get GDSC to GDP group types mapping. |
| groupBuilderGetGroupTypes | GET /api/v3/group_types | Summary: Get group types Description: Get a list of available group types. |
| groupBuilderGetGroups | GET /api/v3/groups | Summary: Get groups Description: Get a list of imported group members. |
| groupBuilderGetImportGroups | GET /api/v3/groups_import | Summary: Get import groups Description: Get unsynchronized groups from a central manager. |
| groupBuilderImportGroup | POST /api/v3/groups_import | Summary: Import group Description: Import selected groups from a central manager. (This API is called from GDP only) |
| groupBuilderRefreshGroups | POST /api/v3/groups/refresh | Summary: Refresh groups Description: Refresh tenants selected imported groups. |
| groupBuilderResetGroups | POST /api/v3/groups/reset | Summary: Reset groups Description: Resets tenants selected predefined groups. |
| groupBuilderStoreGroupMembersGdp | POST /api/v3/central_managers/{central_manager_id}/groups/members | Summary: Store group members Gdp Description: Store GDP groups. (This API is called from GDP only) |
| groupBuilderStoreGroupsGdp | POST /api/v3/central_managers/{central_manager_id}/groups | Summary: Store groups Gdp Description: Store GDP groups. (This API is called from GDP only) |
Groupbuilderv3CancelGroupImportResponse groupBuilderCancelImportGroup()
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderCancelImportGroupRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderCancelImportGroupRequest = {
// Group IDs to delete. (optional)
groupIds: [
1,
],
};
const data = await apiInstance.groupBuilderCancelImportGroup(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupIds | Array<number> | Group IDs to delete. | (optional) defaults to undefined |
Groupbuilderv3CancelGroupImportResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3CreateGroupResponse groupBuilderCreateGroup(groupbuilderv3CreateGroupRequest)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderCreateGroupRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderCreateGroupRequest = {
groupbuilderv3CreateGroupRequest: {
copyGroupId: 1,
description: "description_example",
groupTypeId: 1,
name: "name_example",
nested: true,
},
};
const data = await apiInstance.groupBuilderCreateGroup(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3CreateGroupRequest | Groupbuilderv3CreateGroupRequest |
Groupbuilderv3CreateGroupResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3DeleteGroupResponse groupBuilderDeleteGroup()
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderDeleteGroupRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderDeleteGroupRequest = {
// Group IDs to delete. (optional)
groupIds: [
1,
],
};
const data = await apiInstance.groupBuilderDeleteGroup(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupIds | Array<number> | Group IDs to delete. | (optional) defaults to undefined |
Groupbuilderv3DeleteGroupResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3EditGroupResponse groupBuilderEditGroup(groupbuilderv3EditGroupRequest)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderEditGroupRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderEditGroupRequest = {
// Group ID.
groupId: 1,
groupbuilderv3EditGroupRequest: {
clearGroup: true,
deletedMembers: [
"deletedMembers_example",
],
description: "description_example",
groupId: 1,
ldapConfig: {
attributes: [
"attributes_example",
],
bindGroupId: 1,
bindPassword: "bindPassword_example",
clearGroup: true,
filter: "filter_example",
filterScope: 1,
importLimit: 1,
ldapGroupName: "ldapGroupName_example",
ldapId: "ldapId_example",
memberPrefix: "memberPrefix_example",
},
name: "name_example",
newMembers: [
"newMembers_example",
],
updatedMembers: [
{
memberId: "memberId_example",
name: "name_example",
},
],
},
};
const data = await apiInstance.groupBuilderEditGroup(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3EditGroupRequest | Groupbuilderv3EditGroupRequest | ||
| groupId | [number] | Group ID. | defaults to undefined |
Groupbuilderv3EditGroupResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetExportGroupResponse groupBuilderExportGroup(groupbuilderv3GetExportGroupRequest)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderExportGroupRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderExportGroupRequest = {
groupbuilderv3GetExportGroupRequest: {
exportHierarchy: true,
groupId: 1,
},
};
const data = await apiInstance.groupBuilderExportGroup(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3GetExportGroupRequest | Groupbuilderv3GetExportGroupRequest |
Groupbuilderv3GetExportGroupResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetGroupDetailResponse groupBuilderGetGroupDetails()
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderGetGroupDetailsRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderGetGroupDetailsRequest = {
// Group ID.
groupId: 1,
// Filter by group member name. (optional)
filter: "filter_example",
// Order by ascending (ASC) or descending (DESC). (optional)
order: "order_example",
};
const data = await apiInstance.groupBuilderGetGroupDetails(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | [number] | Group ID. | defaults to undefined |
| filter | [string] | Filter by group member name. | (optional) defaults to undefined |
| order | [string] | Order by ascending (ASC) or descending (DESC). | (optional) defaults to undefined |
Groupbuilderv3GetGroupDetailResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetGroupMembersResponse groupBuilderGetGroupMembers(groupbuilderv3GetGroupMembersRequest)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderGetGroupMembersRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderGetGroupMembersRequest = {
groupbuilderv3GetGroupMembersRequest: {
groupId: [
1,
],
},
};
const data = await apiInstance.groupBuilderGetGroupMembers(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3GetGroupMembersRequest | Groupbuilderv3GetGroupMembersRequest |
Groupbuilderv3GetGroupMembersResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetGroupSyncMappingResponse groupBuilderGetGroupSyncMapping()
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderGetGroupSyncMappingRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderGetGroupSyncMappingRequest = {
// Central manager. (optional)
centralManagerId: "central_manager_id_example",
};
const data = await apiInstance.groupBuilderGetGroupSyncMapping(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| centralManagerId | [string] | Central manager. | (optional) defaults to undefined |
Groupbuilderv3GetGroupSyncMappingResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetGroupTypeMappingResponse groupBuilderGetGroupTypeMapping()
import { createConfiguration, GroupBuilderApi } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request = {};
const data = await apiInstance.groupBuilderGetGroupTypeMapping(request);
console.log('API called successfully. Returned data:', data);
This endpoint does not need any parameter.
Groupbuilderv3GetGroupTypeMappingResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetGroupTypesResponse groupBuilderGetGroupTypes()
import { createConfiguration, GroupBuilderApi } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request = {};
const data = await apiInstance.groupBuilderGetGroupTypes(request);
console.log('API called successfully. Returned data:', data);
This endpoint does not need any parameter.
Groupbuilderv3GetGroupTypesResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetGroupsResponse groupBuilderGetGroups()
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderGetGroupsRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderGetGroupsRequest = {
// Return group names, ID\'s, type ID\'s, nested bool, and tuple count only if the flag is true. (optional)
doNotIncludeMemberCount: true,
// Only return groups that user has full-access to. (optional)
onlyFullAccess: true,
// Only return non-nested groups. (optional)
nonNested: true,
};
const data = await apiInstance.groupBuilderGetGroups(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| doNotIncludeMemberCount | [boolean] | Return group names, ID's, type ID's, nested bool, and tuple count only if the flag is true. | (optional) defaults to undefined |
| onlyFullAccess | [boolean] | Only return groups that user has full-access to. | (optional) defaults to undefined |
| nonNested | [boolean] | Only return non-nested groups. | (optional) defaults to undefined |
Groupbuilderv3GetGroupsResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetImportGroupsResponse groupBuilderGetImportGroups()
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderGetImportGroupsRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderGetImportGroupsRequest = {
// Central manager host name. (optional)
centralManagerId: "central_manager_id_example",
};
const data = await apiInstance.groupBuilderGetImportGroups(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| centralManagerId | [string] | Central manager host name. | (optional) defaults to undefined |
Groupbuilderv3GetImportGroupsResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3ImportGroupResponse groupBuilderImportGroup(groupbuilderv3ImportGroupRequest)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderImportGroupRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderImportGroupRequest = {
groupbuilderv3ImportGroupRequest: {
centralManagerId: "centralManagerId_example",
groups: [
{
accessLevel: 1,
description: "description_example",
flattenedMemberCount: 1,
groupId: 1,
groupTypeId: 1,
lastSyncDate: new Date('1970-01-01T00:00:00.00Z'),
ldapConfig: {
attributes: [
"attributes_example",
],
bindGroupId: 1,
bindPassword: "bindPassword_example",
clearGroup: true,
filter: "filter_example",
filterScope: 1,
importLimit: 1,
ldapGroupName: "ldapGroupName_example",
ldapId: "ldapId_example",
memberPrefix: "memberPrefix_example",
},
memberCount: 1,
members: [
{
memberId: "memberId_example",
name: "name_example",
},
],
name: "name_example",
nested: true,
nestedGroupMembers: [
{
groupId: 1,
name: "name_example",
nestedMemberId: 1,
},
],
nextSyncDate: new Date('1970-01-01T00:00:00.00Z'),
syncInactiveCode: 1,
syncSource: "syncSource_example",
synced: true,
tupleCount: 1,
tupleParams: [
"tupleParams_example",
],
},
],
ldapConfig: {
attributes: [
"attributes_example",
],
bindGroupId: 1,
bindPassword: "bindPassword_example",
clearGroup: true,
filter: "filter_example",
filterScope: 1,
importLimit: 1,
ldapGroupName: "ldapGroupName_example",
ldapId: "ldapId_example",
memberPrefix: "memberPrefix_example",
},
oneTime: true,
preview: true,
},
};
const data = await apiInstance.groupBuilderImportGroup(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3ImportGroupRequest | Groupbuilderv3ImportGroupRequest |
Groupbuilderv3ImportGroupResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3RefreshGroupsResponse groupBuilderRefreshGroups(groupbuilderv3RefreshGroupsRequest)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderRefreshGroupsRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderRefreshGroupsRequest = {
groupbuilderv3RefreshGroupsRequest: {
groupIds: [
1,
],
},
};
const data = await apiInstance.groupBuilderRefreshGroups(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3RefreshGroupsRequest | Groupbuilderv3RefreshGroupsRequest |
Groupbuilderv3RefreshGroupsResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3ResetGroupsResponse groupBuilderResetGroups(groupbuilderv3ResetGroupsRequest)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderResetGroupsRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderResetGroupsRequest = {
groupbuilderv3ResetGroupsRequest: {
groupIds: [
1,
],
},
};
const data = await apiInstance.groupBuilderResetGroups(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3ResetGroupsRequest | Groupbuilderv3ResetGroupsRequest |
Groupbuilderv3ResetGroupsResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3StoreGroupMembersGdpResponse groupBuilderStoreGroupMembersGdp(groupbuilderv3StoreGroupMembersGdpRequest)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderStoreGroupMembersGdpRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderStoreGroupMembersGdpRequest = {
// ID of central manager.
centralManagerId: "central_manager_id_example",
groupbuilderv3StoreGroupMembersGdpRequest: {
centralManagerId: "centralManagerId_example",
data: "data_example",
},
};
const data = await apiInstance.groupBuilderStoreGroupMembersGdp(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3StoreGroupMembersGdpRequest | Groupbuilderv3StoreGroupMembersGdpRequest | ||
| centralManagerId | [string] | ID of central manager. | defaults to undefined |
Groupbuilderv3StoreGroupMembersGdpResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Groupbuilderv3GetGroupsResponseGdp groupBuilderStoreGroupsGdp(groupbuilderv3GetGroupsRequestGdp)
import { createConfiguration, GroupBuilderApi } from '';
import type { GroupBuilderApiGroupBuilderStoreGroupsGdpRequest } from '';
const configuration = createConfiguration();
const apiInstance = new GroupBuilderApi(configuration);
const request: GroupBuilderApiGroupBuilderStoreGroupsGdpRequest = {
// ID of central manager.
centralManagerId: "central_manager_id_example",
groupbuilderv3GetGroupsRequestGdp: {
centralManagerId: "centralManagerId_example",
data: [
{
application: "application_example",
description: "description_example",
hierarchical: true,
id: 1,
memberCount: 1,
members: "members_example",
tupleCount: 1,
tuples: "tuples_example",
type: "type_example",
typeId: 1,
},
],
},
};
const data = await apiInstance.groupBuilderStoreGroupsGdp(request);
console.log('API called successfully. Returned data:', data);
| Name | Type | Description | Notes |
|---|---|---|---|
| groupbuilderv3GetGroupsRequestGdp | Groupbuilderv3GetGroupsRequestGdp | ||
| centralManagerId | [string] | ID of central manager. | defaults to undefined |
Groupbuilderv3GetGroupsResponseGdp
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]