post
https://{tenanturl}/v1.0/Agents
Onboards a new agent in IBM Verify following the SCIM 2.0 Agent schema.
Schema: urn:ietf:params:scim:schemas:core:ibm:2.0:Agent
Required Entitlements (at least one): tenantAdmin, writeAgents, agentOwner
Mandatory Fields
- schemas (array): SCIM schema URIs - REQUIRED
- displayName (string, max 256 chars): Human-readable name for the agent. Must be unique within tenant - REQUIRED
Optional Fields
- status (string): Agent status. Values: DEFAULT, ACTIVE, SUSPENDED, UNDER_REVIEW. Any value provided is silently overridden to
UNDER_REVIEWon creation. - description (string, max 1024 chars): Detailed description of the agent's purpose
- externalIds (array): External system identifiers. Each must be unique within tenant. Max 1000 items, each max 128 chars.
- owners (array): Owner user IDs
- tags (array): Custom tags for categorization
- authMethods (array): Authentication methods. Each requires 'name' (unique within agent, max 128 chars) and 'type' (jwt, certificate, oidc, oauth, apikey, mtls, svid-jwt, svid-x509)
Read-Only Fields
- oauthClients (array): OAuth clients are READ-ONLY. Fetched dynamically once Agent Id gets associated with OIDC Applications. Cannot be set through POST/PUT.
Uniqueness Constraints
- displayName: Must be unique within tenant
- externalIds: Each externalId must be unique within tenant
- authMethods[].name: Must be unique within the agent
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests⊠| |||
LoadingâŠ
201Agent created successfully
400Bad Request - Invalid request payload (CSINH1002E) or validation errors (CSINH2100E-CSINH2112E)
401Unauthorized - Authentication required
403Forbidden - Insufficient permissions (CSINH2501E)
409Conflict - Agent with same displayName or externalId already exists (CSINH2002E)
500Internal Server Error (CSINH1000E)
