Skip to main content

Generate Keycloak token/access token

POST/api/hiecm/gateway/v3/sessions

When invoked, it facilitates the authentication process by providing a secure token that can be used to access various services and resources within the system. This functionality is essential for ensuring secure and authorised access, enabling users to interact with protected endpoints and perform operations that require authentication. By using this API, users can obtain the necessary tokens to maintain secure sessions and access the system’s features effectively.

Headers

REQUEST-IDstringRequired

Unique UUID for track the end to end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds

X-CM-IDstringRequired

Suffix of the consent manager to which the request was intended

Body

clientIdstringRequired

Mandatory when the clientId.

clientSecretstringRequired

Mandatory when the clientSecret.

grantTypestringRequired

The method used by the client to obtain an access token, e.g. client_credentials.

Responses

202

Accepted

The callback never arrives

204

No Content

400

Bad Request

401

Unauthorized. The request carried no valid credentials, or the access token has expired. Obtain a fresh token from the session API and retry.

Everything returns 401

403

Forbidden. The caller is authenticated but is not permitted to perform this operation on this resource.

500

Internal Server Error

503

Service Unavailable