Get the members of the specified role

get/roles/{roleId}/members
Internal-Use Only

Returns members of the role by ID. Authorization: Requires read access to the role context.

Request Samples

1

Response Samples

1{
2 "links": [
3 {
4 "method": "GET",
5 "rel": "self",
6 "href": "/clinicalRepository/roles/06dd9aaf-cbbd-4093-911a-8d8fa512ca01/members?sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=10",
7 "uri": "/clinicalRepository/roles/06dd9aaf-cbbd-4093-911a-8d8fa512ca01/members?sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=10",
8 "type": "application/vnd.sas.collection",
9 "itemType": "application/vnd.sas.clinical.principal+json"
10 },
11 {
12 "method": "GET",
13 "rel": "collection",
14 "href": "/clinicalRepository/roles/06dd9aaf-cbbd-4093-911a-8d8fa512ca01/members",
15 "uri": "/clinicalRepository/roles/06dd9aaf-cbbd-4093-911a-8d8fa512ca01/members",
16 "type": "application/vnd.sas.collection",
17 "itemType": "application/vnd.sas.clinical.principal+json"
18 }
19 ],
20 "name": "members",
21 "accept": "application/vnd.sas.clinical.principal+json",
22 "start": 0,
23 "count": 2,
24 "items": [
25 {
26 "version": 1,
27 "id": "sastest3",
28 "typeId": "user",
29 "name": "SAS Test User 3",
30 "displayName": "SAS Test User 3 (sastest3)"
31 },
32 {
33 "version": 1,
34 "id": "7f091359-36f4-4c7c-bb47-bd1f59d5af88",
35 "typeId": "group",
36 "name": "group A",
37 "displayName": "group A (Organization)",
38 "contextId": "8b10535a-2515-441f-a69c-00b62c6a45b2",
39 "contextTypeId": "organization"
40 }
41 ],
42 "limit": 10,
43 "version": 2
44}

Path Parameters

NameTypeRequiredDescription
roleId
string
true

The unique identifier for the role.

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

Filter criteria for items. See Filtering in REST APIs.

Examples:
"eq(name,'ACME')"
limit
integer
false

The maximum number of items to return. Defaults to 10. The maximum cannot exceed 500.

Examples:
10
sortBy
string<sort-criteria>
false

Sorts the returned items. See Sorting in REST APIs.

Example:
"name:ascending:primary"
start
integer
false

0-based offset of the first type to return. Defaults to 0.

Examples:
10

Responses

StatusMeaningDescription
200OKOKSchema
404Not FoundThe role could not be found to retrieve members.