Renew a Secure Identity session

Changed on Oct 28, 2026

Trade the refresh token for a new access token at the desk organization's Secure Identity. The refresh token is spent by its one use: the answer carries the next one. A renewal is answered only while the customer is not refused at the desk and the identity service's directory names the person the holder of the address their requests are under. A refusal answers no tokens, and the customer signs in again; when the desk refuses after the identity service rotated the pair (the customer is refused, or the person no longer holds that address), the session it rotated is revoked there first. A renewal that fails short of a refusal revokes nothing, so a prompt retry can still renew.

post/hd/desks/{desk_id}/auth/identity/refresh

Request

Base URL
https://api.sparkvault.com/v1
Auth
none required
TypeScript
https://skmtc.dev/sparkvault/apis/sparkvault-api/docs/hd/desks/:desk_id/auth/identity/refresh/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

desk_idstring required

The desk, as its lookup answered it.

Headers

X-SV-Client'help-desk-portal' required

Names the portal. A request without it answers 400 CLIENT_HEADER_REQUIRED.

Request body

refresh_tokenstring required

Response

The new tokens.

Changes

Oct 28, 2026a9a10e328ba5 Revision changes
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Oct 28, 202656d7c265a77a Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status

Operation history (3 revisions)