{"componentChunkName":"component---src-templates-default-template-tsx","path":"/documentation/api/refreshtoken/","result":{"data":{"asciidoc":{"id":"c3a8eaca-f0a2-51a7-830e-9b51d2a4af52","html":"
\n
Table of Contents
\n\n
\n
\n
\n
\n

Refresh token functionality allows to get next access token without providing credentials.\nTo get new access token client in initial call provides client credentials with password and as return get long living\naccess_token which may be used to obtain multiple access tokens.

\n
\n
\n
\n
\n

How to use

\n
\n
\n
    \n
  • \n

    obtaining access token would always return refresh_token (refresh_token would be the same unless it would expire before current access_token)

    \n
    \n

    example request:

    \n
    \n
    \n
    \n
    curl -X POST \"APIENDPOINT/auth/6/app\" -H  \"Content-Type: application/json\" -d \"{  \\\"client_id\\\": \\\"c01234567890abcdefghijklm_c01234567890abcdefghijklm\\\",  \\\"client_secret\\\": \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCD\\\",  \\\"username\\\": \\\"user@company.co\\\",  \\\"password\\\": \\\"12345678\\\"}\"
    \n
    \n
    \n
    \n

    example response:

    \n
    \n
    \n
    \n
    {\n    \"_TOKEN\": \"eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1ODg5MjY5OTcsInN1YiI6ImlkZW50aXR5SWQiLCJkYXRhIjp7InRlYW1zIjpbInRlYW1JZDEsIHRlYW1JZDIiXSwiZGVmYXVsdC1zY29wZSI6ImRlZmF1bHRTY29wZUlkIiwib3JnYW5pemF0aW9uIjoib3JnYW5pemF0aW9uSWQiLCJfQVBQTElDQVRJT04iOiJhcHBsaWNhdGlvbklkIiwiX0lERU5USVRZX0lEIjoiaWRlbnRpdHlJZCIsImV4cGlyZXMtYXQiOjE1ODg5MjY5OTc0NjgsIl9JREVOVElUWSI6ImlkZW50aXR5TmFtZSIsImNyZWF0ZWQtb24iOjE1ODg5MjY5ODc0NjgsImRlZmF1bHQtdGVhbSI6ImRlZmF1bHRUZWFtSWQifSwiaXNzIjoiaHR0cHM6XC9cL2FyYWdvLmNvIiwiYXVkIjoiYXBwbGljYXRpb25JZCIsImlhdCI6MTU4ODkyNjk4N30.$SIGNATURE\",\n    \"_APPLICATION\": \"c1234567890abcdefghijklmn_c1234567890abcdefghijklmn\",\n    \"_IDENTITY\": \"user@company.co\",\n    \"_IDENTITY_ID\": \"c1234567890abcdefghijklmn_c1234567890abcdefghijklmn\",\n    \"expires-at\": 1577711870081,\n    \"refresh-token\": \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCD\",\n    \"type\": \"Bearer\"\n}
    \n
    \n
    \n
    • \n
  • \n

    obtaining token using refresh_token

    \n
    \n

    example request:

    \n
    \n
    \n
    \n
    curl -X POST \"APIENDPOINT/auth/6/refresh\" -H  \"Content-Type: application/json\" -d \"{  \\\"client_id\\\": \\\"c01234567890abcdefghijklm_c01234567890abcdefghijklm\\\",  \\\"client_secret\\\": \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCD\\\",  \\\"refresh_token\\\": \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCD\\\"}\"
    \n
    \n
    \n
    \n

    example response:

    \n
    \n
    \n
    \n
    {\n    \"_TOKEN\": \"eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1ODg5MjY5OTcsInN1YiI6ImlkZW50aXR5SWQiLCJkYXRhIjp7InRlYW1zIjpbInRlYW1JZDEsIHRlYW1JZDIiXSwiZGVmYXVsdC1zY29wZSI6ImRlZmF1bHRTY29wZUlkIiwib3JnYW5pemF0aW9uIjoib3JnYW5pemF0aW9uSWQiLCJfQVBQTElDQVRJT04iOiJhcHBsaWNhdGlvbklkIiwiX0lERU5USVRZX0lEIjoiaWRlbnRpdHlJZCIsImV4cGlyZXMtYXQiOjE1ODg5MjY5OTc0NjgsIl9JREVOVElUWSI6ImlkZW50aXR5TmFtZSIsImNyZWF0ZWQtb24iOjE1ODg5MjY5ODc0NjgsImRlZmF1bHQtdGVhbSI6ImRlZmF1bHRUZWFtSWQifSwiaXNzIjoiaHR0cHM6XC9cL2FyYWdvLmNvIiwiYXVkIjoiYXBwbGljYXRpb25JZCIsImlhdCI6MTU4ODkyNjk4N30.$SIGNATURE\",\n    \"_APPLICATION\": \"c1234567890abcdefghijklmn_c1234567890abcdefghijklmn\",\n    \"_IDENTITY\": \"user@company.co\",\n    \"_IDENTITY_ID\": \"c1234567890abcdefghijklmn_c1234567890abcdefghijklmn\",\n    \"expires-at\": 1577711870081,\n    \"type\": \"Bearer\"\n}
    \n
    \n
    \n
    • \n
  • \n

    if trying to refresh token using expired one it would return 401 and then one shall obtain fresh one

    \n
    • \n
\n
\n
\n
\n
\n

Default validity periods for tokens

\n
\n
\n
    \n
  • \n

    access_token = 1h

    \n
    • \n
  • \n

    refresh_token = 24h

    \n
    • \n
\n
\n
\n
\n
\n

Token revocation

\n
\n
\n

Revocation of refresh token works same way as for access token

\n
\n
\n
","document":{"main":"Refresh Token","title":"Refresh Token: App authenticate flow","subtitle":"App authenticate flow"},"fields":{"toc":true,"location":["documentation","api","refreshtoken"]}},"sidebarYaml":{"id":"6d066bdd-c982-5a69-b909-a31e6fc044e0","showIndex":null}},"pageContext":{"id":"c3a8eaca-f0a2-51a7-830e-9b51d2a4af52","parent":"documentation"}},"staticQueryHashes":["1010459453","1010459453","2356112386","2356112386","2603905930","2603905930","3026652197","3026652197","3167850324","3167850324","63159454","63159454"]}