Read a credential

Returns the credential metadata for the supplied id. The encrypted password is never returned. Emits credential.accessed via audit_outbox on every successful read.

GET /v1/credentials/{id}

Read a credential

cURL

curl --request GET \
  --url https://sta.sandbox.lerian.net/v1/credentials/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "institutionCode": "<string>",
  "operatorId": "<string>",
  "status": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "asOf": "2023-11-07T05:31:56Z",
  "daysRemaining": 123,
  "description": "<string>",
  "expiryStatus": "<string>",
  "lastExpiryCheckedAt": "2023-11-07T05:31:56Z",
  "lastRotatedAt": "2023-11-07T05:31:56Z",
  "lastTestResult": "<string>",
  "lastTestedAt": "2023-11-07T05:31:56Z",
  "passwordExpiresAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Credential UUID

Example:

"018f3b2a-0c1d-7a2b-9e4f-1a2b3c4d5e6f"

Response

200

application/json

OK

createdAt · string<date-time> · required

id · string · required

institutionCode · string · required

operatorId · string · required

status · string · required

updatedAt · string<date-time> · required

asOf · string<date-time>

daysRemaining · integer<int64>

description · string

expiryStatus · string

lastExpiryCheckedAt · string<date-time>

lastRotatedAt · string<date-time>

lastTestResult · string

lastTestedAt · string<date-time>

passwordExpiresAt · string<date-time>