Role List

This API provides a list document of roles on an index.

Method	GET
URL	/v1/index/<index_id>/role_list
Authentication required?	yes
Required Roles	`owner` or `admin` on the index
Response Body	a RoleList document

Authentication & Authorization

Tokens for this call must have this scope:

urn:globus:scopes:search.api.globus.org:all

Example curl

To get the role list on the index 450538fb-cf9c-48fc-bd6f-08abc5e86da9:

curl \
  -XGET \
  -H "Authorization: Bearer $SEARCH_TOKEN" \
  'https://search.api.globus.org/v1/index/450538fb-cf9c-48fc-bd6f-08abc5e86da9/role_list'

where $SEARCH_TOKEN is an access token.

Response Schemas

RoleList

A role list is a container of Role documents. It has the following fields:

Field Name	Type	Description
role_list	Array of Objects	An array of Role documents

Example RoleList

{
  "role_list": [
    {
      "id": "MDAwMzU0",
      "creation_date": "2021-02-22 15:27:55",
      "role_name": "admin",
      "index_id": "e56fdc95-0c55-4533-ba51-c1e8619ece7b",
      "principal": "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
      "principal_type": "identity"
    },
    {
      "id": "MDAwMzQ2",
      "creation_date": "2020-09-05 19:02:18",
      "role_name": "writer",
      "index_id": "e56fdc95-0c55-4533-ba51-c1e8619ece7b",
      "principal": "urn:globus:group:id:0a4dea26-44cd-11e8-847f-0e6e723ad808",
      "principal_type": "group"
    }
  ]
}

Role

A Role document, describes a single permission on an index.

Field Name	Type	Description
id	String	The ID of this role
creation_date	String	A UTC timestamp, indicating when the role was created
role_name	String	One of `{"owner", "admin", "writer"}`
index_id	String	The ID of the index for this role
principal	String	The identity or group with the role, in Principal URN format
principal_type	String	One of `"identity"` or `"group"`