Hanzo
OpenapiIam

Changes what a key is called or what it may reach.

Changes what a key is called or what it may reach.

POST /v1/iam/keys/update

Addresshttps://api.hanzo.ai/v1/iam/keys/update
MethodPOST
Operationpost_iam_keys_update
AuthAuthorization: Bearer $HANZO_API_KEY

Changes what a key is called or what it may reach. The credential itself is not reissued — the key in your deployment keeps working.

Request

20 fields, body application/json (required).

FieldInTypeRequiredDescription
accessKeybodystringAccessKey (pk-) is the publishable identifier and lookup index; AccessSecret (sk-) is the confidential secret.
accessSecretbodystring
accessSecretDigestbodystringAccessSecretDigest is how a presented secret finds its key: the resolver digests what the caller sent and looks THAT up.
actbodybooleanAct is the durable, opt-in grant that lets this key act FOR a user in its own org — the credential behind as(): presenting it authorizes minting a short-lived,…
applicationbodystring
createdAtbodystring (date-time)
createdTimebodystringCreatedTime and UpdatedTime are RFC3339 audit stamps carried as strings for byte-parity with the v1 row (orm.Model separately tracks CreatedAt / UpdatedAt as…
deletedbodyboolean
displayNamebodystringDisplayName is the human-facing label.
expireTimebodystringExpireTime is when the key stops being honored (empty = never).
idbodystring
namebodystring
organizationbodystring
ownerbodystringOwner is the tenant that holds the key; Name is unique within Owner.
scopebodystringScope is the key's ACCESS CLASS, orthogonal to Type (which names the bound principal).
statebodystring
typebodystringType is the scope the key is bound to — "Organization", "Application", "User", or "General" — and Organization / Application / User name the concrete principal…
updatedAtbodystring (date-time)
updatedTimebodystring
userbodystring

Response

StatusBodyMeaning
200iam.Keyok

200 body — 20 fields.

FieldInTypeAlwaysDescription
accessKeybodystringAccessKey (pk-) is the publishable identifier and lookup index; AccessSecret (sk-) is the confidential secret.
accessSecretbodystring
accessSecretDigestbodystringAccessSecretDigest is how a presented secret finds its key: the resolver digests what the caller sent and looks THAT up.
actbodybooleanAct is the durable, opt-in grant that lets this key act FOR a user in its own org — the credential behind as(): presenting it authorizes minting a short-lived,…
applicationbodystring
createdAtbodystring (date-time)
createdTimebodystringCreatedTime and UpdatedTime are RFC3339 audit stamps carried as strings for byte-parity with the v1 row (orm.Model separately tracks CreatedAt / UpdatedAt as…
deletedbodyboolean
displayNamebodystringDisplayName is the human-facing label.
expireTimebodystringExpireTime is when the key stops being honored (empty = never).
idbodystring
namebodystring
organizationbodystring
ownerbodystringOwner is the tenant that holds the key; Name is unique within Owner.
scopebodystringScope is the key's ACCESS CLASS, orthogonal to Type (which names the bound principal).
statebodystring
typebodystringType is the scope the key is bound to — "Organization", "Application", "User", or "General" — and Organization / Application / User name the concrete principal…
updatedAtbodystring (date-time)
updatedTimebodystring
userbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo iam keys update

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page