Role Delete

This API allows deletion of roles on an index.

Method	DELETE
URL	/v1/index/<index_id>/role/<role_id>
Authentication required?	yes
Required Roles	`owner` or `admin` on the index
Response Body	a RoleDeleted document

Authentication & Authorization

Tokens for this call must have this scope:

urn:globus:auth:scope:search.api.globus.org:all

Example curl

To delete the role MDAwMzU0 the index 450538fb-cf9c-48fc-bd6f-08abc5e86da9:

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

where $SEARCH_TOKEN is an access token.

Response Schemas

RoleDeleted

A role deleted document is a container with a Role document. It has the following fields:

Field Name	Type	Description
success	Boolean	Always `true`
deleted	Object	A Role document containing the role that was just removed

Example RoleDeleted

{
  "success": true,
  "deleted": {
    "id": "MDAwMzU0",
    "creation_date": "2020-09-05 19:02:18",
    "index_id": "e56fdc95-0c55-4533-ba51-c1e8619ece7b",
    "principal": "urn:globus:auth:identity:ae341a98-d274-11e5-b888-dbae3a8ba545",
    "principal_type": "identity",
    "role_name": "writer"
  }
}

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"`