Skip to content
Authrim

Update a machine access principal

PATCH
/api/admin/machine-access/principals/{id}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/machine-access/principals/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "Setup Tool", "token_ttl_seconds": 600, "permissions": [ "admin:tenants:read" ], "tenant_scopes": [ { "scope_mode": "allow", "tenant_id": "tenant_123" } ] }'

Update display metadata, token TTL, permissions, or tenant scopes for a machine principal.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”

Update a machine principal.

Media type application/json
object
display_name
string
description
Any of:
string
token_ttl_seconds
integer format: int64
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": "Setup Tool",
  "token_ttl_seconds": 600,
  "permissions": [
    "admin:tenants:read"
  ],
  "tenant_scopes": [
    {
      "scope_mode": "allow",
      "tenant_id": "tenant_123"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Machine principal.

Media type application/json
object
principal
required
object
id
string
clientId
string
displayName
string
description
Any of:
string
principalType
string
Allowed values: setup_tool admin_ui_bff automation ci mcp_server ai_agent internal_service integration
status
string
Allowed values: active disabled deleted
tokenTtlSeconds
integer format: int64
createdAt
integer format: int64
updatedAt
integer format: int64
permissions
Array<string>
tenantScopes
Array<object>
object
scope_mode
required
string
Allowed values: none all allow
tenant_id
Any of:
string
credentials
Array<object>
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 
{
  "principal": {
    "id": "amp_123",
    "clientId": "setup-tool",
    "displayName": "Setup Tool",
    "description": "Automation used by setup.",
    "principalType": "setup_tool",
    "status": "active",
    "tokenTtlSeconds": 600,
    "createdAt": 1770000000000,
    "updatedAt": 1770000000000,
    "permissions": [
      "admin:tenants:read"
    ],
    "tenantScopes": [
      {
        "scopeMode": "allow",
        "tenantId": "tenant_123"
      }
    ],
    "credentials": []
  }
}

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"
}