Rotate the password for a credential

Accepts a client-chosen new password, encrypts it with the current master key, persists it as pending (Phase 0), calls BACEN’s PUT /staws/senha (Phase 1), and promotes pending -> encrypted (Phase 2).

POST /v1/credentials/{id}/rotate

Rotate the password for a credential

cURL

curl --request POST \
  --url https://sta.sandbox.lerian.net/v1/credentials/{id}/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "password": "<string>"
}
'

200

{
  "credentialId": "<string>",
  "rotatedAt": "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"

Body

application/json

Rotation payload carrying the new plaintext password

password · string · required

Response

200

application/json

OK

credentialId · string · required

rotatedAt · string<date-time> · required