{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Group Details
Request the details of a groups from the Users and Groups application.
GET /api/usersandgroups/groups/<GroupID>
POST /api/usersandgroups/groups/<GroupID>
Request details of a group using the following data:
| Request Field | Value Type | Description |
|---|---|---|
| fields | list<string> | An optional list of strings to request additional fields from the given group |
Note: If an empty list of fields is given, a list of available fields for the given group is provided in the response. The list of available fields varies depending on the available plugins installed in the i-net CoWork server.
| Response Field | Value Type | Description |
|---|---|---|
| displayName | string | The display name of the group |
| type | string | The groups type |
| fields | map<string,object> | An optional map of group fields and their value, if requested using the fields request key. |
| availableFields | list<string> | An optional list of group fields, if an empty list is send for the request field fields. |
Example Request
# Request POST /api/usersandgroups/groups/bpb7446l6cns3tzyg9995w2zf HTTP/1.1 Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u Content-Type: application/json { "fields":[] } # Response HTTP/1.1 200 OK Content-Type: application/json [ { "displayName": "Designer" "type": "resource", "availableFields": [ ... ] } ]
Application Example
# Browser access http://127.0.0.1:9000/api/usersandgroups/groups/bpb7446l6cns3tzyg9995w2zf # Shell access using curl curl -Ls "http://127.0.0.1:9000/api/usersandgroups/groups/bpb7446l6cns3tzyg9995w2zf" \ --header 'Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u' \ --header "Content-Type: application/json" \ --request POST \ --data '{"fields":[]}' # Shell access using curl with username and password curl -Lsu username:password "http://127.0.0.1:9000/api/usersandgroups/groups/bpb7446l6cns3tzyg9995w2zf" \ --header "Content-Type: application/json" \ --request POST \ --data '{"fields":[]}'
© Copyright 1996 - 2024, i-net software GmbH; All rights Reserved. Imprint
