Permissions overview

permissionsRequired

X-Okapi-Permissions-Required

These are strictly necessary to call the module

permissionsDesired

X-Okapi-Permissions-Desired

These are not necessary, but if present, the module may do some extra operations (for example, show sensitive data about a patron)

modulePermissions

X-Okapi-Module-Permissions

Permissions granted to a module, which it can make use of, when making further calls to other modules.

X-Okapi-Extra-Permissions

Additional permissions granted by Okapi itself. Used only between Okapi and the authorization module, in some special situations, like when a moduleDescriptor has a "redirect" routing entry and also module-specific permissions.

X-Okapi-Permissions

The permissions a module expressed interest in, and which were granted to this user. Can be used for modifying the way a module behaves.

X-Okapi-Tenant

The name of the tenant

X-Okapi-Token

A JWT token given to a user after authentication

X-Okapi-Url

Tells the URL where the modules may contact Okapi, for making requests to other modules. Can be set on Okapi's command line when starting up.

X-Okapi-Trace

Will be added to the responses from Okapi, to help debugging where the request actually went, and how long did it take.

X-Okapi-User-Id

The user Id of logged-in user.

X-Okapi-Request-Id

Identifies the original request to Okapi. Useful for logging.

X-Okapi-Module-Tokens

JWT tokens specifically made for invoking given modules.Used only between Okapi and the authorization module.