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//yourpodURL.symphony.com/login/idm/tokens

Query parameters

Header parameters

Response

200401403500

OK.

Body

application/json

token_typestring

Type of token, string "Bearer"

expires_ininteger (int64)

Duration of time the access token is granted for in seconds

access_tokenstring

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.

Request

JavaScriptCurlPython

const response = await fetch('//yourpodURL.symphony.com/login/idm/tokens', {
    method: 'POST',
    headers: {
      "sessionToken": "text"
    },
});
const data = await response.json();

Response

200401403500

{
  "token_type": "text",
  "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.