Stable API tag

system

Tenant provisioning and memberships

11 paths · 14 operations

/v1/members

get

List the resolved tenant's member roster (role, workspace scoping, groups)

Operation ID: listMembers
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/members/{id}

delete

Remove a member from the resolved tenant: a scoped offboard that leaves the account and its other organizations alone (404 when the id is not a member; 409 when the caller removes itself or the last active owner; 403 when the member outranks the caller or the caller is confined to a workspace; a signed-in person also needs the administrative step-up)

Operation ID: removeMember
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/memberships

post

Grant a user a role in a tenant

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

Parameters: none declared.

Response codes

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

/v1/search

get

Federated console search: fan out to every searchable kind, deny-closed per kind on its own read permission

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

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

Response codes

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

/v1/system/orgs

get

List tenant orgs (superadmin)

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

Parameters: none declared.

Response codes

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

post

Provision a tenant (superadmin)

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

Parameters: none declared.

Response codes

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

/v1/system/orgs/{tenant_id}

delete

Hard-delete a tenant org after the cloud grace period (superadmin)

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

Parameters
Name	In	Required	Type
tenant_id	path	yes	string · uuid

Response codes

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

/v1/system/orgs/{tenant_id}/region

put

Set or clear a tenant residency pin (superadmin, AAL3 step-up)

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

Parameters
Name	In	Required	Type
tenant_id	path	yes	string · uuid

Response codes

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

/v1/system/orgs/{tenant_id}/status

put

Withdraw or restore a tenant's service without deleting its data (superadmin)

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

Parameters
Name	In	Required	Type
tenant_id	path	yes	string · uuid

Response codes

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

/v1/system/residency

get

Get the configured data-residency registry (superadmin)

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

Parameters: none declared.

Response codes

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

/v1/system/session-idle

get

Read instance session idle-stop settings (superadmin)

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

Parameters: none declared.

Response codes

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

put

Save instance session idle-stop settings (superadmin, configured step-up)

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

Parameters: none declared.

Response codes

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

/v1/system/tracing

get

Read saved and effective tracing settings (superadmin)

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

Parameters: none declared.

Response codes

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

put

Save and apply tracing settings (superadmin, configured step-up)

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

Parameters: none declared.

Response codes

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