Powered by Redocly

Token Refresh

Invoke the refresh operation

SecurityaccessToken
Request
query Parameters
site
string

Send the request to the specfifed site

Request Body schema:
increment
string <duration>

A duration in years, days, hours, minutes and seconds.

Format is [<digits>y][<digits>d][<digits>m][<digits>s].

Examples: 1y2d5h, 5h or 10m30s

Requested new TTL (from refresh time).

  • Refresh resets TTL; it does not add.

  • Periodic tokens (>0):

new-ttl = min(increment, token-period, token-max-ttl, MaxTTL, parent-remaining)
  • Non-periodic (0):
new-ttl = min(increment, token-max-ttl, MaxTTL, parent-remaining)
  • Requires token-renewable = true.
  • Refresh rejected if token expired or disabled.
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/strongbox/token/refresh
Request samples 
increment: 15m
Response samples 
token: c4d34179-40de-4d21-8961-81f6e0a28ffa
expires-in: 2764227
expires: 2022-01-14T10:24:47.108429Z
accessor: d0596eaa-a798-4062-8688-64fa2818e09b
creation-time: 2022-01-13T10:24:47.108429Z
renewal-time: 2022-01-13T10:24:47.108429Z
jwt-svid: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InNpZ25pbmcta2V5LTEifQ.eyJzdWIiOiJzcGlmZmU6Ly9hY21lLmNvbS91c2VycGFzcy1qb2huZG9lIiwiYXVkIjpbInNlcnZpY2UtYSJdLCJleHAiOjE2MTM0OTE4NjAsImlhdCI6MTYxMzQwNTQ2MCwiaXNzIjoiaHR0cHM6Ly9hY21lLmNvbSJ9.MEYCIQCwxlhZ3PjsqN8BjKp2fVRGP1LSmX4v7Yd5U2wQdNlBtQIhAOT3fRY6mDPkqZFw4NlJi3VeRsqG1mXXYoQnBT4e7S4f
x509-svid:
  cert: |
    -----BEGIN CERTIFICATE-----
    MIIBpTCCAU2gAwIBAgIRAK3mG9HJ2+CaGVd4yFR5NlcwCgYIKoZIzj0EAwIwADAe
    Fw0yMTAyMTUxNDI0MjBaFw0yMTAyMTYxNDI0MjBaMAAwWTATBgcqhkjOPQIBBggq
    hkjOPQMBBwNCAAT6VjMQBUBXi3gp9gXvqPdZcAkrj82vqc8JIK3RJPXMB0GA1Ud
    EQQWMBSGEnNwaWZmZTovL2FjbWUuY29t
    -----END CERTIFICATE-----
  private-key: |
    -----BEGIN EC PRIVATE KEY-----
    MHQCAQEEIBqnpXcvymDiWo9cMxmE2Cg3JNFh4HLiCbI+XE7ZzpFioAoGCCqGSM49
    AwEHoWQDYgAE+lYzEAVAV4t4KfYF76j3WXAJKip3RJPXM7FH4UDgxhE=
    -----END EC PRIVATE KEY-----
➔ Next to Token TTL