Check one member of a platform key pool with the vendor

POST /v1/platform/credentials/{provider}/{key_id}/verify

Asks the vendor whether it accepts the stored key of one active member of the Provider's key pool and, where the vendor offers an account request, what the account behind it can serve (1.41.0, boards #121 and #135). A key the vendor refuses answers 200 with ok false and account null, and the check changes nothing else; a vendor that does not answer is dependency_unavailable. When the check reads the account, the api stores the reading as the credential's account in the transaction of the Audit event; a refused key or a failed account request leaves the stored account as it was. The secret is never returned, logged or written to the Audit event, which names the Provider, the version and the outcome. A revoked member, or one of another Provider, is not_found. The check never disables a member; an operator does that with PATCH.

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 POST "$VOCAL_API/v1/platform/credentials/mock/plk_.../verify" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch(`${process.env.VOCAL_API}/v1/platform/credentials/mock/plk_.../verify`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/platform/credentials/mock/plk_.../verify",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is CredentialVerifyResult.