Skip to main content
PATCH
Update a client profile

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<client-profile-id>
required

ID of the client profile. Client Profile identifier.

Body

application/json

Top-level JSON Merge Patch (RFC 7386): omitted top-level fields remain unchanged. Nested objects such as client_configuration must be supplied in full.

name
string

Display name of the client profile.

Required string length: 1 - 128
Pattern: ^[^\u0000]*$
description
string | null

Optional description of the client profile.

Maximum string length: 256
Pattern: ^[^\u0000]*$
client_configuration
object

Runtime policy applied to matched clients. Omitted fields fall back to each client's own setting.

apply_policy
object

Runtime matching rules that determine which clients this profile governs.

Response

Client profile successfully updated.

id
string<client-profile-id>
required

Client Profile identifier.

name
string
required

Display name of the client profile.

Required string length: 1 - 128
Pattern: ^[^\u0000]*$
client_configuration
object
required

Runtime policy applied to matched clients. Omitted fields fall back to each client's own setting.

apply_policy
object
required

Runtime matching rules that determine which clients this profile governs.

description
string | null

Optional description of the client profile.

Maximum string length: 256
Pattern: ^[^\u0000]*$
created_at
string<date-time>

Timestamp of creation.

updated_at
string<date-time>

Timestamp of last update.