This API method can be used to handle Group administration within a space.
TABLE OF CONTENTS
- Get groups information: GET /api/v1.1/domains/{domainId}/groups
- Create new groups to a domain: POST /api/v1.1/domains/{domainId}/groups
- Update groups in a domain: POST /api/v1.1/domains/{domainId}/groups
- Delete groups in a domain: DELETE /api/v1.1/domains/{domainId}/groups
Get groups information: GET /api/v1.1/domains/{domainId}/groups
VERB | Header | Resource/Id/Selector | Description | Parameters | Return data |
GET | Ticket | /api/v1.1/domains/{domainId}/groups | Get all groups for a domain | (Skip (int)) (Take (int)) | TotalCount (int)
Data (array): id (int) securityId (string) key (string) name (string) parentId (int) origin (string) originkey (string) |
Create new groups to a domain: POST /api/v1.1/domains/{domainId}/groups
VERB | Header | Resource/Id/Selector | Description | Parameters | Return data |
POST | Ticket | /api/v1.1/domains/{domainId}/groups | Creates groups to a domain.
Origin and originkey values are optional
Post is done using Content-type application/json | JSON Object { groups [ { key (string), name (string), origin (string), originkey (string), parentid (int) } ] } | JSON Object:
{ added (int), updated (int), errors (int), groups [ { id (int) key (string), status (string) } ] } |
Example HTTP request
POST /api/v1.1/domains/{domainId}/groups Content-Type: application/json Ticket: {Ticket} Body: { "groups": [ { "key": "G_1234", "name": "My Group", "origin": "11111111-1111-1111-1111-111111111111", "originkey": "Group_1234", "parentid": 1115991 } ] }
Update groups in a domain: POST /api/v1.1/domains/{domainId}/groups
VERB | Header | Resource/Id/Selector | Description | Parameters | Return data |
POST | Ticket | /api/v1.1/domains/{domainId}/groups | Update groups in a domain.
Identifying value is id.
Name and parentid can be updated.
Post is done using Content-type application/json | JSON Object { groups [ { id (int), name (string), parentid (int) } ] } | JSON Object:
{ added (int), updated (int), errors (int), groups [ { id (int) key (string), status (string) } ] } |
Example HTTP request
POST /api/v1.1/domains/{domainId}/groups Content-Type: application/json Ticket: {Ticket} Body: { "groups": [ { "id": "12345678", "name": "My Group", "parentid": 12345670 } ] }
Delete groups in a domain: DELETE /api/v1.1/domains/{domainId}/groups
VERB | Header | Resource/Id/Selector | Description | Parameters | Return data |
DELETE | Ticket | /api/v1.1/domains/{domainId}/groups | Delete groups in a domain.
Identifying value is id.
Post is done using Content-type application/json | JSON Object { groups [ { id (int) } ] } | JSON Object:
{ deleted (int), errors (int), groups [ { id (int) name (string), status (string) } ] } |
Example HTTP request
DELETE /api/v1.1/domains/{domainId}/groups Content-Type: application/json Ticket: {Ticket} Body: { "groups": [ { "id": "12345678" } ] }