Skip to main content
PATCH
Update Principal

Authorizations

Authorization
string
header
required

Bearer scheme name used by typed customer admin operations.

Path Parameters

id
string<uuid>
required

Principal UUID

Body

application/json

Request body for PATCH /v1/admin/identity/principals/{id}.

display_name
string | null

New customer-facing label.

Maximum string length: 200
max_session_ttl_seconds
integer<int64> | null

Replacement maximum session TTL in seconds.

Example:

900

scopes
string[] | null

Replacement scopes granted to newly minted sessions.

Example:
status
string | null

New lifecycle state: active or disabled.

Example:

"disabled"

Response

Principal updated

Principal detail response.

claim_constraints
object
required

Additional claim constraints used when subject_match_type is claim-constraints.

created_at
string
required

RFC 3339 creation timestamp.

Example:

"2026-05-25T17:20:00Z"

display_name
string
required

Customer-facing principal label.

Example:

"ci-prod-deploy"

id
string
required

Stable principal UUID.

max_session_ttl_seconds
integer<int64>
required
Example:

900

scopes
string[]
required
Example:
status
string
required

Principal lifecycle state. Disabled principals cannot mint sessions.

Example:

"active"

subject_match_type
string
required

Subject matching mode: exact or claim-constraints.

Example:

"exact"

subject_match_value
string
required

Required subject value or descriptor for the claim constraint.

Example:

"repo:Mount-Thor/mount-thor:ref:refs/heads/main"

tenant_id
string
required
trusted_issuer_id
string
required
updated_at
string
required

RFC 3339 update timestamp.

Example:

"2026-05-25T17:30:00Z"

customer_id
string
required

Stable UUID for the customer account.