Partially update an Agent

Partially updates an agent using the SCIM 2.0 PATCH operation. Only the fields specified in the operations array are modified; all other fields remain unchanged.

Entitlements:

  • tenantAdmin — full access (all operations)
  • agentOwner — full create, read, update, and delete access, and status changes
  • writeAgents — update metadata only; cannot change status
  • manageAgentStatus — update status only; all other fields must match existing values

Supported Paths

  • displayName, description, status, tags, externalIds, owners

Note: displayName is mandatory and cannot be removed.

Examples

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    { "op": "replace", "path": "status", "value": "ACTIVE" },
    { "op": "add", "path": "tags", "value": ["production"] },
    { "op": "remove", "path": "description" }
  ]
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the agent (UUID)

Body Params

SCIM 2.0 PATCH request body containing one or more operations

SCIM 2.0 PATCH request. Contains one or more operations to apply to an agent.

schemas
array of strings
required

SCIM schema URIs — must include urn:ietf:params:scim:api:messages:2.0:PatchOp

schemas*
Operations
array of objects
required
length ≥ 1

Array of patch operations to apply

Operations*

The operation that is to be performed.

string
required

The operation to be performed. The value must be one of the following values "add", "remove", "replace", "move", "copy", or "test"

string
required

The reference location in the target document that is to be altered

string

The reference location in the target document from which to copy or move the value

string

The value to use in an add, replace, or test operation. The data type of the specified value is the type to be stored at the reference location

Responses
204

Agent patched successfully - No Content

Language
URL
LoadingLoading…
Response
Choose an example:
application/scim+json