list

Beta notice We are currently gathering feedback on the Access API endpoints, and while in beta the structure of the API and its response may change. Please submit any feedback (including if this API currently works for your needs!) to your primary Redivis contact, or [email protected].

HTTP Request

This method takes two different forms, each serving a different purpose:

The first form is for listing all users who have access to a particular dataset. If a dataset belongs to an organization, an access object for all members of the organization will be returned. If the dataset belongs to a user, an access object will be returned for every user with whom the dataset has been shared, as well as the dataset's owner.

The second form is for listing all datasets that a particular member of an organization has access to. In this case, an access object will be returned for each dataset in the organization.

GET /api/v1/datasets/:datasetReference/access
GET /api/v1/organizations/:organizationName/members/:userName/access

Path parameters

Parameter	Description
organizationName	The username of the organization for which to list access.
userName	The username of the user for which to list access.
datasetReference	A qualified reference to the dataset for which you want to list access. See referencing resources for more information.

Query parameters

Parameter	Description
maxResults	Default 100. Must be less than 1000.
pageToken	For paginating through results, provide the value returned from the previous access.list call.
minAccessLevel	Must be one of none, overview, metadata, sample, data, edit If specified, only access objects whose access level is greater than or equal to minAccessLevel will be returned.

This endpoint extends the general API structure.

Authorization

If you are listing access for a member in an organization, you must be an administrator of the relevant organization. If you are listing access for a particular dataset, you must be an administrator of the organization that hosts the dataset, or, if the dataset is owned by a user, you must be the owner or an editor of the dataset.

Your access token must have one of the following scopes:

• organization.read

Learn more about authorization.

Request body

The request body must be empty.

Response body

Returns a JSON representation of an array of access resources.

{
    "kind": "accessList",
    "nextPageToken": integer,
    "results": [
        object(access.list)
    ]
}