GET

Get group administrators

Lists the group-level admins for the specified group

Request

Path parameters

groupId

string

Required

Query parameters

start

integer

limit

integer

Responses

the search was performed successfully. Returns a paginated list of group-level-administrators

application/json

any

GET/rest/admin/1.0/group-level-admin/{groupId}/admins
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/group-level-admin/{groupId}/admins' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 { "values": [ { "entity": { "id": "1-Z3JvdXAx", "type": "GROUP" }, "name": "group1", "displayName": null, "directory": { "id": 1, "displayName": "Directory One", "directoryType": "INTERNAL" }, "email": null, "active": null }, { "entity": { "id": "2-dXNlcjE", "type": "USER" }, "name": "user1", "displayName": "User One", "directory": { "id": 1, "displayName": "Directory One", "directoryType": "INTERNAL" }, "email": "user@company.com", "active": true } ], "size": 2, "start": 2, "limit": 2, "isLastPage": false }
POST

Add group administrators

Grants the rights to administer the specified group to the specified directory entities

Request

Path parameters

groupId

string

Required

Request bodyapplication/json

the identifiers and types of entities that should become admins of the specified group

array<DirectoryEntityRestDTO>

id

string

type

string

Responses

the search was performed successfully

application/json

any

POST/rest/admin/1.0/group-level-admin/{groupId}/admins
1 2 3 4 5 6 7 8 9 10 11 12 13 14 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/group-level-admin/{groupId}/admins' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '[ { "id": "1-dXNlcjE", "type": "USER" }, { "id": "2-Z3JvdXAx", "type": "GROUP" } ]'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "successes": [ "1-dXNlcjE" ], "failures": [ { "entity": "1-dXNlcjE", "reason": "The entity does not exist" } ] }
DEL

Revoke group to group administrator

Revokes the rights to administer the given group from the specified group

Request

Path parameters

groupId

string

Required
adminId

string

Required

Responses

the rights were revoked successfully

DEL/rest/admin/1.0/group-level-admin/{groupId}/admins/groups/{adminId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/admin/1.0/group-level-admin/{groupId}/admins/groups/{adminId}'
GET

Get administrator candidates

Returns users and groups that can become admins of the given group

Request

Path parameters

groupId

string

Required

Query parameters

search

string

limit

integer

Responses

the rights were revoked successfully

application/json

any

GET/rest/admin/1.0/group-level-admin/{groupId}/admins/suggestions
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/group-level-admin/{groupId}/admins/suggestions' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 { "values": [ { "entity": { "id": "0-UG93ZXIgdXNlcnM", "type": "GROUP" }, "name": "Power users", "displayName": null, "directory": { "id": 0, "displayName": "Open LDAP", "directoryType": "INTERNAL" }, "email": null, "active": true }, { "entity": { "id": "1-VGVzdGVycw", "type": "GROUP" }, "name": "Testers", "displayName": null, "directory": { "id": 1, "displayName": "Active Directory", "directoryType": "INTERNAL" }, "email": null, "active": true }, { "entity": { "id": null, "type": "USER" }, "name": "ariel", "displayName": null, "directory": { "id": 0, "displayName": "Open LDAP", "directoryType": "INTERNAL" }, "email": "ariel@some.domain.com", "active": true }, { "entity": { "id": null, "type": "USER" }, "name": "carie", "displayName": null, "directory": { "id": 0, "displayName": "Open LDAP", "directoryType": "INTERNAL" }, "email": "carie@some.domain.com", "active": true } ], "size": 4, "start": 0, "limit": 10, "isLastPage": true }
DEL

Revoke user to group administrator

Revokes the rights to administer the given group from the specified user

Request

Path parameters

groupId

string

Required
adminId

string

Required

Responses

the rights were revoked successfully

DEL/rest/admin/1.0/group-level-admin/{groupId}/admins/users/{adminId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/admin/1.0/group-level-admin/{groupId}/admins/users/{adminId}'

Rate this page: