HTTP request headers

The following table lists the request headers used in the Docs REST API.

HTTP Header

Value

Required

One of the following:
  • X-Good-GD-AuthToken
  • X-Good-WD-AuthToken
One of the following:
  • GD AuthToken retrieved from the BlackBerry Dynamics library on device
  • WD AuthToken retrieved from the BlackBerry Workspaces library

√

One is required depending on which is used for user validation

Authorization

One of the following:

  • HTTP Basic authentication format

    For example, BASIC <username>:<password> in base64 encoding

  • HTTP Bearer authentication format (bearer token)

√

Required to access enterprise repositories when Kerberos constrained delegation (KCD) is not enabled

Authorization* (Docs Self-Service web console only) One of the following in base64 encoding:
  • Windows authentication using Basic credentials
  • Windows authentication using Negotiate credentials
√

One is required

Content-Type*

application/json

√

Required only when sending a POST request that contains a JSON body

X-GOOD-RMS-ACCESS-TOKEN

ADAL OAuth2 access token

√

Required when:
  • Retrieving the metadata for the Entra - IP protected document
  • Downloading an Entra - IP protected document

* The API for the Docs Self-service web console requires only the Authorization and Content-Type headers.