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*

A single SCIM 2.0 PATCH operation

string
enum
required

The PATCH operation type

Allowed:
string
enum
required

The attribute to target. Required for all operations.

Allowed:
value
object

The value to apply for add and replace operations. Not used for remove. Type depends on the targeted path.

Responses
204

Agent patched successfully - No Content

400

Bad Request - Invalid request payload (CSINH1002E), unknown operation path (CSINH2113E), or validation errors

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions (CSINH2501E), unauthorized status change (CSINH2506E), or unauthorized field change (CSINH2507E)

404

Not Found - Agent not found (CSINH2001E)

409

Conflict - Agent with same displayName or externalId already exists (CSINH2002E)

500

Internal Server Error (CSINH1000E)

Language
URL
LoadingLoading…