OAuth2 Authenticate

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 Groups - Distribution Lists management endpoints.

Released in 20.13.

Returns a valid OAuth2 access token from a given session token to be used for authentication

post

/idm/tokens

Query parameters

scopestring

Optional field used to get access with specific entitlements, use space separated list to define more that one

Header parameters

sessionTokenstringrequired

User session authentication token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//yourpodURL.symphony.com/login/idm/tokens' \
  --header 'sessionToken: text'

200

401

403

500

200

{
  "token_type": "text",
  "expires_in": 1,
  "access_token": "text"
}

OK.

📘 Notes

• 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.