JUjumpcloud
Agents

Register an agent

Registers a new agent identity in your organization.

post/api/v2/agents

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

namestring required

Agent name

emailstring email required

Company email address for this agent

descriptionstring

Free-text description of this agent

ownerIdstring required

ID of the human user who will own this agent. Must be in the same organization.

Response

Agent created successfully

idstring required

Agent ID (24-character hexadecimal string).

organizationIdstring required

Organization ID (24-character hexadecimal string).

namestring required

Agent name

descriptionstring

Free-text description of this agent

emailstring email required

Company email address for this agent

ownerIdstring nullable

ID of the human user who owns this agent. Required at creation; becomes null only if the owning user is later deleted.

state'active' | 'suspended' required

Lifecycle state (active or suspended).

Changes

No recorded changes to this operation across all 1 revision of this API.