Update Credential
Apply a partial update. Unset fields leave the stored value unchanged.
payload is partial too: the secret fields it carries are written and
the ones it omits keep their stored values, so rotating one field of a
multi-field credential cannot leave the rest missing and the credential
unresolvable. An empty payload changes nothing and signals nothing.
document is the same update expressed in the shape a credential form
submits, and is merged the same way. A client that created a credential
from a document updates it with one, rather than carrying its own copy of
a conversion this API already performs.
Clears is_provisional unconditionally: an explicit edit is a
deliberate action on the credential, not a byproduct of connecting a
deployment, whichever fields it happens to change.
A new payload signals every bundle whose resolved configuration reads this credential, so a rotation reaches live sessions on the push path rather than waiting for the bundler's periodic backstop. A rename signals nothing - it alters nothing GET /v1/bundler/resolve returns.
Written through the shared credential write path, so a partial payload is overlaid on the stored secret and a document is read the same way here as at every other surface that accepts one.
Answers 204 for a write that did what it said, and 200 with the reason for one that could not - see write_response.
A document naming a method outside AuthType is a 400. The write reads the document against the credential it lands on, so the rejection can only happen inside the provider; unhandled, it is a traceback whose frame locals are the decrypted document. The credential's own existence is settled by get_manageable above, so that is the only ValueError this write can raise.
Authorization
OAuth2AuthorizationCodeBearer In: header
Path Parameters
uuidQuery Parameters
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A partial update to one credential. An omitted field is left alone.
payload is partial in the same sense as the rest of the body: the
fields it carries are written and the fields it omits keep their stored
values. Sending one field of an oauth2_cc credential therefore rotates
that field rather than discarding the others, and an empty payload
changes nothing at all.
No combination of fields on this shape removes a field. A field is cleared by sending it with an empty value, which every consumer of a payload reads as unset.
The secret arrives as payload in the engine's own shape or as
document in the shape a credential form submits, never as both. Both
are merged onto the stored secret identically; offering only payload
would make a client that creates from a document have to convert before
every update, which is the second copy of a conversion this API owns.
Response Body
application/json
curl -X PATCH "https://example.com/v1/credentials/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}