API referenceCredentials

Revoke Credentials

POST
/v1/admin/credentials/revoke-batch

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Revoke up to 100 credentials. One result per credential, never all-or-nothing.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Request Body

application/json
  1. body

Body of POST /v1/admin/credentials/revoke-batch: up to 100 at once, one result each.

credential_ids*array<>
Items1 <= items <= 100
reason*Reason
Length1 <= length <= 500

Response Body

Successful Response

application/json
  1. response
items*array<>
succeeded*Succeeded
Range0 <= value
failed*Failed
Range0 <= value
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/credentials/revoke-batch' \  -H 'Content-Type: application/json' \  -d '{  "credential_ids": [    "eeb3e499-2978-4746-969f-bf25b9bd719f"  ],  "reason": "string"}'
Example Response
{  "items": [    {      "index": 0,      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "status": 200,      "problem": {        "type": "about:blank",        "title": "string",        "status": 400,        "code": "no_compliant_model",        "detail": "string",        "instance": "string",        "request_id": "string",        "issues": [          {            "path": "string",            "message": "string"          }        ],        "geo_id": "string"      }    }  ],  "succeeded": 0,  "failed": 0}