Stable API tag

directory

Directory: agent groups, provisioned groups, invitations, onboarding

12 paths · 16 operations

/v1/agent-groups

get

List agent groups in the resolved tenant

Operation ID: listAgentGroups
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
X-Olivares-Tenant	header	no	string · uuid
limit	query	no	integer
cursor	query	no	string
workspace_id	query	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

post

Create an agent group (name, slug and optional workspace scope)

Operation ID: createAgentGroup
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
X-Olivares-Tenant	header	no	string · uuid

Response codes

201 · 400 · 401 · 403 · 404 · 409 · 429

/v1/agent-groups/{id}

get

Get an agent group by ID

Operation ID: getAgentGroup
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

delete

Delete a group and its roster (the membership rows), never the member agents themselves

Operation ID: deleteAgentGroup
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

204 · 400 · 401 · 403 · 404 · 409 · 429

patch

Update an agent group; only fields present in the request are touched

Operation ID: updateAgentGroup
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/agent-groups/{id}/members

get

List the agents that are members of one group

Operation ID: listAgentGroupMembers
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid
limit	query	no	integer
cursor	query	no	string

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/agent-groups/{id}/members/{agentID}

put

Add an agent to a group. Idempotent: 200 with the existing row when already a member, 201 for a fresh add

Operation ID: addAgentGroupMember
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
agentID	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 201 · 400 · 401 · 403 · 404 · 409 · 429

delete

Remove an agent from a group (404 when the agent is not a member)

Operation ID: removeAgentGroupMember
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
agentID	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

204 · 400 · 401 · 403 · 404 · 409 · 429

/v1/groups

get

List the tenant's provisioned groups with their mapped roles and member counts — the operator's view of what the IdP pushed and what each group confers

Operation ID: listGroups
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/groups/{id}/parent

put

Nest (or, with an empty parent_id, un-nest) a group under another group of the same tenant; a member of the child is then also a member of the parent for authorization (409 on a cycle)

Operation ID: setGroupParent
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/groups/{id}/role

put

Set (or clear, with an empty role) the role a group's members are elevated to in the group's tenant; ceiling-checked against the caller's authority

Operation ID: setGroupRole
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/groups/{id}/workspace

put

Place a user group in a workspace of the same tenant, or clear its place with an empty workspace_id; membership and authorization are unchanged

Operation ID: setGroupWorkspace
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/invites

get

List the tenant's pending (unaccepted, unexpired) invitations, without any token material

Operation ID: listInvites
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/invites/{id}

delete

Delete a pending invitation

Operation ID: revokeInvite
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

204 · 400 · 401 · 403 · 404 · 409 · 429

/v1/invites/{id}/resend

post

Rotate a pending invitation's secret and mail the new link to the invitee (409 invite_delivery_unavailable without a mailer)

Operation ID: resendInvite
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

202 · 400 · 401 · 403 · 404 · 409 · 429

/v1/onboard

post

Create-or-reuse an account and grant its tenant membership (membership:write, AAL3 step-up; mode invite emails a single-use token)

Operation ID: onboardMember
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
X-Olivares-Tenant	header	no	string · uuid

Response codes

201 · 202 · 400 · 401 · 403 · 404 · 409 · 429