Skip to Content
IntegrationsAuthentication API

๐Ÿ” Authentication API

This API provides access tokens using the OAuth2 client credentials flow.

To use it, you must first configure a valid set of credentials, which includes:

  • Application Client ID
  • Application Client Secret
  • Application Scope
  • Token Endpoint URL

Once you have these credentials, contact your administrator to ensure they are securely stored and used to retrieve access tokens when needed.


๐Ÿ“˜ Endpoint: Get Access Token

๐Ÿ”— URL

GET https://syntphonyintegrations.azure-api.net/Auth/user/auth/token/{environmentId}

Note: Replace {environmentId} with your Application Client ID as defined in the credentials section.

๐Ÿ” Authentication

This endpoint requires a valid Bearer Token in the request header:

Authorization: Bearer <your_access_token>

The token must be obtained in advance using the OAuth2 protocol or a compatible authentication flow.

The API internally validates the following token attributes:

  • Issuer
  • Audience
  • Signature
  • Expiration

๐Ÿ“ค Request Example

GET https://syntphonyintegrations.azure-api.net/Auth/user/auth/token/165e1659-99c1-40f2-8ba6-4bd336b703f5 HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

โœ… Successful Response 200 OK

{ "access_token": "eyJhbGciOiJSUzI1NiIsImtp...", "expires_in": 3600, "refresh_expires_in": 0, "refresh_token": null, "token_type": "Bearer", "session_state": null, "scope": null }

โš ๏ธ Common Error Codes

CodeMessageCause
401UnauthorizedInvalid or missing token
500Internal Server ErrorUnexpected error during token processing
Last updated on