OAuth2 Authenticate

Released in 20.13. Authenticates the API caller on the Symphony servers (pod) using a Session token, and returns a valid OAuth2 access token.
This authentication is required to use the Audit Trails 2 enpoints.
post
https://yourpodURL.symphony.com/login
/idm/tokens
Returns a valid OAuth2 access token from a given session token to be used for authentication
Parameters
Query
scope
string
Optional field used to get access with specific entitlements, use space separated list to define more that one
Header
sessionToken*
string
User session authentication token
Responses
200: OK
OK.
401: Unauthorized
Client is unauthorized to access this resource
403: Forbidden
Forbidden to access this endpoint .
500: Internal Server Error
Server error, see response body for further details.

📘 Notes

  • Use scope 'at2' in order get access to the Audit Trail 2 endpoints.
  • The payload consists is a JWT token object that is divided in three properties as follow:
    • the token type.
    • the duration of time the access token is granted for (in seconds).
    • the JWT token containing the caller's id or application, an expiration date, and a set of entitlements related to the specified scope, signed by the caller's private RSA key.
Last modified 2mo ago