Enter or rotate the platform credential of a Provider

PUT /v1/platform/credentials/{provider}

Seals the secret as the Provider's next credential version and revokes every active one, so the Provider's key pool holds this member alone (1.28.0; before it, the one active version). The request body is never logged, never stored in clear and never returned; the response and the Audit event name the Provider and the version only. A Provider whose descriptors declare no credential mode is refused with validation_failed. Running Sessions keep the secret they were issued.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X PUT "$VOCAL_API/v1/platform/credentials/mock" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "secret": "<secret>" }'

const response = await fetch(`${process.env.VOCAL_API}/v1/platform/credentials/mock`, {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "secret": "<secret>"
  }),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.put(
    f"{os.environ['VOCAL_API']}/v1/platform/credentials/mock",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
    json={
        "secret": "<secret>",
    },
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: PlatformCredentialPutRequest.

Responses

Fields of the 200 answer

The shape is PlatformCredential.