Replace an Agent

put

https://{tenanturl}/v1.0/Agents/{id}

Fully replaces an agent (SCIM 2.0 PUT). Immutable fields (id, meta) are ignored.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique identifier of the agent (UUID)

Body Params

Complete agent data for replacement

Agent update request schema for PUT operations. Both 'schemas' and 'displayName' are required.

schemas

array of strings

required

REQUIRED - SCIM schema URIs

schemas*

displayName

string

required

length ≤ 256

REQUIRED - Human-readable name for the agent. Must be unique within tenant. Max 256 characters.

status

string

enum

Agent status. Optional in PUT — if not provided, defaults to UNDER_REVIEW.

Allowed:

description

string

length ≤ 1024

Detailed description of the agent's purpose (optional). Max 1024 characters.

externalIds

array of strings

length ≤ 1000

External identifiers from source systems (optional). Each externalId must be unique within the tenant. Max 1000 items, each max 128 chars.

externalIds

owners

array of objects

Owner user IDs (optional).

owners

tags

authMethods

array of objects

Authentication methods (optional). Each requires 'name' (unique within agent, max 128 chars) and 'type'.

authMethods

Responses

200

Agent replaced successfully

400

Bad Request - Invalid request payload (CSINH1002E), validation errors (CSINH2100E-CSINH2112E), or immutable field modification (CSINH2111E)

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

Loading…