latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

Agents

public

Register a new Agent under an Organization.

post/orgs/{orgId}/agents

Path parameters

orgIdstring required

The Organization ID

Request body

idstring required

The Agent id. It can't be empty and should contain only url safe characters.

public_keystring required

A pcks8 RSA public key PEM encoded (as the ones produced by openssl), whose module length is greater or equal than 4096 bits.

descriptionstring

An optional description to show future users.

Example request

{
  "id": "agent-id",
  "public_key": "-----BEGIN PUBLIC KEY-----\n...-----END PUBLIC KEY-----",
  "description": "One of my agents."
}

Response

Agent registered.

idstring required

The Agent id.

descriptionstring

A description to show future users. It can be empty.

created_atstring date-time required

Time of the Agent being registered.

created_bystring required

User ID of user that added the Agent.

Example response

{
  "id": "agent-id",
  "description": "One of my agents.",
  "created_at": "2020-06-22T09:37:23.523Z",
  "created_by": "00000000-0000-0000-0000-000000000000"
}