Get the members of the specified context
Returns the members of the specified context, which includes assigned users and groups as well as groups explicitly created at the context.
1{2 "links": [3 {4 "method": "GET",5 "rel": "self",6 "href": "/clinicalRepository/memberships/8b10535a-2515-441f-a69c-00b62c6a45b2/members?filter=not(startsWith(typeId,%20'sas'))&sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=100",7 "uri": "/clinicalRepository/memberships/8b10535a-2515-441f-a69c-00b62c6a45b2/members?filter=not(startsWith(typeId,%20'sas'))&sortBy=name:ascending:primary,name:descending:secondary&start=0&limit=100",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/memberships/8b10535a-2515-441f-a69c-00b62c6a45b2/members",15 "uri": "/clinicalRepository/memberships/8b10535a-2515-441f-a69c-00b62c6a45b2/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": 4,24 "items": [25 {26 "version": 1,27 "id": "7f091359-36f4-4c7c-bb47-bd1f59d5af88",28 "typeId": "group",29 "name": "group A",30 "displayName": "group A (Organization)",31 "contextId": "8b10535a-2515-441f-a69c-00b62c6a45b2",32 "contextTypeId": "organization"33 },34 {35 "version": 1,36 "id": "48a278d6-5984-45b9-9ff3-5e8cd631d772",37 "typeId": "group",38 "name": "group B",39 "displayName": "group B (Organization)",40 "contextId": "8b10535a-2515-441f-a69c-00b62c6a45b2",41 "contextTypeId": "organization"42 },43 {44 "version": 1,45 "id": "sastest1",46 "typeId": "user",47 "name": "SAS Test User 1",48 "displayName": "SAS Test User 1 (sastest1)"49 },50 {51 "version": 1,52 "id": "sastest2",53 "typeId": "user",54 "name": "SAS Test User 2",55 "displayName": "SAS Test User 2 (sastest2)"56 }57 ],58 "limit": 100,59 "version": 260}
Name | Type | Required | Description |
---|---|---|---|
membershipId | string | true | The unique identifier for the context for which to retrieve the members. |
Name | Type | Required | Description |
---|---|---|---|
assignedOnly | boolean | false | Optionally, specify whether to get only assigned user and group members. By default, all members are returned. This includes both assigned users and groups as well as groups created at the context. If true is specified, only assigned users and group members are returned. If false is specified, only groups created at the specified context are returned. |
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 |
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | The request succeeded and the specified context members are returned. | Schema |