Skip to Content
PublishersRequest

Request

A Publishers entitlement API should accept a POST request. The request body is a JSON object that has two properties "dois" and an optional "org":

{
  "org": {
    "ipv4": "1.2.3.4"
  },
  "dois": ["10.10/1234"]
}
  • "org" is an optional object that contains one or more identifiers for a user. This information should be used to determine if the user has access to the "dois" defined in the request.
  • "dois" is an array of DOIs to check for entitlements.

Headers

The request will also include the following HTTP headers:

HeaderDescription
"user-agent"The user agent of the client making the request. This will always be "GetFT Entitlement API"
"x-integrator-id"The ID of the integrator GetFTR is making this request on behalf of.
"x-request-id"A unique identifier for this request.
"authorization"The JWT token (Bearer)

Org Identifiers

Describes a single Organisation and contains all the IDs available to identify it, with a minimum of at least one. Integrators are encouraged to share all known IDs.

PropertyDescription
"ipv4"IPv4 address of the end user
"ipv6"IPv6 address of the end user
"entityID"The entityID of the Organisation’s IdP.
"openAthensOrgID"OpenAthens parameter. entityID must be present.
"eduPersonScopedAffiliation"Shibboleth parameter. entityID must be present.
"ringgoldID"Not currently used. Reserved for future proofing.
"gridID"Not currently used. Reserved for future proofing.
"rorID"Not currently used. Reserved for future proofing.
Last updated on
AuthenticationResponse