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

Query parameters

scopestringOptional

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

200

OK.

application/json

token_typestringOptional

Type of token, string "Bearer"

expires_ininteger · int64Optional

Duration of time the access token is granted for in seconds

access_tokenstringOptional

A JWT containing the caller's username or application, an expiration date and a set of entitlements related to the specified scope, signed by the caller's private key.

401

Client is unauthorized to access this resource

application/json

403

Forbidden to access this endpoint .

application/json

500

Server error, see response body for further details.

application/json

post

/idm/tokens

HTTPcURLJavaScriptPython

POST /login/idm/tokens HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

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

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