Get the members of the specified role

get/roles/{roleId}/members

Returns members of the role by ID.

Authorization: Requires read access to the role context.

Request Samples

1

Response Samples

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

Path Parameters

NameTypeRequiredDescription
roleId
string
true

The unique identifier for the role.

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

Filter criteria for items. The following fields are not supported in filter criteria: typeId. See Filtering in REST APIs.

limit
integer
false

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

sortBy
string<sort-criteria>
false

Sorts the returned items. The following fields are not supported for sort: typeId. See Sorting in REST APIs.

start
integer
false

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

Responses

StatusMeaningDescription
200OK

OK

Schema
404Not Found

The role could not be found to retrieve members.