Skip to main content
Digital Identity Management APIs consume and produce a variety of standard and Digital Identity Management-specific headers.

​
Standard REST Headers

Authorization The Authorization header is required for all Digital Identity Management API requests. A valid JSON Web Token (JWT) access token of the Bearer type must be included in the Authorization header.
If the token is invalid or expired, a 401 Unauthorized error is typically returned. For information about how to get an access token, see: Content-Type Specifies both the media type (of the content of the request body) that the client sends to Digital Identity Management, as well as the media type (of the content of the response body) that Digital Identity Management returns to the client. Requests sent to Digital Identity Management must be in a proper JSON format, and thus the header must use application/json.
This header is required. The request returns an error if no Content-Type is supplied. Accept Specifies the media type(s) that the client is capable of accepting in the body of a response. Clients must support accepting the application/json media type, as it is the only format in which Digital Identity Management exchanges data.
This header is not mandatory for clients to provide (Digital Identity Management will assume application/json without it), but clients are encouraged to include it. Note: The list of all standard REST headers is available here: https://tools.ietf.org/html/rfc7231#section-5

​
Digital Identity Management-Specific Headers

X-B3-TraceId Returned by Digital Identity Management on every request. The header value contains a uniquely generated string to identify the request for logging and tracing purposes.
Clients may optionally provide this header with their own requests, set to a value of their own choosing (or generation). Digital Identity Management will use this client-supplied value instead of generating one. This may be desirable in machine-to-machine integrations with Digital Identity Management, where tracing requests (and subsequent responses) across multiple different services requires consistent trace IDs across all components. See Request Tracing for more details. X-Tenant-ID Returned by Digital Identity Management on every request. This header identifies the Digital Identity Management tenant this API is serving. Clients typically do not need to concern themselves with this header.
X-Correlation-Process-ID Returned by Digital Identity Management on every request involving a Digital Identity Management Process. This header provides unique identifier for the current instance of the Process. The value matches the processId returned in the response body.
X-Total-Count This header identifies the total count of available results for a request when the response returns multiple results. The header is used to support Pagination parameters.
The following headers are sent in a REST response to be stored by the client. JSESSIONID Assigned when a user authenticates into Digital Identity Management and the system opens a user session on the server. Used by all non-anonymous endpoints. JRUNTIMEID Runtime cookie for tracking the runtime device from which a user is accessing a service (by signing in to Digital Identity Management). mint-sso-token (Remember Me cookie) Assigned to a user when they log in to Digital Identity Management. Acts like a remember me cookie for auto-login.