API Usage & Basics
The Full API Reference covers all API methods.
It details the request methods, authentication and authorization requirements, and response formats for every supported operation.
All of that documentation has these components as its basis:
1. Communicating with Globus Search
Globus Search is a web API which communicates over the HTTP protocol using a RESTful data model.
The Search API is reached at
URLs and URIs in this documentation will usually omit this piece, so the text
should be interpreted as referring to an HTTP GET request against
1.1.1. Globus Preview URL
In the Globus Preview environment, the Search API can be found at
2. Authentication & Authorization
Some features of Search don’t have any authorization or authentication requirements. These can be accessed over HTTPS with no credentials.
API methods are which are documented as requiring authentication must be authenticated with a Globus Auth token. They will document the scopes which they need.
2.1. Authorization Header
Globus Search authorizes access with Globus Auth. It therefore requires that
any authenticated calls be made with a bearer
Authorization: Bearer <token_string>
The token string is an Access Token provided via Globus Auth.
Access tokens for Globus Search have one or more of the following scopes:
|Name||Full Scope String||Definition|
The token authorizes the call to write data into Globus Search and to perform task management operations.
The token authorizes the call to query data from Globus Search.
Access all capabilities of the Globus Search service.
2.3. Permissions in Search
Globus Search evaluates and enforces permissions after successful authentication. In particular, a user may be
adminof an index
writerof an index
A member of the
visible_tolist of a document
These permissions are all evaluated against the linked identities and Globus Group memberships of a user.