A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"scope": "openid credentials.read credentials.verify",
"agentApiKey": "air_ag_<secret>",
"publicKey": "<string>",
"nickname": "<string>",
"partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "INVALID_TOKEN",
"message": "Unknown agent API key"
}{
"code": "AGENT_KEYS_DISABLED",
"message": "Agent keys are not enabled for this partner"
}{
"code": "INVALID_PARAMETER",
"message": "<string>"
}Rotate an agent API key
Issues a new agentApiKey (returned once), increments the key’s token
version, and invalidates agent JWTs already issued for it. wallet.sign
keys cannot be rotated on this path.
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"scope": "openid credentials.read credentials.verify",
"agentApiKey": "air_ag_<secret>",
"publicKey": "<string>",
"nickname": "<string>",
"partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "INVALID_TOKEN",
"message": "Unknown agent API key"
}{
"code": "AGENT_KEYS_DISABLED",
"message": "Agent keys are not enabled for this partner"
}{
"code": "INVALID_PARAMETER",
"message": "<string>"
}Authorizations
The holder's AIR Kit partner access token, from airService.getAccessToken().
Send it with x-partner-id.
JWT signed with your partner login key (the same key used for the AIR Kit
login partnerJwt). Its partnerId must match x-partner-id and the
AIR Kit session. Omit email unless it is this holder's. Body partnerJwt
is accepted as a fallback.
Headers
Your Partner ID (UUID) from the Developer Dashboard.
Path Parameters
Agent key UUID from bind or list.
Response
Rotated key. Store the new agentApiKey.
Space-delimited scopes granted to the key, including openid.
"openid credentials.read credentials.verify"
Opaque secret with the prefix air_ag_. Returned only once.
"air_ag_<secret>"
Masked PEM when a public key was bound; null for API-key-only agents.
Was this page helpful?