2.1.1 Token object

Represents an OAuth token response. Please see the OAuth documentation.

Example

{
  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJXSHJrck9DMFNEcWY2VjNXYVRrblpRIiwiZXhwIjoxNDY1ODI5Mjc0LCJqdGkiOiIwNzBiOGE1MS1hYjFkLTRlZDktODJjZS04YzNmZTlkMTJlMmEiLCJjbGllbnRfaWQiOiIzYWFhZTU1ZDc0ZDk0NmY0YWM2NTY4YTA3MjYxMDk5ZCIsInNjb3BlIjpbIlJPTEVfVVNFUiJdfQ.DmqZWRDMV4zctJ5R_WSsn_axGzfDNGOJJO79_garrM9w8zOvd7ZmAGgtFrVVcUWjfR3AR0RaXGM3wdHoqOs2YleD_AeYcrxDPJkiUDoQXQN3I9qNsediwhcMYj9l5UYlpR6uD3lcRzkCM4L5u4PTqs2RjZL2GBgvUMeQZNowpyK_shT_o_U4Y_LFnBWFf2c9MtKhUAIuNdqQ98jAxwEnS2tO_OUFCZ2JzZyFHmteQYz8q_kl5SE0UdBXmUfl4RKmxmozKyQFIA3p56Qtl65E_t8lJQVLC0OwL-2elAJMgqQy-J-ZHB3b9SMM9HXIDe81J-Sx51-R8bK4Dx28EZIPdg",
  "expires_in": 2591999,
  "refresh_token": "ca9ff8d9-c62e-424c-b57c-68f544d8d07e",
  "scope": "ROLE_USER",
  "token_type": "bearer"
}

Fields

Field	Type	Description
`access_token` required	String	The actual OAuth token.
`expires_in` required	Integer	The number of seconds this OAuth token is valid for. Example value: `3600`
`refresh_token` optional	String	An OAuth refresh token. It can be used to request a new token. Example value: `ca9ff8d9-c62e-424c-b57c-68f544d8d07e`
`scope` optional	String	The scope of the access token. It defines the scope of the authorization that was granted by the user Example value: `ROLE_USER`
`token_type` optional	String	The type of the access token. Always bearer, to indicate that the bearer of the access token is authorized, regardless of who it is.

Last updated on 2025-04-18