Skip to content
Authrim

Update Credential.

PATCH
/api/admin/machine-access/principals/{id}/credentials/{credentialId}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/machine-access/principals/example/credentials/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "Production signing key", "status": "active" }'

Update Credential in the Machine Access area. The request body is JSON unless the detailed schema for this operation states otherwise.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
credentialId
required
string

Request Body required

Section titled “Request Body required ”

Update a machine credential.

Media type application/json
object
display_name
string
description
Any of:
string
status
string
not_before
Any of:
integer format: int64
expires_at
Any of:
integer format: int64
revoke_reason
Any of:
string
permissions
Array<string>
tenant_scopes
Array<object>
object
scope_mode
required
string
Allowed values: none all allow
tenant_id
Any of:
string
Example 
{
  "display_name": "Production signing key",
  "status": "active"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Machine credential.

Media type application/json
object
credential
required
object
id
string
principalId
string
kid
string
publicJwkJson
string
alg
string
Allowed values: ES256 PS256 RS256
displayName
string
description
Any of:
string
status
string
Allowed values: active rotating revoked expired
notBefore
Any of:
integer format: int64
expiresAt
Any of:
integer format: int64
createdAt
integer format: int64
updatedAt
integer format: int64
Example 
{
  "credential": {
    "id": "amk_123",
    "principalId": "amp_123",
    "kid": "kid-2026-01",
    "alg": "ES256",
    "displayName": "Production signing key",
    "description": "Primary automation credential.",
    "status": "active",
    "notBefore": null,
    "expiresAt": 1800000000000,
    "createdAt": 1770000000000,
    "updatedAt": 1770000000000
  }
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}