GuidesAPI Reference
API Reference
  1. Access Token using mTLS authentication
  2. API for Access Token using mTLS authentication

Request an access token that identifies your identity using mTLS authentication

post
https://mtls.account.api.here.com/mtls/token

Request an access token that identifies your identity.

Grant Types:

mTLS Grant Type [mtls]

  • Request a HERE access token that identifies your identity by providing a X.509 TLS signed certificate from
    a trusted Certificate Authority during the standard TLS handshake.
    • Use grant type - mtls
    • An optional scope can be added to the request body to request a project scoped access token
    • The provided X.509 mTLS certificate MUST be issued by a Certificate Authority registered and enabled
      as a trusted mTLS Identity Provider
    • The provided X.509 mTLS signed certificate identifies the access context in the third party's identity namespace
      according to the subject mapping rules defined for the configured authenticator of the identity provider.
    • The identity MUST already exist in the realm of the registered mTLS Identity Provider in order for
      authentication to be successful.
Body Params
string
enum
required

Always "mtls" for this operation. NOTE - "client_credentials" is supported as an alias for "mtls" for backwards compatibility.

Allowed:
integer

Number of seconds before token expires, must number zero or more. Ignored if greater than default expiration of the application.

string
enum

Supported token formats are hN, jwt, jwt+header and jws.

  • 'hN' produces a HERE proprietary-formatted access token.
  • 'jwt' produces a Nested JWT-formatted access token with a JWE enclosed in a JWS.
  • 'jwt+header' produces a Nested JWT-formatted access token with a JWE enclosed in a JWS with additional claims copied into the JOSE header.
  • 'jws' produces a JWS-formatted access token with a JWS Payload containing the plaintext JWT Claims Set.
Allowed:
string

Requested scope of the access token. Must be an HRN identifying a project that the identified user has access to.

Headers
string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response.

string

The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 3 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/x-www-form-urlencoded
*/*

Updated 3 days ago

Did this page help you?