API referenceCredentials

Get Credential

GET
/v1/admin/credentials/{credential_id}

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.

Path Parameters

credential_id*Credential Id
Formatuuid

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

Response Body

Successful Response

application/json
  1. response
credential_id*Credential Id
Formatuuid
type*CredentialType
Value in"project_api_key""oauth_client""service_identity""user_token_issuer""provider_key""tool_credential"
status*CredentialStatus
Value in"active""rotated""revoked""expired"
owner*
workspace_id*Workspace Id
Formatuuid
project_id*|null
environment*|null
environment_id?|null
purpose*Purpose
fingerprint*Fingerprint

Fingerprint of the secret or public key; safe to log.

Match^sha256:[0-9a-f]{16,64}$
predecessor_id*|

The credential this one replaced by rotation, so history stays continuous.

created_at*Created At
Formatdate-time
rotated_at*|null
expires_at*|null
revoked_at*|null
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/credentials/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",  "type": "project_api_key",  "status": "active",  "owner": {    "kind": "person",    "name": "string",    "contact": "string"  },  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "environment": "string",  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",  "purpose": "string",  "fingerprint": "string",  "predecessor_id": "c8bad2a2-4d3d-486b-89ca-11a0c911eff9",  "created_at": "2019-08-24T14:15:22Z",  "rotated_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "revoked_at": "2019-08-24T14:15:22Z"}