list

HTTP Request
GET /api/v1/organizations/:organizationName/members
Path parameters
Parameter
Type
Description
:organizationName
string
The name of the organization
Query parameters
Parameter
Type
Description
maxResults
 integer
Maximum number of results to return. Defaults to 100, may not exceed 1000.
pageToken
string
Page token, returned by a previous call, to request the next page of results. If not provided, the first page will be returned
status
string
Optional. A comma separated list of statuses; if provided, will only return members of this status. Allowed values are pending, approved, rejected, revoked, left.
hasDataAccessToAll
string
DEPRECATED
​
A comma separated list of dataset references; see referencing resources for more info).

 Only members who have data access to all of the referenced datasets will be returned.
hasDataAccessToAny
string
DEPRECATED
​
A comma separated list of dataset references; see referencing resources for more info).
​
Only members who have data access to at least one of  the referenced datasets will be returned.
DEPRECATED
If both hasDataAccessToAll and hasDataAccessToAny are provided, members will be returned who fulfill both query parameters (logical AND). That is, they must have access to all datasets listed in hasDataAccessToAll and at least one dataset listed in hasDataAccessToAny
This endpoint extends the general API structure.
Authorization
You must be an administrator of the requested organization, and your access token must have the following scope:
organization.read
​Learn more about authorization.​
Request body
The request body must be empty.
Response body
Returns a JSON representation of an array of member resources.
{
    "kind": "memberList",
    "nextPageToken": integer,
    "results": [
        object(member.list)
    ]
}
Examples
curl
curl -H "Authorization: Bearer $REDIVIS_ACCESS_TOKEN" \
"https://redivis.com/api/v1/organizations/my_organization/members?hasDataAccessToAll=test_dataset:1,other_dataset:2"
​

Parameter	Type	Description
:organizationName	string	The name of the organization

Parameter	Type	Description
maxResults	integer	Maximum number of results to return. Defaults to 100, may not exceed 1000.
pageToken	string	Page token, returned by a previous call, to request the next page of results. If not provided, the first page will be returned
status	string	Optional. A comma separated list of statuses; if provided, will only return members of this status. Allowed values are `pending`, `approved`, `rejected`, `revoked`, `left`.
hasDataAccessToAll	string	DEPRECATED A comma separated list of dataset references; see referencing resources for more info). Only members who have data access to all of the referenced datasets will be returned.
hasDataAccessToAny	string	DEPRECATED A comma separated list of dataset references; see referencing resources for more info). Only members who have data access to at least one of the referenced datasets will be returned.

Last modified 27d ago