Organization, members and teams
199 endpoints. Paths are relative to https://api.sandscale.dev; values in braces are ones you fill in.
API reference · Authentication · Errors
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/departments | List departments |
POST | /api/v1/departments | Create a department |
GET | /api/v1/departments/{dept_id}/teams | List the teams of a department |
POST | /api/v1/departments/{dept_id}/teams | Create a team for a department |
GET | /api/v1/departments/{id} | Get one department |
PUT | /api/v1/departments/{id} | Replace one department |
DELETE | /api/v1/departments/{id} | Delete one department |
GET | /api/v1/directory/applications/{client}/assignments | List the assignments of an application |
POST | /api/v1/directory/applications/{client}/assignments | Create an assignment for an application |
DELETE | /api/v1/directory/applications/{client}/assignments/{type}/{principal} | Delete one {type} |
GET | /api/v1/directory/applications/{client}/settings | Settings of an application |
PUT | /api/v1/directory/applications/{client}/settings | Requires (or stops requiring) an assignment: access.role:change. |
GET | /api/v1/directory/applications/{client}/sign-in-check | Sign in check of an application |
GET | /api/v1/directory/applications/{client}/sign-in-users | List the sign in users of an application |
GET | /api/v1/directory/export | Streams the caller's directory as JSON Lines. An error before the first record is written as an error response; after it, the stream ends early and the error is in the X-Directory-Export-Error trailer. |
GET | /api/v1/directory/groups | List groups |
POST | /api/v1/directory/groups | Create a group |
GET | /api/v1/directory/groups:lookup | Lookup groups |
POST | /api/v1/directory/groups:validateRule | Validate rule groups |
GET | /api/v1/directory/groups/{id} | Get one group |
PATCH | /api/v1/directory/groups/{id} | Changes a group. Saving the rule of a dynamic group whose members are administrators is re-verified as admin:grant. |
DELETE | /api/v1/directory/groups/{id} | Delete one group |
GET | /api/v1/directory/groups/{id}/effective-members | List the effective members of a group |
GET | /api/v1/directory/groups/{id}/members | List the members of a group |
POST | /api/v1/directory/groups/{id}/members | Re-verifies the change first: admin:grant when the group's members are administrators (two factors, a person), access.role:change otherwise. The use case checks admin:grant again in its own transaction. |
DELETE | /api/v1/directory/groups/{id}/members/{type}/{principal} | Delete one {type} |
GET | /api/v1/directory/groups/{id}/usage | Usage of a group |
POST | /api/v1/directory/import | Create an import |
GET | /api/v1/directory/me/nodes | List nodes |
GET | /api/v1/directory/me/projects | List projects |
GET | /api/v1/directory/me/teams | List teams |
GET | /api/v1/directory/nodes | List nodes |
POST | /api/v1/directory/nodes | Create a node |
POST | /api/v1/directory/nodes:batchCreate | Batch create nodes |
POST | /api/v1/directory/nodes:batchMove | Batch move nodes |
GET | /api/v1/directory/nodes:lookup | Lookup nodes |
GET | /api/v1/directory/nodes:search | Search nodes |
GET | /api/v1/directory/nodes/{id} | Get one node |
PATCH | /api/v1/directory/nodes/{id} | Update one node |
DELETE | /api/v1/directory/nodes/{id} | Delete one node |
GET | /api/v1/directory/nodes/{id}/ancestors | List the ancestors of a node |
GET | /api/v1/directory/nodes/{id}/children | Children of a node |
GET | /api/v1/directory/nodes/{id}/members | List the members of a node |
POST | /api/v1/directory/nodes/{id}/members | Create a member for a node |
PATCH | /api/v1/directory/nodes/{id}/members/{type}/{principal} | Update one {type} |
DELETE | /api/v1/directory/nodes/{id}/members/{type}/{principal} | Delete one {type} |
GET | /api/v1/directory/nodes/{id}/memberships | List the memberships of a node |
GET | /api/v1/directory/nodes/{id}/subtree | Subtree of a node |
POST | /api/v1/directory/nodes/{ref} | Archive and :restore. |
GET | /api/v1/directory/people | List people |
GET | /api/v1/directory/people/{id} | Get one people |
PATCH | /api/v1/directory/people/{id} | Changes a profile. An edit that makes the person match a dynamic group whose members are administrators is re-verified as admin:grant. |
DELETE | /api/v1/directory/people/{id} | Removes a person from the organization: re-verified as admin:revoke. |
GET | /api/v1/directory/people/{id}/accounts | List the accounts of a people |
GET | /api/v1/directory/people/{id}/factors | List the factors of a people |
GET | /api/v1/directory/people/{id}/groups | List the groups of a people |
GET | /api/v1/directory/people/{id}/nodes | List the nodes of a people |
GET | /api/v1/directory/people/{id}/sessions | List the sessions of a people |
GET | /api/v1/directory/people/{id}/sign-ins | List the sign ins of a people |
POST | /api/v1/directory/people/{ref} | Serves :suspend (admin:revoke), :restore (access.role:change) and :revokeSessions (protective, no re-verification). |
GET | /api/v1/directory/principals/{type}/{principal}/groups | List the groups of a {type} |
GET | /api/v1/directory/projects:byRepository | By repository projects |
GET | /api/v1/directory/service-accounts | List service accounts |
POST | /api/v1/directory/service-accounts | Create a service account |
GET | /api/v1/directory/service-accounts/{id} | Get one service account |
PATCH | /api/v1/directory/service-accounts/{id} | Update one service account |
DELETE | /api/v1/directory/service-accounts/{id} | Delete one service account |
GET | /api/v1/directory/service-accounts/{id}/credentials | List the credentials of a service account |
POST | /api/v1/directory/service-accounts/{id}/credentials | Create a credential for a service account |
DELETE | /api/v1/directory/service-accounts/{id}/credentials/{link} | Delete one credential |
POST | /api/v1/directory/service-accounts/{id}/credentials/{link}/revoke | Revokes a key at once: credential:revoke (protective; machines allowed). |
POST | /api/v1/directory/service-accounts/{id}/credentials/{link}/rotate | Mints a successor and retires the old key: credential:rotate. |
POST | /api/v1/directory/service-accounts/{id}/credentials/issue | Mints an API key the service account owns: credential:create, the secret in this answer only. |
POST | /api/v1/directory/service-accounts/{ref} | And :enable. |
GET | /api/v1/groups/{id} | Get one group |
PUT | /api/v1/groups/{id} | Replace one group |
DELETE | /api/v1/groups/{id} | Delete one group |
GET | /api/v1/groups/{id}/members | List the members of a group |
POST | /api/v1/groups/{id}/members | Create a member for a group |
DELETE | /api/v1/groups/{id}/members/{user_id} | Delete one member |
POST | /api/v1/invitations/{token}/accept | Records that the signed-in caller accepted an invitation (a share record; it grants no access to the workspace). |
GET | /api/v1/organizations | List organizations |
POST | /api/v1/organizations | Create an organization |
GET | /api/v1/organizations/{id} | Get one organization |
PUT | /api/v1/organizations/{id} | Replace one organization |
DELETE | /api/v1/organizations/{id} | Delete one organization |
GET | /api/v1/organizations/{id}/api-keys | List the api keys of an organization |
POST | /api/v1/organizations/{id}/api-keys | Mints a key in the organization. The creator is the authenticated principal, and the key's scopes must be within the principal's effective permissions there: a user's role permissions in the organization, or the scopes of the calling API key (403 otherwise). Super admins may grant any scope. |
DELETE | /api/v1/organizations/{id}/api-keys/{key_id} | Delete one api key |
GET | /api/v1/organizations/{id}/api-keys/scope-report | Lists the organization's live keys that hold scopes their creator does not hold (today), for an administrator to review; it changes nothing. |
GET | /api/v1/organizations/{id}/audit-logs | List the audit logs of an organization |
GET | /api/v1/organizations/{id}/branding | Branding of an organization |
PUT | /api/v1/organizations/{id}/branding | Set the branding of an organization |
GET | /api/v1/organizations/{id}/ldap | Ldap of an organization |
PUT | /api/v1/organizations/{id}/ldap | Set the ldap of an organization |
POST | /api/v1/organizations/{id}/ldap/authenticate | Create an authenticate |
GET | /api/v1/organizations/{id}/ldap/setup | Answers the LDAP presets and the walkthrough of one (?preset=, default active_directory). |
POST | /api/v1/organizations/{id}/ldap/sync | Syncs the organization's LDAP groups into the Directory and returns what changed. |
POST | /api/v1/organizations/{id}/ldap/test | Runs the staged connection test. A test that ran answers 200 with status ok or failed and the result's checks; a missing connection is 404. |
GET | /api/v1/organizations/{id}/members | List the members of an organization |
POST | /api/v1/organizations/{id}/members | Adds a member. The new member holds the Member role unless the request names another role the caller may grant; granting a privileged role (Admin, Owner, any role holding *:*) needs the caller to hold one and the admin:grant re-verification. The membership, its role binding and their audit events are one transaction. |
POST | /api/v1/organizations/{id}/members/{membership_id}/roles | Create a role for a member |
DELETE | /api/v1/organizations/{id}/members/{membership_id}/roles/{role_id} | Delete one role |
DELETE | /api/v1/organizations/{id}/members/{user_id} | Delete one member |
GET | /api/v1/organizations/{id}/password-policy | Password policy of an organization |
PUT | /api/v1/organizations/{id}/password-policy | Set the password policy of an organization |
GET | /api/v1/organizations/{id}/roles | List the roles of an organization |
POST | /api/v1/organizations/{id}/roles | Create a role for an organization |
GET | /api/v1/organizations/{id}/roles/{role_id} | Get one role |
PUT | /api/v1/organizations/{id}/roles/{role_id} | Replace one role |
DELETE | /api/v1/organizations/{id}/roles/{role_id} | Delete one role |
GET | /api/v1/organizations/{id}/secret-detections | Pages the hardcoded secret detections of AI-generated code, newest first: ?status filters; ?limit and ?cursor page. |
GET | /api/v1/organizations/{id}/secret-file-patterns | List the secret file patterns of an organization |
POST | /api/v1/organizations/{id}/secret-file-patterns | Create a secret file pattern for an organization |
PATCH | /api/v1/organizations/{id}/secret-file-patterns/{patternID} | Update one secret file pattern |
DELETE | /api/v1/organizations/{id}/secret-file-patterns/{patternID} | Delete one secret file pattern |
GET | /api/v1/organizations/{id}/secret-policies | List the secret policies of an organization |
POST | /api/v1/organizations/{id}/secret-policies | Answers the former access policy writes and evaluations. |
PATCH | /api/v1/organizations/{id}/secret-policies/{policyID} | Answers the former access policy writes and evaluations. |
DELETE | /api/v1/organizations/{id}/secret-policies/{policyID} | Answers the former access policy writes and evaluations. |
GET | /api/v1/organizations/{id}/secret-policies/evaluate | Answers the former access policy writes and evaluations. |
POST | /api/v1/organizations/{id}/secret-policies/evaluate | Answers the former access policy writes and evaluations. |
GET | /api/v1/organizations/{id}/secrets | Lists the organization's retired secrets: metadata and the vault path each value moved to, never a value. |
POST | /api/v1/organizations/{id}/secrets | Answers the former value writes (store, rotate): values are written to the vault. |
GET | /api/v1/organizations/{id}/secrets/{name} | Answers the former value route (GET .../secrets/{name}, agent API keys holding secrets:reveal). The value is in Vault, read under the vault's policies and grants. |
PATCH | /api/v1/organizations/{id}/secrets/{name} | Answers the former metadata writes (enable, describe, delete). |
DELETE | /api/v1/organizations/{id}/secrets/{name} | Answers the former metadata writes (enable, describe, delete). |
POST | /api/v1/organizations/{id}/secrets/{name}/rotate | Answers the former value writes (store, rotate): values are written to the vault. |
POST | /api/v1/organizations/{id}/secrets/access-tokens | Create an access token |
GET | /api/v1/organizations/{id}/secrets/audit | Pages the secret access log, newest first: ?secret_name, ?action, ?decision, ?agent_identity filter; ?limit (1-500, default 100) and ?cursor (next_cursor of the previous page) page. Every entry is also in the central audit log. |
POST | /api/v1/organizations/{id}/secrets/leases | Create a lease |
GET | /api/v1/organizations/{id}/signin-policy | Signin policy of an organization |
PUT | /api/v1/organizations/{id}/signin-policy | Set the signin policy of an organization |
GET | /api/v1/organizations/{id}/social | Social of an organization |
PUT | /api/v1/organizations/{id}/social/{provider} | Replace one social |
GET | /api/v1/organizations/{id}/social/{provider}/setup | Answers a provider's walkthrough. An unknown provider is 404. |
GET | /api/v1/organizations/{id}/webhooks | List the webhooks of an organization |
POST | /api/v1/organizations/{id}/webhooks | Create a webhook for an organization |
DELETE | /api/v1/organizations/{id}/webhooks/{webhook_id} | Delete one webhook |
POST | /api/v1/organizations/{id}/webhooks/test | Create a test |
GET | /api/v1/organizations/{org_id}/privacy-settings | Returns all privacy settings for an org. |
POST | /api/v1/organizations/{org_id}/privacy-settings | Creates a new privacy setting (for a specific data class or org default). |
GET | /api/v1/organizations/{org_id}/privacy-settings/{id} | Returns a specific privacy setting. |
PUT | /api/v1/organizations/{org_id}/privacy-settings/{id} | Updates a privacy setting. |
DELETE | /api/v1/organizations/{org_id}/privacy-settings/{id} | Deletes a privacy setting. |
GET | /api/v1/organizations/{org_id}/privacy-settings/agent-cache | Returns the privacy cache for agents to sync. |
POST | /api/v1/organizations/{org_id}/privacy-settings/apply-preset | Applies a preset template to an org. |
GET | /api/v1/organizations/{org_id}/privacy-settings/changes | Returns the change history for an org's privacy settings. |
POST | /api/v1/organizations/{org_id}/privacy-settings/changes/{change_id}/confirm | Confirms a pending loosening change. |
GET | /api/v1/organizations/{org_id}/scim/setup | Answers the SCIM walkthrough of one identity provider (?idp=, default entra_id). The route table requires scim:read; the caller must also belong to the organization (or be a super admin). It never carries a token: a token is shown once, when it is issued. |
GET | /api/v1/organizations/{org_id}/scim/status | Reports the organization's SCIM provisioning state. The route table requires scim:read; the caller must also belong to the organization (or be a super admin). |
GET | /api/v1/organizations/{org_id}/scim/tokens | Returns the organization's tokens' metadata, never a token or its hash. |
POST | /api/v1/organizations/{org_id}/scim/tokens | Issues a token. The plaintext is returned once. |
DELETE | /api/v1/organizations/{org_id}/scim/tokens/{token_id} | Revokes one of the organization's tokens. A token of another organization is 404, as is one that does not exist. |
GET | /api/v1/seats | List seats |
PUT | /api/v1/seats/assignments/{user_id} | Replace one assignment |
DELETE | /api/v1/seats/assignments/{user_id} | Delete one assignment |
GET | /api/v1/seats/group-rules | List group rules |
PUT | /api/v1/seats/group-rules/{group_id} | Replace one group rule |
DELETE | /api/v1/seats/group-rules/{group_id} | Delete one group rule |
POST | /api/v1/seats/group-rules/sync | Seats the members already in the ruled groups (a rule applies to people who join afterwards by itself). |
GET | /api/v1/seats/me | List me |
GET | /api/v1/seats/requests | List requests |
POST | /api/v1/seats/requests | Create a request |
POST | /api/v1/seats/requests/{id}/approve | Approve a request |
POST | /api/v1/seats/requests/{id}/decline | Decline a request |
GET | /api/v1/seats/settings | List settings |
PUT | /api/v1/seats/settings | Set settings |
GET | /api/v1/teams/{id} | Get one team |
PUT | /api/v1/teams/{id} | Replace one team |
DELETE | /api/v1/teams/{id} | Delete one team |
GET | /api/v1/teams/{team_id}/groups | List the groups of a team |
POST | /api/v1/teams/{team_id}/groups | Create a group for a team |
GET | /api/v1/users | List users |
POST | /api/v1/users | Create a user |
GET | /api/v1/users/{id} | Get one user |
PUT | /api/v1/users/{id} | Replace one user |
DELETE | /api/v1/users/{id} | Delete one user |
POST | /api/v1/users/{id}/mfa/reset | Create a reset |
GET | /api/v1/users/{id}/passkeys | List the passkeys of a user |
PATCH | /api/v1/users/{id}/passkeys/{credentialId} | Update one passkey |
DELETE | /api/v1/users/{id}/passkeys/{credentialId} | Delete one passkey |
POST | /api/v1/users/{id}/recovery-codes | Create a recovery code for a user |
GET | /api/v1/users/{id}/recovery-codes/count | List count |
POST | /api/v1/users/{id}/suspend | Suspend a user |
GET | /api/v1/users/{id}/totp | Totp of a user |
DELETE | /api/v1/users/{id}/totp | Delete the totp of a user |
POST | /api/v1/users/{id}/totp/enroll | Create an enroll |
POST | /api/v1/users/{id}/totp/verify | Create a verify |
POST | /api/v1/users/{id}/unsuspend | Unsuspend a user |
GET | /api/v1/users/{id}/workspace-quota | Workspace quota of a user |
PUT | /api/v1/users/{id}/workspace-quota | Set the workspace quota of a user |
DELETE | /api/v1/users/{id}/workspace-quota | Removes a member's workspace limits (org admins): the member falls back to the organization's defaults, unlimited where the organization sets none. |
GET | /api/v1/users/{userID}/quotas | List the quotas of a user |
GET | /api/v1/users/invitations | Lists the organization's pending (default) or expired invitations, newest first. Tokens are never returned. |
POST | /api/v1/users/invitations | Create an invitation |
POST | /api/v1/users/invitations/{id}/resend | Issues a new token for a pending or expired invitation (shown once; the previous token stops working) and resets its expiry. |
POST | /api/v1/users/invitations/{id}/revoke | Revokes a pending or expired invitation. |
GET | /api/v1/users/me | List me |
Endpoints
GET /api/v1/departments
List departments
- Permission
api:access- Response
- 200: Department
- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden; 404:not_found; 409:conflict; 503:unavailable
POST /api/v1/departments
Create a department
- Permission
api:access- Request body
- object
- Response
- 201: Department
- Errors
- 400:
invalid_body,validation_error; 401:unauthorized; 403:cross_org_forbidden,forbidden; 404:not_found; 409:conflict; 503:unavailable
GET /api/v1/departments/{dept_id}/teams
List the teams of a department
- Permission
api:access- Path parameters
dept_id- Response
- 200: Team
- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden; 404:not_found; 409:conflict; 503:unavailable
POST /api/v1/departments/{dept_id}/teams
Create a team for a department
GET /api/v1/departments/{id}
Get one department
- Permission
api:access- Path parameters
id- Response
- 200: Department
- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden; 404:not_found; 409:conflict; 503:unavailable
PUT /api/v1/departments/{id}
Replace one department
- Permission
api:access- Path parameters
id- Request body
- object
- Response
- 200: Department
- Errors
- 400:
invalid_body,validation_error; 401:unauthorized; 403:cross_org_forbidden,forbidden; 404:not_found; 409:conflict; 503:unavailable
DELETE /api/v1/departments/{id}
Delete one department
- Permission
api:access- Path parameters
id- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden,forbidden; 404:not_found; 409:conflict; 503:unavailable
GET /api/v1/directory/applications/{client}/assignments
List the assignments of an application
- Permission
directory.applications:read- Path parameters
client- Query parameters
page_size,page_token- Response
- 200: object of any
POST /api/v1/directory/applications/{client}/assignments
Create an assignment for an application
- Permission
directory.applications:manage- Path parameters
client- Request body
- AppAssignmentInput
- Response
- 201: AppAssignment
DELETE /api/v1/directory/applications/{client}/assignments/{type}/{principal}
Delete one {type}
- Permission
directory.applications:manage- Path parameters
client,type,principal
GET /api/v1/directory/applications/{client}/settings
Settings of an application
- Permission
directory.applications:read- Path parameters
client
PUT /api/v1/directory/applications/{client}/settings
Requires (or stops requiring) an assignment: access.role:change.
- Permission
directory.applications:manage- Path parameters
client- Request body
- PutAppSettingsInput
GET /api/v1/directory/applications/{client}/sign-in-check
Sign in check of an application
- Permission
directory.applications:read- Path parameters
client- Query parameters
user_id- Response
- 200: SignInCheck
GET /api/v1/directory/applications/{client}/sign-in-users
List the sign in users of an application
- Permission
directory.applications:read- Path parameters
client- Query parameters
page_size,page_token- Response
- 200: object of any
GET /api/v1/directory/export
Streams the caller's directory as JSON Lines. An error before the first record is written as an error response; after it, the stream ends early and the error is in the X-Directory-Export-Error trailer.
- Permission
directory:export
GET /api/v1/directory/groups
List groups
- Permission
directory.groups:read- Query parameters
filter,order_by,page_size,page_token- Response
- 200: groupList
POST /api/v1/directory/groups
Create a group
- Permission
directory.groups:manage- Request body
- CreateGroupInput
GET /api/v1/directory/groups:lookup
Lookup groups
- Permission
directory.groups:read- Query parameters
slug
POST /api/v1/directory/groups:validateRule
Validate rule groups
GET /api/v1/directory/groups/{id}
Get one group
- Permission
directory.groups:read- Path parameters
id
PATCH /api/v1/directory/groups/{id}
Changes a group. Saving the rule of a dynamic group whose members are administrators is re-verified as admin:grant.
- Permission
directory.groups:manage- Path parameters
id
DELETE /api/v1/directory/groups/{id}
Delete one group
- Permission
directory.groups:manage- Path parameters
id
GET /api/v1/directory/groups/{id}/effective-members
List the effective members of a group
- Permission
directory.groups:read- Path parameters
id- Query parameters
page_size,page_token- Response
- 200: principalList
GET /api/v1/directory/groups/{id}/members
List the members of a group
- Permission
directory.groups:read- Path parameters
id- Query parameters
page_size,page_token- Response
- 200: groupMemberList
POST /api/v1/directory/groups/{id}/members
Re-verifies the change first: admin:grant when the group's members are administrators (two factors, a person), access.role:change otherwise. The use case checks admin:grant again in its own transaction.
- Permission
directory.groups:manage- Path parameters
id- Request body
- GroupMemberInput
- Response
- 201: GroupMember
DELETE /api/v1/directory/groups/{id}/members/{type}/{principal}
Delete one {type}
- Permission
directory.groups:manage- Path parameters
id,type,principal
GET /api/v1/directory/groups/{id}/usage
Usage of a group
- Permission
directory.groups:read- Path parameters
id- Response
- 200: GroupUsage
POST /api/v1/directory/import
Create an import
- Permission
directory:import- Response
- 200: ImportReport
GET /api/v1/directory/me/nodes
List nodes
- Permission
directory.me:read
GET /api/v1/directory/me/projects
List projects
- Permission
directory.me:read
GET /api/v1/directory/me/teams
List teams
- Permission
directory.me:read
GET /api/v1/directory/nodes
List nodes
- Permission
directory.nodes:read- Query parameters
filter,order_by,page_size,page_token
POST /api/v1/directory/nodes
Create a node
- Permission
directory.nodes:create- Request body
- CreateNodeInput
POST /api/v1/directory/nodes:batchCreate
Batch create nodes
- Permission
directory.nodes:create- Request body
- batchCreateRequest
POST /api/v1/directory/nodes:batchMove
Batch move nodes
- Permission
directory.nodes:move
GET /api/v1/directory/nodes:lookup
Lookup nodes
- Permission
directory.nodes:read- Query parameters
path
GET /api/v1/directory/nodes:search
Search nodes
- Permission
directory.nodes:read- Query parameters
kind,page_size,page_token,q
GET /api/v1/directory/nodes/{id}
Get one node
- Permission
directory.nodes:read- Path parameters
id
PATCH /api/v1/directory/nodes/{id}
Update one node
- Permission
directory.nodes:update- Path parameters
id- Request body
- UpdateNodeInput
DELETE /api/v1/directory/nodes/{id}
Delete one node
- Permission
directory.nodes:delete- Path parameters
id
GET /api/v1/directory/nodes/{id}/ancestors
List the ancestors of a node
- Permission
directory.nodes:read- Path parameters
id
GET /api/v1/directory/nodes/{id}/children
Children of a node
- Permission
directory.nodes:read- Path parameters
id- Query parameters
filter,order_by,page_size,page_token
GET /api/v1/directory/nodes/{id}/members
List the members of a node
- Permission
directory.members:read- Path parameters
id- Query parameters
page_size,page_token- Response
- 200: memberList
POST /api/v1/directory/nodes/{id}/members
Create a member for a node
- Permission
directory.members:manage- Path parameters
id- Request body
- AddMemberInput
PATCH /api/v1/directory/nodes/{id}/members/{type}/{principal}
Update one {type}
- Permission
directory.members:manage- Path parameters
id,type,principal- Request body
- SetMemberRoleInput
- Response
- 200: Membership
DELETE /api/v1/directory/nodes/{id}/members/{type}/{principal}
Delete one {type}
- Permission
directory.members:manage- Path parameters
id,type,principal
GET /api/v1/directory/nodes/{id}/memberships
List the memberships of a node
- Permission
directory.members:read- Path parameters
id- Query parameters
page_size,page_token- Response
- 200: membershipList
GET /api/v1/directory/nodes/{id}/subtree
Subtree of a node
- Permission
directory.nodes:read- Path parameters
id- Query parameters
max_depth,page_size,page_token
POST /api/v1/directory/nodes/{ref}
Archive and :restore.
- Permission
directory.nodes:update- Path parameters
ref- Request body
- NodeEtagInput
GET /api/v1/directory/people
List people
- Permission
directory.people:read- Query parameters
page_size,page_token,q,source,status- Response
- 200: peopleList
GET /api/v1/directory/people/{id}
Get one people
- Permission
directory.people:read- Path parameters
id- Response
- 200: Person
PATCH /api/v1/directory/people/{id}
Changes a profile. An edit that makes the person match a dynamic group whose members are administrators is re-verified as admin:grant.
- Permission
directory.people:manage- Path parameters
id- Response
- 200: Person
DELETE /api/v1/directory/people/{id}
Removes a person from the organization: re-verified as admin:revoke.
- Permission
directory.people:manage- Path parameters
id
GET /api/v1/directory/people/{id}/accounts
List the accounts of a people
- Permission
directory.people:read- Path parameters
id- Response
- 200: object of any
GET /api/v1/directory/people/{id}/factors
List the factors of a people
- Permission
directory.people:read- Path parameters
id- Response
- 200: object of any
GET /api/v1/directory/people/{id}/groups
List the groups of a people
- Permission
directory.people:read- Path parameters
id- Response
- 200: groupList
GET /api/v1/directory/people/{id}/nodes
List the nodes of a people
- Permission
directory.people:read- Path parameters
id- Query parameters
page_size,page_token- Response
- 200: myNodeList
GET /api/v1/directory/people/{id}/sessions
List the sessions of a people
- Permission
directory.people:read- Path parameters
id- Query parameters
page_size,page_token- Response
- 200: object of any
GET /api/v1/directory/people/{id}/sign-ins
List the sign ins of a people
- Permission
directory.people:read- Path parameters
id- Query parameters
page_size,page_token- Response
- 200: object of any
POST /api/v1/directory/people/{ref}
Serves :suspend (admin:revoke), :restore (access.role:change) and :revokeSessions (protective, no re-verification).
- Permission
directory.people:manage- Path parameters
ref- Response
- 200: Person; 200: object of integer
GET /api/v1/directory/principals/{type}/{principal}/groups
List the groups of a {type}
- Permission
directory.groups:read- Path parameters
type,principal- Response
- 200: groupList
GET /api/v1/directory/projects:byRepository
By repository projects
- Permission
directory.nodes:read- Query parameters
repository
GET /api/v1/directory/service-accounts
List service accounts
- Permission
directory.serviceaccounts:read- Query parameters
filter,order_by,page_size,page_token- Response
- 200: accountList
POST /api/v1/directory/service-accounts
Create a service account
- Permission
directory.serviceaccounts:manage- Request body
- CreateServiceAccountInput
GET /api/v1/directory/service-accounts/{id}
Get one service account
- Permission
directory.serviceaccounts:read- Path parameters
id
PATCH /api/v1/directory/service-accounts/{id}
Update one service account
- Permission
directory.serviceaccounts:manage- Path parameters
id- Request body
- UpdateServiceAccountInput
DELETE /api/v1/directory/service-accounts/{id}
Delete one service account
- Permission
directory.serviceaccounts:manage- Path parameters
id
GET /api/v1/directory/service-accounts/{id}/credentials
List the credentials of a service account
- Permission
directory.serviceaccounts:read- Path parameters
id- Response
- 200: credentialList
POST /api/v1/directory/service-accounts/{id}/credentials
Create a credential for a service account
- Permission
directory.serviceaccounts:manage- Path parameters
id- Request body
- LinkCredentialInput
- Response
- 201: CredentialLink
DELETE /api/v1/directory/service-accounts/{id}/credentials/{link}
Delete one credential
- Permission
directory.serviceaccounts:manage- Path parameters
id,link
POST /api/v1/directory/service-accounts/{id}/credentials/{link}/revoke
Revokes a key at once: credential:revoke (protective; machines allowed).
- Permission
directory.serviceaccounts:manage- Path parameters
id,link- Response
- 200: CredentialLink
POST /api/v1/directory/service-accounts/{id}/credentials/{link}/rotate
Mints a successor and retires the old key: credential:rotate.
- Permission
directory.serviceaccounts:manage- Path parameters
id,link- Request body
- RotateCredentialInput
- Response
- 201: IssuedCredential
POST /api/v1/directory/service-accounts/{id}/credentials/issue
Mints an API key the service account owns: credential:create, the secret in this answer only.
- Permission
directory.serviceaccounts:manage- Path parameters
id- Request body
- IssueCredentialInput
- Response
- 201: IssuedCredential
POST /api/v1/directory/service-accounts/{ref}
And :enable.
- Permission
directory.serviceaccounts:manage- Path parameters
ref- Request body
- ServiceAccountEtagInput
GET /api/v1/groups/{id}
Get one group
- Permission
api:access- Path parameters
id- Response
- 200: Group
- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden; 404:not_found; 409:conflict; 503:unavailable
PUT /api/v1/groups/{id}
Replace one group
DELETE /api/v1/groups/{id}
Delete one group
- Permission
api:access- Path parameters
id- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden,forbidden; 404:not_found; 409:conflict; 503:unavailable
GET /api/v1/groups/{id}/members
List the members of a group
- Permission
directory.groups:read- Path parameters
id- Response
- 200: GroupMembership
- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden; 404:not_found; 409:conflict; 503:unavailable
POST /api/v1/groups/{id}/members
Create a member for a group
- Permission
api:access- Path parameters
id- Request body
- object
- Response
- 201: GroupMembership
- Errors
- 400:
invalid_body,validation_error; 401:unauthorized; 403:cross_org_forbidden,forbidden; 404:not_found; 409:conflict; 503:unavailable
DELETE /api/v1/groups/{id}/members/{user_id}
Delete one member
- Permission
api:access- Path parameters
id,user_id- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden,forbidden; 404:not_found; 409:conflict; 503:unavailable
POST /api/v1/invitations/{token}/accept
Records that the signed-in caller accepted an invitation (a share record; it grants no access to the workspace).
- Permission
api:access- Path parameters
token- Response
- 200: shareResponse
- Errors
- 400:
invalid_user_id; 401:unauthorized; 409:managed_by_build_lease; 503:audit_unavailable,unavailable
GET /api/v1/organizations
List organizations
- Permission
signed in- Response
- 200: object of any
- Errors
- 400:
invalid_query,validation_error; 403:elevation_required,forbidden; 404:not_found; 409:conflict; 503:unavailable
POST /api/v1/organizations
Create an organization
- Permission
organizations:create- Request body
- organizationRequest
- Response
- 201: CreatedOrganization; 201: Organization
- Errors
- 400:
invalid_json,validation_error; 403:elevation_required,forbidden; 404:not_found; 409:conflict; 415:content_type; 503:unavailable
GET /api/v1/organizations/{id}
Get one organization
- Permission
organizations:read- Path parameters
id- Response
- 200: Organization
- Errors
- 400:
validation_error; 403:elevation_required,forbidden; 404:not_found; 409:conflict; 503:unavailable
PUT /api/v1/organizations/{id}
Replace one organization
- Permission
organizations:update- Path parameters
id- Request body
- organizationRequest
- Response
- 200: Organization
- Errors
- 400:
invalid_json,validation_error; 403:elevation_required,forbidden; 404:not_found; 409:conflict; 415:content_type; 503:unavailable
DELETE /api/v1/organizations/{id}
Delete one organization
- Permission
account:close- Path parameters
id- Errors
- 400:
validation_error; 403:elevation_required,forbidden; 404:not_found; 409:conflict; 503:unavailable
GET /api/v1/organizations/{id}/api-keys
List the api keys of an organization
- Permission
apikeys:read- Path parameters
id- Response
- 200: object of any
- Errors
- 400:
validation_error; 401:unauthorized; 404:not_found; 409:conflict
POST /api/v1/organizations/{id}/api-keys
Mints a key in the organization. The creator is the authenticated principal, and the key's scopes must be within the principal's effective permissions there: a user's role permissions in the organization, or the scopes of the calling API key (403 otherwise). Super admins may grant any scope.
- Permission
apikeys:create- Path parameters
id- Request body
- apiKeyRequest
- Response
- 201: Created
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:forbidden; 404:not_found; 409:conflict; 415:content_type
DELETE /api/v1/organizations/{id}/api-keys/{key_id}
Delete one api key
- Permission
apikeys:delete- Path parameters
id,key_id- Errors
- 400:
validation_error; 401:unauthorized; 404:not_found; 409:conflict
GET /api/v1/organizations/{id}/api-keys/scope-report
Lists the organization's live keys that hold scopes their creator does not hold (today), for an administrator to review; it changes nothing.
- Permission
apikeys:read- Path parameters
id- Response
- 200: ScopeReport
- Errors
- 400:
validation_error; 401:unauthorized; 403:forbidden; 404:not_found; 409:conflict
GET /api/v1/organizations/{id}/audit-logs
List the audit logs of an organization
- Permission
audit:read- Path parameters
id- Query parameters
action,action_prefix,from,include_read_only,outcome,project_activity,project_id,resource_type,to- Errors
- 400:
invalid_query; 403:forbidden; 404:not_found; 503:unavailable
GET /api/v1/organizations/{id}/branding
Branding of an organization
- Permission
branding:read- Path parameters
id- Response
- 200: value
- Errors
- 400:
validation_error; 404:not_found; 409:conflict
PUT /api/v1/organizations/{id}/branding
Set the branding of an organization
- Permission
branding:update- Path parameters
id- Request body
- brandingRequest
- Response
- 200: value
- Errors
- 400:
invalid_json,validation_error; 404:not_found; 409:conflict; 415:content_type; 422:agent_display_name_reserved; 503:unavailable
GET /api/v1/organizations/{id}/ldap
Ldap of an organization
- Permission
ldap:read- Path parameters
id- Response
- 200: Config
- Errors
- 400:
validation_error; 401:invalid_credentials; 404:not_found; 502:ldap_error
PUT /api/v1/organizations/{id}/ldap
Set the ldap of an organization
- Permission
ldap:update- Path parameters
id- Request body
- ldapRequest
- Response
- 200: Config
- Errors
- 400:
invalid_json,validation_error; 401:invalid_credentials; 404:not_found; 415:content_type; 502:ldap_error
POST /api/v1/organizations/{id}/ldap/authenticate
Create an authenticate
- Permission
ldap:create- Path parameters
id- Request body
- ldapAuthRequest
- Response
- 200: User
- Errors
- 400:
invalid_json,validation_error; 401:invalid_credentials; 404:not_found; 415:content_type; 502:ldap_error
GET /api/v1/organizations/{id}/ldap/setup
Answers the LDAP presets and the walkthrough of one (?preset=, default active_directory).
- Permission
ldap:read- Path parameters
id- Query parameters
preset- Response
- 200: ldapSetup
- Errors
- 400:
validation_error
POST /api/v1/organizations/{id}/ldap/sync
Syncs the organization's LDAP groups into the Directory and returns what changed.
- Permission
ldap:create- Path parameters
id- Response
- 200: ReconcileReport
- Errors
- 400:
validation_error; 401:invalid_credentials; 404:not_found; 409:group_sync_conflict; 502:ldap_error; 503:unavailable
POST /api/v1/organizations/{id}/ldap/test
Runs the staged connection test. A test that ran answers 200 with status ok or failed and the result's checks; a missing connection is 404.
- Permission
ldap:create- Path parameters
id- Request body
- ldapTestRequest
- Response
- 200: object of any
- Errors
- 400:
invalid_json,validation_error; 401:invalid_credentials; 404:not_found; 415:content_type; 502:ldap_error
GET /api/v1/organizations/{id}/members
List the members of an organization
- Permission
organizations:read- Path parameters
id- Response
- 200: object of any
- Errors
- 400:
invalid_query,validation_error; 403:elevation_required,forbidden; 404:not_found; 409:conflict; 503:unavailable
POST /api/v1/organizations/{id}/members
Adds a member. The new member holds the Member role unless the request names another role the caller may grant; granting a privileged role (Admin, Owner, any role holding *:*) needs the caller to hold one and the admin:grant re-verification. The membership, its role binding and their audit events are one transaction.
- Permission
organizations:create- Path parameters
id- Request body
- memberRequest
- Response
- 201: object
- Errors
- 400:
invalid_json,validation_error; 403:elevation_required,forbidden; 404:not_found; 409:conflict; 415:content_type; 503:unavailable
POST /api/v1/organizations/{id}/members/{membership_id}/roles
Create a role for a member
- Permission
roles:create- Path parameters
id,membership_id- Request body
- roleAssignmentRequest
- Response
- 201: LegacyAssignment
- Errors
- 400:
invalid_json; 415:content_type
DELETE /api/v1/organizations/{id}/members/{membership_id}/roles/{role_id}
Delete one role
- Permission
roles:delete- Path parameters
id,membership_id,role_id
DELETE /api/v1/organizations/{id}/members/{user_id}
Delete one member
- Permission
organizations:delete- Path parameters
id,user_id- Errors
- 400:
validation_error; 403:elevation_required,forbidden; 404:not_found; 409:conflict; 503:unavailable
GET /api/v1/organizations/{id}/password-policy
Password policy of an organization
- Permission
organizations:read- Path parameters
id- Response
- 200: object of any
- Errors
- 400:
validation_error; 401:unauthorized; 403:forbidden; 503:temporarily_unavailable
PUT /api/v1/organizations/{id}/password-policy
Set the password policy of an organization
- Permission
organizations:update- Path parameters
id- Request body
- updatePolicyRequest
- Response
- 200: object of any
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:forbidden; 415:content_type; 503:temporarily_unavailable
GET /api/v1/organizations/{id}/roles
List the roles of an organization
- Permission
roles:read- Path parameters
id- Response
- 200: object of any
POST /api/v1/organizations/{id}/roles
Create a role for an organization
- Permission
roles:create- Path parameters
id- Request body
- roleRequest
- Response
- 201: RoleView
- Errors
- 400:
invalid_json; 415:content_type
GET /api/v1/organizations/{id}/roles/{role_id}
Get one role
- Permission
roles:read- Path parameters
id,role_id- Response
- 200: RoleView
PUT /api/v1/organizations/{id}/roles/{role_id}
Replace one role
- Permission
roles:update- Path parameters
id,role_id- Request body
- roleRequest
- Response
- 200: RoleView
- Errors
- 400:
invalid_json; 415:content_type
DELETE /api/v1/organizations/{id}/roles/{role_id}
Delete one role
- Permission
roles:delete- Path parameters
id,role_id
GET /api/v1/organizations/{id}/secret-detections
Pages the hardcoded secret detections of AI-generated code, newest first: ?status filters; ?limit and ?cursor page.
- Permission
secretsgov:read- Path parameters
id- Query parameters
cursor,limit,status- Response
- 200: object of any
- Errors
- 400:
hardcoded_secret,validation_error; 401:token_expired,token_revoked; 403:file_blocked,unauthorized; 404:not_found; 409:conflict; 503:secret_scan_failed
GET /api/v1/organizations/{id}/secret-file-patterns
List the secret file patterns of an organization
- Permission
secretsgov:read- Path parameters
id- Response
- 200: object of any
POST /api/v1/organizations/{id}/secret-file-patterns
Create a secret file pattern for an organization
- Permission
secretsgov:manage- Path parameters
id- Request body
- addFilePatternRequest
- Response
- 201: FilePattern
- Errors
- 400:
hardcoded_secret,invalid_json,validation_error; 401:token_expired,token_revoked; 403:file_blocked,unauthorized; 404:not_found; 409:conflict; 415:content_type; 503:secret_scan_failed
PATCH /api/v1/organizations/{id}/secret-file-patterns/{patternID}
Update one secret file pattern
- Permission
secretsgov:manage- Path parameters
id,patternID- Request body
- FilePatternInput
- Response
- 200: FilePattern
- Errors
- 400:
hardcoded_secret,invalid_json,validation_error; 401:token_expired,token_revoked; 403:file_blocked,unauthorized; 404:not_found; 409:conflict; 415:content_type; 503:secret_scan_failed
DELETE /api/v1/organizations/{id}/secret-file-patterns/{patternID}
Delete one secret file pattern
- Permission
secretsgov:manage- Path parameters
id,patternID- Errors
- 400:
hardcoded_secret,validation_error; 401:token_expired,token_revoked; 403:file_blocked,unauthorized; 404:not_found; 409:conflict; 503:secret_scan_failed
GET /api/v1/organizations/{id}/secret-policies
List the secret policies of an organization
- Permission
secretsgov:read- Path parameters
id- Response
- 200: object of any
POST /api/v1/organizations/{id}/secret-policies
Answers the former access policy writes and evaluations.
- Permission
secretsgov:manage- Path parameters
id- Errors
- 410:
secretsgov.retired
PATCH /api/v1/organizations/{id}/secret-policies/{policyID}
Answers the former access policy writes and evaluations.
- Permission
secretsgov:manage- Path parameters
id,policyID- Errors
- 410:
secretsgov.retired
DELETE /api/v1/organizations/{id}/secret-policies/{policyID}
Answers the former access policy writes and evaluations.
- Permission
secretsgov:manage- Path parameters
id,policyID- Errors
- 410:
secretsgov.retired
GET /api/v1/organizations/{id}/secret-policies/evaluate
Answers the former access policy writes and evaluations.
- Permission
secretsgov:read- Path parameters
id- Errors
- 410:
secretsgov.retired
POST /api/v1/organizations/{id}/secret-policies/evaluate
Answers the former access policy writes and evaluations.
- Permission
secretsgov:read- Path parameters
id- Errors
- 410:
secretsgov.retired
GET /api/v1/organizations/{id}/secrets
Lists the organization's retired secrets: metadata and the vault path each value moved to, never a value.
- Permission
secretsgov:read- Path parameters
id- Response
- 200: object of any
- Errors
- 400:
hardcoded_secret,validation_error; 401:token_expired,token_revoked; 403:file_blocked,unauthorized; 404:not_found; 409:conflict; 503:secret_scan_failed
POST /api/v1/organizations/{id}/secrets
Answers the former value writes (store, rotate): values are written to the vault.
- Permission
secretsgov:manage- Path parameters
id- Query parameters
environment- Errors
- 410:
secretsgov.retired
GET /api/v1/organizations/{id}/secrets/{name}
Answers the former value route (GET .../secrets/{name}, agent API keys holding secrets:reveal). The value is in Vault, read under the vault's policies and grants.
- Permission
secrets:reveal- Path parameters
id,name- Query parameters
environment- Errors
- 410:
secretsgov.retired
PATCH /api/v1/organizations/{id}/secrets/{name}
Answers the former metadata writes (enable, describe, delete).
- Permission
secretsgov:manage- Path parameters
id,name- Query parameters
environment- Errors
- 410:
secretsgov.retired
DELETE /api/v1/organizations/{id}/secrets/{name}
Answers the former metadata writes (enable, describe, delete).
- Permission
secretsgov:manage- Path parameters
id,name- Query parameters
environment- Errors
- 410:
secretsgov.retired
POST /api/v1/organizations/{id}/secrets/{name}/rotate
Answers the former value writes (store, rotate): values are written to the vault.
- Permission
secretsgov:manage- Path parameters
id,name- Query parameters
environment- Errors
- 410:
secretsgov.retired
POST /api/v1/organizations/{id}/secrets/access-tokens
Create an access token
- Permission
secretsgov:manage- Path parameters
id
GET /api/v1/organizations/{id}/secrets/audit
Pages the secret access log, newest first: ?secret_name, ?action, ?decision, ?agent_identity filter; ?limit (1-500, default 100) and ?cursor (next_cursor of the previous page) page. Every entry is also in the central audit log.
- Permission
secretsgov:read- Path parameters
id- Query parameters
action,agent_identity,cursor,decision,limit,secret_name- Response
- 200: object of any
- Errors
- 400:
hardcoded_secret,validation_error; 401:token_expired,token_revoked; 403:file_blocked,unauthorized; 404:not_found; 409:conflict; 503:secret_scan_failed
POST /api/v1/organizations/{id}/secrets/leases
Create a lease
- Permission
none- Path parameters
id
GET /api/v1/organizations/{id}/signin-policy
Signin policy of an organization
- Permission
organizations:read- Path parameters
id- Response
- 200: OrgPolicy
- Errors
- 401:
unauthorized; 403:forbidden,person_required; 404:not_found
PUT /api/v1/organizations/{id}/signin-policy
Set the signin policy of an organization
- Permission
organizations:update- Path parameters
id- Request body
- signInPolicyRequest
- Response
- 200: OrgPolicy
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:forbidden,mfa_required,person_required; 404:not_found; 409:policy_would_lock_out; 415:content_type
GET /api/v1/organizations/{id}/social
Social of an organization
- Permission
social:read- Path parameters
id- Response
- 200: object of any
- Errors
- 400:
validation_error; 404:not_found
PUT /api/v1/organizations/{id}/social/{provider}
Replace one social
- Permission
social:update- Path parameters
id,provider- Request body
- socialRequest
- Response
- 200: Config
- Errors
- 400:
invalid_json,validation_error; 404:not_found; 415:content_type
GET /api/v1/organizations/{id}/social/{provider}/setup
Answers a provider's walkthrough. An unknown provider is 404.
- Permission
social:read- Path parameters
id,provider- Response
- 200: socialSetup
- Errors
- 400:
validation_error; 404:not_found
GET /api/v1/organizations/{id}/webhooks
List the webhooks of an organization
- Permission
webhooks:read- Path parameters
id- Response
- 200: object of any
- Errors
- 400:
validation_error
POST /api/v1/organizations/{id}/webhooks
Create a webhook for an organization
- Permission
webhooks:create- Path parameters
id- Request body
- webhookRequest
- Errors
- 400:
invalid_json,validation_error; 415:content_type
DELETE /api/v1/organizations/{id}/webhooks/{webhook_id}
Delete one webhook
- Permission
webhooks:delete- Path parameters
id,webhook_id- Errors
- 400:
validation_error
POST /api/v1/organizations/{id}/webhooks/test
Create a test
- Permission
webhooks:create- Path parameters
id- Response
- 202: object of string
- Errors
- 400:
validation_error
GET /api/v1/organizations/{org_id}/privacy-settings
Returns all privacy settings for an org.
- Permission
organizations:read- Path parameters
org_id- Response
- 200: object of any
- Errors
- 400:
confirmation_required,counsel_required,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict
POST /api/v1/organizations/{org_id}/privacy-settings
Creates a new privacy setting (for a specific data class or org default).
- Permission
organizations:create- Path parameters
org_id- Request body
- createPrivacySettingRequest
- Response
- 201: Setting
- Errors
- 400:
confirmation_required,counsel_required,invalid_json,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict; 415:content_type
GET /api/v1/organizations/{org_id}/privacy-settings/{id}
Returns a specific privacy setting.
- Permission
organizations:read- Path parameters
org_id,id- Response
- 200: Setting
- Errors
- 400:
confirmation_required,counsel_required,invalid_id,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict
PUT /api/v1/organizations/{org_id}/privacy-settings/{id}
Updates a privacy setting.
- Permission
organizations:update- Path parameters
org_id,id- Request body
- UpdateRequest
- Response
- 200: Setting
- Errors
- 400:
confirmation_required,counsel_required,invalid_id,invalid_json,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict; 415:content_type
DELETE /api/v1/organizations/{org_id}/privacy-settings/{id}
Deletes a privacy setting.
- Permission
organizations:delete- Path parameters
org_id,id- Errors
- 400:
confirmation_required,counsel_required,invalid_id,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict
GET /api/v1/organizations/{org_id}/privacy-settings/agent-cache
Returns the privacy cache for agents to sync.
- Permission
organizations:read- Path parameters
org_id- Response
- 200: value
- Errors
- 400:
confirmation_required,counsel_required,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict
POST /api/v1/organizations/{org_id}/privacy-settings/apply-preset
Applies a preset template to an org.
- Permission
organizations:create- Path parameters
org_id- Request body
- ApplyPresetRequest
- Response
- 200: Setting
- Errors
- 400:
confirmation_required,counsel_required,invalid_json,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict; 415:content_type
GET /api/v1/organizations/{org_id}/privacy-settings/changes
Returns the change history for an org's privacy settings.
- Permission
organizations:read- Path parameters
org_id- Response
- 200: object of any
- Errors
- 400:
confirmation_required,counsel_required,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict
POST /api/v1/organizations/{org_id}/privacy-settings/changes/{change_id}/confirm
Confirms a pending loosening change.
- Permission
organizations:create- Path parameters
org_id,change_id- Request body
- confirmChangeRequest
- Response
- 200: object of any
- Errors
- 400:
confirmation_required,counsel_required,invalid_change_id,invalid_json,invalid_org_id,validation_error; 403:user_required; 404:not_found; 409:conflict; 415:content_type
GET /api/v1/organizations/{org_id}/scim/setup
Answers the SCIM walkthrough of one identity provider (?idp=, default entra_id). The route table requires scim:read; the caller must also belong to the organization (or be a super admin). It never carries a token: a token is shown once, when it is issued.
- Permission
scim:read- Path parameters
org_id- Query parameters
idp- Response
- 200: scimSetup
- Errors
- 400:
validation_error; 401:unauthorized; 403:forbidden; 404:not_found
GET /api/v1/organizations/{org_id}/scim/status
Reports the organization's SCIM provisioning state. The route table requires scim:read; the caller must also belong to the organization (or be a super admin).
- Permission
scim:read- Path parameters
org_id- Response
- 200: ProvisioningStatus
- Errors
- 401:
unauthorized; 403:forbidden; 404:not_found
GET /api/v1/organizations/{org_id}/scim/tokens
Returns the organization's tokens' metadata, never a token or its hash.
- Permission
scim:manage- Path parameters
org_id- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:forbidden; 404:not_found
POST /api/v1/organizations/{org_id}/scim/tokens
Issues a token. The plaintext is returned once.
- Permission
scim:manage- Path parameters
org_id- Request body
- scimTokenRequest
- Response
- 201: object of any
- Errors
- 400:
validation_error; 401:unauthorized; 403:forbidden; 404:not_found
DELETE /api/v1/organizations/{org_id}/scim/tokens/{token_id}
Revokes one of the organization's tokens. A token of another organization is 404, as is one that does not exist.
- Permission
scim:manage- Path parameters
org_id,token_id- Errors
- 401:
unauthorized; 403:forbidden; 404:not_found
GET /api/v1/seats
List seats
- Permission
seats:read- Response
- 200: object of any
- Errors
- 400:
invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed
PUT /api/v1/seats/assignments/{user_id}
Replace one assignment
- Permission
seats:assign- Path parameters
user_id- Request body
- seatAssignBody
- Response
- 200: Assignment
- Errors
- 400:
invalid_json,invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed; 413:too_large; 415:content_type
DELETE /api/v1/seats/assignments/{user_id}
Delete one assignment
- Permission
seats:assign- Path parameters
user_id- Request body
- seatDecisionBody
- Response
- 200: object of boolean
- Errors
- 400:
invalid_json,invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed; 413:too_large; 415:content_type
GET /api/v1/seats/group-rules
List group rules
- Permission
seats:read- Response
- 200: object of any
- Errors
- 400:
invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed
PUT /api/v1/seats/group-rules/{group_id}
Replace one group rule
- Permission
seats:assign- Path parameters
group_id- Request body
- seatAssignBody
- Response
- 200: GroupRule
- Errors
- 400:
invalid_json,invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed; 413:too_large; 415:content_type
DELETE /api/v1/seats/group-rules/{group_id}
Delete one group rule
- Permission
seats:assign- Path parameters
group_id- Request body
- seatDecisionBody
- Response
- 200: object of boolean
- Errors
- 400:
invalid_json,invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed; 413:too_large; 415:content_type
POST /api/v1/seats/group-rules/sync
Seats the members already in the ruled groups (a rule applies to people who join afterwards by itself).
- Permission
seats:assign- Response
- 200: SyncResult
- Errors
- 400:
invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed
GET /api/v1/seats/me
List me
- Permission
signed in- Response
- 200: object of any
- Errors
- 400:
invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed
GET /api/v1/seats/requests
List requests
- Permission
seats:read- Query parameters
status- Response
- 200: object of any
- Errors
- 400:
invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed
POST /api/v1/seats/requests
Create a request
- Permission
signed in- Request body
- seatRequestBody
- Response
- 201: SeatRequest
- Errors
- 400:
invalid_json,invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed; 413:too_large; 415:content_type
POST /api/v1/seats/requests/{id}/approve
Approve a request
- Permission
seats:decide- Path parameters
id
POST /api/v1/seats/requests/{id}/decline
Decline a request
- Permission
seats:decide- Path parameters
id
GET /api/v1/seats/settings
List settings
- Permission
seats:read- Response
- 200: Settings
- Errors
- 400:
invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed
PUT /api/v1/seats/settings
Set settings
- Permission
seats:assign- Request body
- seatSettingsBody
- Response
- 200: Settings
- Errors
- 400:
invalid_json,invalid_param,missing_param; 403:requester_cannot_decide; 404:not_found; 409:already_seated,audit_organization_required,no_free_seat,no_licence,request_closed; 413:too_large; 415:content_type
GET /api/v1/teams/{id}
Get one team
- Permission
api:access- Path parameters
id- Response
- 200: Team
- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden; 404:not_found; 409:conflict; 503:unavailable
PUT /api/v1/teams/{id}
Replace one team
DELETE /api/v1/teams/{id}
Delete one team
- Permission
api:access- Path parameters
id- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden,forbidden; 404:not_found; 409:conflict; 503:unavailable
GET /api/v1/teams/{team_id}/groups
List the groups of a team
- Permission
api:access- Path parameters
team_id- Response
- 200: Group
- Errors
- 400:
validation_error; 401:unauthorized; 403:cross_org_forbidden; 404:not_found; 409:conflict; 503:unavailable
POST /api/v1/teams/{team_id}/groups
Create a group for a team
GET /api/v1/users
List users
- Permission
users:read- Query parameters
after- Response
- 200: object of any
- Errors
- 400:
invalid_invitation,invalid_query,invitation_email_mismatch,validation_error; 403:registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 422:failed_precondition
POST /api/v1/users
Create a user
- Permission
none- Request body
- userRequest
- Response
- 201: User
- Errors
- 400:
invalid_invitation,invalid_json,invitation_email_mismatch,validation_error; 403:registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 415:content_type; 422:failed_precondition
GET /api/v1/users/{id}
Get one user
- Permission
users:read- Path parameters
id- Response
- 200: User
- Errors
- 400:
invalid_invitation,invitation_email_mismatch,validation_error; 403:registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 422:failed_precondition
PUT /api/v1/users/{id}
Replace one user
- Permission
users:update- Path parameters
id- Request body
- userRequest
- Response
- 200: User
- Errors
- 400:
invalid_invitation,invalid_json,invitation_email_mismatch,validation_error; 403:registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 415:content_type; 422:failed_precondition
DELETE /api/v1/users/{id}
Delete one user
- Permission
users:delete- Path parameters
id- Errors
- 400:
invalid_invitation,invitation_email_mismatch,validation_error; 403:registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 422:failed_precondition
POST /api/v1/users/{id}/mfa/reset
Create a reset
- Permission
signed in- Path parameters
id- Request body
- mfaResetRequest
- Response
- 200: MFAResetResult
- Errors
- 400:
invalid_json,validation_error; 403:forbidden,person_required; 404:not_found; 409:own_factors; 415:content_type; 503:temporarily_unavailable
GET /api/v1/users/{id}/passkeys
List the passkeys of a user
- Permission
signed in- Path parameters
id- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:forbidden,user_in_other_organization; 404:missing_permission,not_found,not_in_organization; 503:temporarily_unavailable
PATCH /api/v1/users/{id}/passkeys/{credentialId}
Update one passkey
- Permission
signed in- Path parameters
id,credentialId- Request body
- object
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:forbidden,user_in_other_organization; 404:missing_permission,not_found,not_in_organization; 415:content_type; 503:temporarily_unavailable
DELETE /api/v1/users/{id}/passkeys/{credentialId}
Delete one passkey
- Permission
signed in- Path parameters
id,credentialId- Errors
- 401:
unauthorized; 403:forbidden,user_in_other_organization; 404:missing_permission,not_found,not_in_organization; 503:temporarily_unavailable
POST /api/v1/users/{id}/recovery-codes
Create a recovery code for a user
- Permission
signed in- Path parameters
id- Request body
- object
- Response
- 200: object of any
- Errors
- 400:
invalid_json,invalid_request; 401:invalid_code,invalid_mfa,mfa_required,unauthorized; 403:forbidden,invalid_credentials; 415:content_type; 503:temporarily_unavailable
GET /api/v1/users/{id}/recovery-codes/count
List count
- Permission
signed in- Path parameters
id- Response
- 200: object of any
- Errors
- 401:
invalid_code,invalid_mfa,mfa_required,unauthorized; 403:forbidden,invalid_credentials; 503:temporarily_unavailable
POST /api/v1/users/{id}/suspend
Suspend a user
- Permission
users:create- Path parameters
id- Errors
- 400:
invalid_invitation,invitation_email_mismatch,validation_error; 403:registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 422:failed_precondition
GET /api/v1/users/{id}/totp
Totp of a user
- Permission
signed in- Path parameters
id- Response
- 200: Status
- Errors
- 400:
validation_error; 401:invalid_totp,unauthorized; 403:forbidden,invalid_credentials; 404:not_found; 409:already_enabled; 503:temporarily_unavailable
DELETE /api/v1/users/{id}/totp
Delete the totp of a user
- Permission
signed in- Path parameters
id- Request body
- object
- Errors
- 400:
invalid_json,validation_error; 401:invalid_totp,unauthorized; 403:forbidden,invalid_credentials; 404:not_found; 409:already_enabled; 415:content_type; 503:temporarily_unavailable
POST /api/v1/users/{id}/totp/enroll
Create an enroll
- Permission
signed in- Path parameters
id- Request body
- totpEnrollRequest
- Response
- 201: Enrollment
- Errors
- 400:
invalid_json,validation_error; 401:invalid_totp,unauthorized; 403:forbidden,invalid_credentials; 404:not_found; 409:already_enabled; 415:content_type; 503:temporarily_unavailable
POST /api/v1/users/{id}/totp/verify
Create a verify
- Permission
signed in- Path parameters
id- Request body
- totpVerifyRequest
- Response
- 200: Status
- Errors
- 400:
invalid_json,validation_error; 401:invalid_totp,unauthorized; 403:forbidden,invalid_credentials; 404:not_found; 409:already_enabled; 415:content_type; 503:temporarily_unavailable
POST /api/v1/users/{id}/unsuspend
Unsuspend a user
- Permission
users:create- Path parameters
id- Errors
- 400:
invalid_invitation,invitation_email_mismatch,validation_error; 403:registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 422:failed_precondition
GET /api/v1/users/{id}/workspace-quota
Workspace quota of a user
- Permission
signed in- Path parameters
id- Response
- 200: UserWorkspaceQuotaResponse
- Errors
- 400:
invalid_request; 401:unauthenticated; 403:iam_denied; 404:not_found; 503:service_unavailable
PUT /api/v1/users/{id}/workspace-quota
Set the workspace quota of a user
- Permission
signed in- Path parameters
id- Request body
- UserWorkspaceQuotaUpdateRequest
- Response
- 200: UserWorkspaceQuotaResponse
- Errors
- 400:
invalid_body,invalid_json,invalid_request; 401:unauthenticated; 403:iam_denied; 404:not_found; 503:audit_unavailable,service_unavailable
DELETE /api/v1/users/{id}/workspace-quota
Removes a member's workspace limits (org admins): the member falls back to the organization's defaults, unlimited where the organization sets none.
- Permission
signed in- Path parameters
id- Response
- 200: UserWorkspaceQuotaResponse
- Errors
- 401:
unauthenticated; 403:iam_denied; 404:not_found; 503:audit_unavailable,service_unavailable
GET /api/v1/users/{userID}/quotas
List the quotas of a user
- Permission
users:read- Path parameters
userID
GET /api/v1/users/invitations
Lists the organization's pending (default) or expired invitations, newest first. Tokens are never returned.
- Permission
users:read- Query parameters
after,organization_id,status- Response
- 200: object of any
- Errors
- 400:
invalid_invitation,invalid_query,invitation_email_mismatch,validation_error; 401:unauthorized; 403:forbidden,registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin,not_pending; 422:failed_precondition; 429:rate_limited,resend_limit_reached; 501:not_implemented; 503:audit_unavailable
POST /api/v1/users/invitations
Create an invitation
- Permission
users:create- Request body
- invitationRequest
- Response
- 201: InviteResult
- Errors
- 400:
invalid_invitation,invalid_json,invitation_email_mismatch,validation_error; 401:unauthorized; 403:forbidden,invitation_refused,registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 415:content_type; 422:failed_precondition; 503:unavailable
POST /api/v1/users/invitations/{id}/resend
Issues a new token for a pending or expired invitation (shown once; the previous token stops working) and resets its expiry.
- Permission
users:create- Path parameters
id- Query parameters
organization_id- Response
- 200: ResendResult
- Errors
- 400:
invalid_invitation,invitation_email_mismatch,validation_error; 401:unauthorized; 403:forbidden,registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin,not_pending; 422:failed_precondition; 429:rate_limited,resend_limit_reached; 501:not_implemented; 503:audit_unavailable
POST /api/v1/users/invitations/{id}/revoke
Revokes a pending or expired invitation.
- Permission
users:create- Path parameters
id- Query parameters
organization_id- Errors
- 400:
invalid_invitation,invitation_email_mismatch,validation_error; 401:unauthorized; 403:forbidden,registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin,not_pending; 422:failed_precondition; 429:rate_limited,resend_limit_reached; 501:not_implemented; 503:audit_unavailable
GET /api/v1/users/me
List me
- Permission
signed in- Response
- 200: User
- Errors
- 400:
invalid_invitation,invitation_email_mismatch,validation_error; 401:unauthorized; 403:registration_closed,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 422:failed_precondition
Objects
object
| Field | Type | Description |
|---|---|---|
current_password | string | |
code | string | |
recovery_code | string |
object
| Field | Type | Description |
|---|---|---|
name | string |
object
| Field | Type | Description |
|---|---|---|
name | string | |
slug | string | |
description | string |
object
| Field | Type | Description |
|---|---|---|
name | string | |
slug | string | |
description | string |
object
| Field | Type | Description |
|---|---|---|
rule | string |
object
| Field | Type | Description |
|---|---|---|
user_id | string |
object
| Field | Type | Description |
|---|---|---|
name | string | |
slug | string | |
description | string | |
kind | string | |
rule optional | JSON |
object
| Field | Type | Description |
|---|---|---|
current_password | string | |
totp | string | |
recovery_code | string |
object
| Field | Type | Description |
|---|---|---|
name | string | |
slug | string | |
description | string |
object
| Field | Type | Description |
|---|---|---|
name | string | |
slug | string | |
description | string |
object
| Field | Type | Description |
|---|---|---|
name | string | |
slug | string | |
description | string |
object
| Field | Type | Description |
|---|---|---|
membership_id | string | |
organization_id | string | |
membership_created_at | timestamp | |
user_id | string | |
email | string | |
display_name | string | |
email_verified_at optional | timestamp | |
suspended_at optional | timestamp | |
role_id | string | |
role_name | string |
LegacyAssignment
A role assignment in the deprecated API.
| Field | Type | Description |
|---|---|---|
id | string | |
membership_id | string | |
role_id | string | |
created_at | timestamp |
APIKey
| Field | Type | Description |
|---|---|---|
id | string | |
organization_id | string | |
created_by_user_id optional | string | |
created_by_api_key_id optional | string | Set on keys another API key created. |
name | string | |
key_prefix | string | |
scopes | array of string | |
expires_at optional | timestamp | |
last_used_at optional | timestamp | |
revoked_at optional | timestamp | |
created_at | timestamp | |
harness_runner optional | string | Set on harness eval runner keys ("org" or "platform"), which a super admin creates and which alone hold the harness:eval:submit scope. |
Created
| Field | Type | Description |
|---|---|---|
api_key | APIKey | |
key | string |
ScopeFinding
One live key of a scope report.
| Field | Type | Description |
|---|---|---|
api_key_id | string | |
name | string | |
key_prefix | string | |
scopes | array of string | |
created_by_user_id optional | string | |
created_by_api_key_id optional | string | |
reason | string | |
excess_scopes | array of string | |
created_at | timestamp | |
last_used_at optional | timestamp |
ScopeReport
| Field | Type | Description |
|---|---|---|
organization_id | string | |
generated_at | timestamp | |
checked_keys | integer | |
findings | array of ScopeFinding |
ImportCounts
ImportCounts counts what an import did with one record type.
| Field | Type | Description |
|---|---|---|
created | integer | |
updated | integer | |
unchanged | integer | |
skipped | integer |
ImportReport
The outcome of an import.
| Field | Type | Description |
|---|---|---|
records | integer | |
counts | object of ImportCounts | |
notes optional | array of string | Notes explains skipped records. |
Assignment
One person's seat in one Organization.
| Field | Type | Description |
|---|---|---|
organization_id | string | |
user_id | string | |
seat_type | string | |
source | string | |
assigned_at | timestamp |
GroupRule
One group's seat type.
| Field | Type | Description |
|---|---|---|
group_id | string | |
seat_type | string |
SeatRequest
A member's request for a seat.
| Field | Type | Description |
|---|---|---|
id | string | |
organization_id | string | |
user_id | string | |
seat_type | string | |
status | string | |
message optional | string | |
decided_by optional | string | |
decided_at optional | timestamp | |
created_at | timestamp |
Settings
An Organization's seat settings.
| Field | Type | Description |
|---|---|---|
auto_assign | boolean | |
auto_assign_type | string | |
reclaim_after_days optional | integer | |
reclaim_notice_days | integer |
SyncResult
SyncResult counts what one synchronisation did.
| Field | Type | Description |
|---|---|---|
assigned | integer | |
short | integer | Short counts the people a rule covers who got no seat for lack of one. |
released | integer | Released counts group-sourced seats given back. |
AddMemberInput
AddMemberInput puts a principal directly on a node.
| Field | Type | Description |
|---|---|---|
principal | PrincipalKey |
AppAssignment
AppAssignment assigns a user, group or node to an OAuth client.
| Field | Type | Description |
|---|---|---|
id | string | |
client_id | string | |
principal | PrincipalRef | |
creator_id optional | string | |
create_time | timestamp |
AppAssignmentInput
AppAssignmentInput adds or removes an assignment.
| Field | Type | Description |
|---|---|---|
principal | PrincipalKey |
BusinessUnitDetails
The attributes of a business unit node.
| Field | Type | Description |
|---|---|---|
legacy_slug | string | The slug the unit had as a department, or its node slug. |
suspended | boolean | |
subdomain optional | string | Subdomain and CustomDomain are managed by the subdomain resolver. |
custom_domain optional | string |
BusinessUnitDetailsInput
BusinessUnitDetailsInput sets business unit attributes.
| Field | Type | Description |
|---|---|---|
legacy_slug optional | string | |
suspended optional | boolean |
CreateGroupInput
CreateGroupInput creates an assigned or dynamic group.
| Field | Type | Description |
|---|---|---|
owner_node | string | The id or path of the owning node. |
slug | string | |
display_name | string | |
description | string | |
membership_type | string | |
rule optional | string | |
labels | object of string |
CreateNodeInput
CreateNodeInput creates a node.
| Field | Type | Description |
|---|---|---|
parent | string | The id or path of the parent node. |
kind | string | |
slug | string | |
display_name | string | |
description | string | |
labels | object of string | |
details optional | NodeDetailsInput |
CreateServiceAccountInput
CreateServiceAccountInput creates a service account.
| Field | Type | Description |
|---|---|---|
owner_node | string | |
owner_user_id | string | |
slug | string | |
display_name | string | |
description | string | |
labels | object of string |
CredentialLink
CredentialLink links an API key or OAuth client to a service account.
| Field | Type | Description |
|---|---|---|
id | string | |
service_account_id | string | |
type | string | |
credential_id | string | |
creator_id optional | string | |
create_time | timestamp | |
name optional | string | The state of a linked API key, in the service account's credential list: its name, its public prefix (never the secret), active, expired or revoked, and when. |
prefix optional | string | |
state optional | string | |
expire_time optional | timestamp | |
revoke_time optional | timestamp | |
last_used_time optional | timestamp |
GroupMember
A direct member of a group.
| Field | Type | Description |
|---|---|---|
id | string | ID identifies the membership row. |
group_id | string | |
member | PrincipalRef | |
origin | string | |
creator_id optional | string | |
create_time | timestamp |
GroupMemberInput
GroupMemberInput adds or removes a direct member of an assigned group.
| Field | Type | Description |
|---|---|---|
member | PrincipalKey |
GroupResource
A group as the API returns it.
| Field | Type | Description |
|---|---|---|
name | string | The AIP resource name, groups/{id}. |
id | string | |
org_id | string | |
slug | string | |
display_name | string | |
description | string | |
owner_node_id | string | |
owner_path | string | |
membership_type | string | |
rule optional | string | |
sync_source optional | string | |
external_id optional | string | |
labels | object of string | |
creator_id optional | string | |
create_time | timestamp | |
update_time | timestamp | |
last_sync_time optional | timestamp | |
revision | integer | |
etag | string |
GroupUsage
Where a group is used: what its members receive through it.
| Field | Type | Description |
|---|---|---|
group_id | string | |
grants_admin | boolean | |
role_bindings | array of UsageItem | |
permission_sets | array of UsageItem | |
policies | array of UsageItem | |
applications | array of UsageItem | |
nodes | array of UsageItem | |
parent_groups | array of UsageItem | |
truncated | boolean | True when a list was cut at MaxUsageItems. |
IssueCredentialInput
IssueCredentialInput mints a credential for a service account.
| Field | Type | Description |
|---|---|---|
name | string | |
expire_time optional | timestamp |
IssuedCredential
A credential just minted: Secret is shown this once and never stored.
| Field | Type | Description |
|---|---|---|
credential | CredentialLink | |
secret | string |
LinkCredentialInput
LinkCredentialInput links an API key or OAuth client to a service account.
| Field | Type | Description |
|---|---|---|
type | string | |
credential_id | string |
MemberSource
One way a principal belongs to a node.
| Field | Type | Description |
|---|---|---|
type | string | |
group_id optional | string | The group (a direct member of the node) through which the principal belongs, for SourceGroup. |
Membership
A direct membership of a principal on a node.
| Field | Type | Description |
|---|---|---|
id | string | |
node_id | string | |
node_kind | string | |
principal | PrincipalRef | |
creator_id optional | string | |
create_time | timestamp | |
legacy_project_role optional | string | The role of a legacy project membership, kept for brief 08 to fold into role bindings. |
role | string | Member, or owner for a user who owns the node (a team or project owner). |
etag | string |
MyNode
A node the caller belongs to.
| Field | Type | Description |
|---|---|---|
node | NodeResource | |
sources | array of MemberSource |
NodeDetails
The kind-specific attributes kept in the legacy detail tables. Exactly one field is set, for business units, teams and projects.
| Field | Type | Description |
|---|---|---|
business_unit optional | BusinessUnitDetails | |
team optional | TeamDetails | |
project optional | ProjectDetails |
NodeDetailsInput
NodeDetailsInput sets kind-specific attributes. Nil fields are left unchanged on update and take their defaults on create.
| Field | Type | Description |
|---|---|---|
business_unit optional | BusinessUnitDetailsInput | |
team optional | TeamDetailsInput | |
project optional | ProjectDetailsInput |
NodeEtagInput
NodeEtagInput names a node and, optionally, its expected etag.
| Field | Type | Description |
|---|---|---|
etag optional | string |
NodeMember
A principal that belongs to a node, with every way it does.
| Field | Type | Description |
|---|---|---|
principal | PrincipalRef | |
sources | array of MemberSource |
NodeResource
A node as the API returns it.
| Field | Type | Description |
|---|---|---|
name | string | The AIP resource name (the path). |
id | string | |
org_id | string | |
kind | string | |
parent_id optional | string | |
slug | string | |
display_name | string | |
description | string | |
labels | object of string | |
state | string | |
depth | integer | |
archive_root_id optional | string | The node whose archive archived this one (itself when it was archived directly). |
details optional | NodeDetails | |
creator_id optional | string | |
create_time | timestamp | |
update_time | timestamp | |
archive_time optional | timestamp | |
revision | integer | |
etag | string |
Nullable
A PATCH field that can be set, cleared (JSON null) or left out (Set is false).
| Field | Type | Description |
|---|---|---|
Set | boolean | |
Value optional | number |
Person
A member of the caller's organization as the Directory shows them.
| Field | Type | Description |
|---|---|---|
name | string | The resource name, people/{id}. |
id | string | |
email | string | |
display_name | string | |
job_title | string | |
department | string | |
cost_center | string | |
location | string | |
status | string | |
source | string | |
source_connection_id optional | string | The LDAP or SSO connection of an LDAP or JIT person. |
read_only_fields | array of string | The fields the person's source owns. |
mfa_enrolled | boolean | |
root | boolean | The account's root user: never suspended or removed through the Directory. |
join_time | timestamp | |
last_sign_in_time optional | timestamp | |
suspend_time optional | timestamp | |
actions | array of string |
PrincipalKey
PrincipalKey names a principal of the caller's organization in a request.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string |
PrincipalRef
PrincipalRef identifies a principal in explanations and API payloads.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string |
ProjectDetails
The attributes of a project node.
| Field | Type | Description |
|---|---|---|
legacy_slug | string | |
classification | string | |
compliance_frameworks | array of string | |
budget_usd optional | number | |
suspended | boolean | |
metadata | object of any | |
owner_team optional | string | The legacy free-text owner team; when the project sits under a team it is that team's slug. |
repositories | array of string | The repository identifiers bound to the project, sorted. A repository belongs to at most one project of the organization. |
ProjectDetailsInput
ProjectDetailsInput sets project attributes.
| Field | Type | Description |
|---|---|---|
legacy_slug optional | string | |
classification optional | string | |
compliance_frameworks optional | array of string | |
budget_usd | Nullable | |
suspended optional | boolean | |
metadata optional | object of any | |
owner_team optional | string | OwnerTeam sets the legacy free-text owner team of a project that is not under a team (the deprecated project routes). |
repositories optional | array of string | Repositories replaces the project's repositories; each is normalized with NormalizeRepository. |
PutAppSettingsInput
PutAppSettingsInput sets AppSettings.AssignmentRequired.
| Field | Type | Description |
|---|---|---|
assignment_required optional | boolean | |
etag optional | string |
ReconcileReport
The outcome of a full LDAP reconciliation.
| Field | Type | Description |
|---|---|---|
Created | integer | |
Updated | integer | |
Deleted | integer | |
Members | integer |
RotateCredentialInput
RotateCredentialInput mints a successor of a credential and retires it.
| Field | Type | Description |
|---|---|---|
overlap_seconds | integer | OverlapSeconds keeps the old credential working that long (0 to 86,400; 0 retires it at once). |
RuleCheck
The result of validating a dynamic group rule.
| Field | Type | Description |
|---|---|---|
valid | boolean | |
error optional | string |
ServiceAccountEtagInput
ServiceAccountEtagInput names a service account and, optionally, its expected etag.
| Field | Type | Description |
|---|---|---|
etag optional | string |
ServiceAccountResource
A service account as the API returns it.
| Field | Type | Description |
|---|---|---|
name | string | The AIP resource name, serviceAccounts/{id}. |
id | string | |
org_id | string | |
slug | string | |
display_name | string | |
description | string | |
owner_node_id | string | |
owner_path | string | |
owner_user_id optional | string | |
labels | object of string | |
disabled | boolean | |
disable_time optional | timestamp | |
creator_id optional | string | |
create_time | timestamp | |
update_time | timestamp | |
revision | integer | |
etag | string |
SetMemberRoleInput
SetMemberRoleInput makes a user member an owner of a node, or a plain member again.
| Field | Type | Description |
|---|---|---|
role | string |
SignInCheck
SignInCheck answers whether a person may sign in to an application now.
| Field | Type | Description |
|---|---|---|
client_id | string | |
user_id | string | |
assignment_required | boolean | |
allowed | boolean |
TeamDetails
The attributes of a team node.
| Field | Type | Description |
|---|---|---|
legacy_slug | string | |
department_id optional | string | The nearest business unit above the team. |
TeamDetailsInput
TeamDetailsInput sets team attributes.
| Field | Type | Description |
|---|---|---|
legacy_slug optional | string |
UpdateNodeInput
UpdateNodeInput changes a node; nil fields are left unchanged. Etag, when set, must be the node's current etag.
| Field | Type | Description |
|---|---|---|
slug optional | string | |
display_name optional | string | |
description optional | string | |
labels optional | object of string | |
details optional | NodeDetailsInput | |
etag optional | string |
UpdateServiceAccountInput
UpdateServiceAccountInput changes a service account; nil fields are left unchanged.
| Field | Type | Description |
|---|---|---|
owner_node optional | string | |
owner_user_id optional | string | |
slug optional | string | |
display_name optional | string | |
description optional | string | |
labels optional | object of string | |
etag optional | string |
UsageItem
One place a group is used.
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
detail optional | string | |
via_group_id optional | string | The group (one that contains this one) the use names, "" when it names this group. |
Department
A business unit node, in the shape of the deprecated department API. Slug is the department's legacy slug.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
name | string | |
slug | string | |
description optional | string | |
created_at | timestamp | |
updated_at | timestamp |
Group
A Directory group, in the shape of the deprecated hierarchy group API. TeamID is the owning team; Kind maps the membership type (assigned is "static", synced is "sync"); Rule is a dynamic group's CEL rule as a JSON string.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
team_id | string | |
name | string | |
slug | string | |
description optional | string | |
kind | string | "static" | "dynamic" | "sync" |
rule optional | JSON | |
created_at | timestamp | |
updated_at | timestamp |
GroupMembership
A user's direct membership of a group.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
group_id | string | |
user_id | string | |
created_at | timestamp |
Team
A team node. DepartmentID is the nearest business unit above it.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
department_id | string | |
name | string | |
slug | string | |
description optional | string | |
created_at | timestamp | |
updated_at | timestamp |
accountList
| Field | Type | Description |
|---|---|---|
service_accounts | array of ServiceAccountResource | |
next_page_token optional | string |
batchCreateRequest
| Field | Type | Description |
|---|---|---|
requests | array of CreateNodeInput |
credentialList
| Field | Type | Description |
|---|---|---|
credentials | array of CredentialLink |
groupList
| Field | Type | Description |
|---|---|---|
groups | array of GroupResource | |
next_page_token optional | string |
groupMemberList
| Field | Type | Description |
|---|---|---|
members | array of GroupMember | |
next_page_token optional | string |
memberList
| Field | Type | Description |
|---|---|---|
members | array of NodeMember | |
next_page_token optional | string |
membershipList
| Field | Type | Description |
|---|---|---|
memberships | array of Membership | |
next_page_token optional | string |
myNodeList
| Field | Type | Description |
|---|---|---|
nodes | array of MyNode | |
next_page_token optional | string |
peopleList
| Field | Type | Description |
|---|---|---|
people | array of Person | |
next_page_token optional | string |
principalList
| Field | Type | Description |
|---|---|---|
members | array of PrincipalRef | |
next_page_token optional | string |
Config
| Field | Type | Description |
|---|---|---|
id | string | |
organization_id | string | |
name | string | |
url | string | |
bind_dn | string | |
base_dn | string | |
user_filter | string | |
group_filter optional | string | |
group_base_dn optional | string | |
group_member_attribute optional | string | |
group_name_attribute optional | string | |
nested_groups | boolean | |
nested_group_max_depth optional | integer | |
username_attribute | string | |
email_attribute | string | |
display_name_attribute | string | |
attribute_mapping optional | object of string | |
sync_enabled | boolean | |
sync_interval_minutes optional | integer | |
last_sync_at optional | timestamp | |
start_tls | boolean | |
insecure_skip_verify | boolean | |
insecure_skip_verify_allowed | boolean | InsecureSkipVerifyAllowed says whether this deployment lets a connection skip certificate verification (development only); the console offers the option only then. |
insecure_skip_verify_refused | boolean | InsecureSkipVerifyRefused: the stored connection skips certificate verification outside development, so every test, sign-in and sync with it is refused until it is turned back on. |
enabled | boolean | |
bind_password_set | boolean | BindPasswordSet says whether a bind password is stored; the password itself is never returned. |
last_sync optional | SyncOutcome | How the last group sync ended; nil before the first sync. |
Preset
One directory's settings: Defaults are applied to the form (filters, attributes, TLS), Examples are shown as placeholders (the URL and the DNs are the customer's own).
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
defaults | PresetFields | |
examples | PresetFields |
PresetFields
A preset's connection settings, by the API's field names.
| Field | Type | Description |
|---|---|---|
url | string | |
bind_dn | string | |
base_dn | string | |
user_filter | string | |
username_attribute | string | |
email_attribute | string | |
display_name_attribute | string | |
start_tls | boolean | |
group_filter | string | |
group_base_dn | string | |
group_member_attribute | string | |
group_name_attribute | string |
SyncOutcome
How a connection's last group sync ended. Message is Sandscale's own wording of a failure, never the directory server's raw error.
| Field | Type | Description |
|---|---|---|
at | timestamp | |
status | string | |
message optional | string | |
last_succeeded_at optional | timestamp | |
groups_created | integer | |
groups_updated | integer | |
groups_deleted | integer | |
members | integer |
CreatedOrganization
A new organization and its owner.
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
slug | string | |
account_id | string | The 12-digit Account ID. |
home_region | string | The cell the organization lives in. The database sets it on insert and never changes it; nothing here writes it. |
product_line | string | |
created_at | timestamp | |
updated_at | timestamp | |
owner optional | OwnerResult |
Organization
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
slug | string | |
account_id | string | The 12-digit Account ID. |
home_region | string | The cell the organization lives in. The database sets it on insert and never changes it; nothing here writes it. |
product_line | string | |
created_at | timestamp | |
updated_at | timestamp |
OwnerResult
What happened to the named owner.
| Field | Type | Description |
|---|---|---|
status | string | "member" (the account now holds Owner) or "invited". |
role | string | |
user_id optional | string | |
email | string | |
membership_id optional | string | |
invitation_id optional | string | |
token optional | string | The invitation token, shown once |
expires_at optional | timestamp |
ApplyPresetRequest
ApplyPresetRequest applies a preset template to an org.
| Field | Type | Description |
|---|---|---|
preset_id | string | |
counsel_acknowledge | boolean | Must be true for presets requiring review |
notes optional | string |
Setting
Setting represents a privacy setting for an org (optionally scoped to data class).
| Field | Type | Description |
|---|---|---|
id | uuid | |
org_id | uuid | |
data_class optional | string | Nil = org-wide default |
capture_level | string | |
retention_days | integer | |
legal_basis | string | |
erasure_policy | string | |
depseudo_policy | string | |
export_mode | string | |
erasure_approvers | array of uuid | |
depseudo_approvers | array of uuid | |
preset_template optional | string | |
version | integer | |
created_by optional | uuid | |
created_at | timestamp | |
updated_by optional | uuid | |
updated_at | timestamp |
UpdateRequest
UpdateRequest represents a request to update privacy settings.
| Field | Type | Description |
|---|---|---|
capture_level optional | string | |
retention_days optional | integer | |
legal_basis optional | string | |
erasure_policy optional | string | |
depseudo_policy optional | string | |
export_mode optional | string | |
erasure_approvers optional | array of uuid | |
depseudo_approvers optional | array of uuid | |
confirmation_reason optional | string | For loosening changes |
UserWorkspaceQuotaLimitSource
UserWorkspaceQuotaLimitSource reports where each effective limit came from.
| Field | Type | Description |
|---|---|---|
max_workspaces_per_user | string | |
max_cpu_cores_per_user | string | |
max_memory_gb_per_user | string |
UserWorkspaceQuotaLimits
UserWorkspaceQuotaLimits reports effective per-user limits. Null means unlimited.
| Field | Type | Description |
|---|---|---|
max_workspaces_per_user optional | integer | |
max_cpu_cores_per_user optional | integer | |
max_memory_gb_per_user optional | integer |
UserWorkspaceQuotaResponse
The effective per-user workspace quota.
| Field | Type | Description |
|---|---|---|
user_id | string | |
usage | UserWorkspaceQuotaUsage | |
limits | UserWorkspaceQuotaLimits | |
source | UserWorkspaceQuotaLimitSource |
UserWorkspaceQuotaUpdateRequest
UserWorkspaceQuotaUpdateRequest replaces a user's org-scoped quota override. Null/omitted fields inherit the org-level per-user default.
| Field | Type | Description |
|---|---|---|
max_workspaces_per_user optional | integer | |
max_cpu_cores_per_user optional | integer | |
max_memory_gb_per_user optional | integer |
UserWorkspaceQuotaUsage
UserWorkspaceQuotaUsage reports current usage in the user's org bucket.
| Field | Type | Description |
|---|---|---|
workspaces | integer | |
cpu_cores | integer | |
memory_mb | integer | |
memory_gb | number |
IdentityProvider
One identity provider with a SCIM walkthrough.
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
ProvisioningCounts
The operations of a period by outcome.
| Field | Type | Description |
|---|---|---|
succeeded | integer | |
failed | integer |
ProvisioningOperation
One SCIM provisioning operation an identity provider made. It never carries the resource's attributes or the error text.
| Field | Type | Description |
|---|---|---|
operation | string | |
resource_type | string | |
status | string | |
at | timestamp |
ProvisioningStatus
The state of an organization's SCIM provisioning, computed from its tokens and its provisioning log.
| Field | Type | Description |
|---|---|---|
state | string | |
active_tokens | integer | |
tokens_expiring_soon | integer | |
last_request_at optional | timestamp | |
last_operation optional | ProvisioningOperation | |
last_24_hours | ProvisioningCounts | |
recent_operations | array of ProvisioningOperation |
FilePattern
FilePattern defines file patterns AI tools should not access.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id optional | string | |
pattern | string | |
pattern_type | string | |
category | string | |
action | string | |
severity | string | |
description optional | string | |
enabled | boolean | |
is_global | boolean | |
created_at | timestamp |
FilePatternInput
FilePatternInput creates (all required fields set) or changes (nil fields kept) a file pattern of the organization.
| Field | Type | Description |
|---|---|---|
pattern optional | string | |
pattern_type optional | string | |
category optional | string | |
action optional | string | |
severity optional | string | |
description optional | string | |
enabled optional | boolean |
RoleView
A role with its etag and whether it is privileged or grants roles.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id optional | string | Empty for built-in roles. |
builtin_key optional | string | |
account_role optional | string | Owner, admin or member for the organization's account roles of those names, and empty otherwise. |
name | string | |
description | string | |
permissions | array of string | |
composites | array of string | |
version | integer | |
created_at | timestamp | |
updated_at | timestamp | |
etag | string | |
privileged | boolean | |
grants_roles | boolean | |
scope optional | string | Set when the role was listed by scope (account or resource). |
owner_reserved | boolean | OwnerReserved reports whether the role holds the Owner-reserved actions: the account's Owner role only. |
holders optional | array of RoleHolder | Holders are, for an account role listed by scope, the principals bound to it on the organization node, when the caller may read bindings there. |
holders_shown optional | boolean |
Check
One staged check of a test.
| Field | Type | Description |
|---|---|---|
Key | string | Stable ("connect", "bind", "search_base"). |
Label | string | |
State | string | StatePassed, StateFailed, StateWaiting or StateSkipped (an earlier check failed, or the check does not apply). |
Code optional | string | Code names the Problem of a failed or waiting check. |
Detail optional | string | Sandscale's own wording of what it found, never a provider's raw error text. |
Field
One provider value to paste back into a Sandscale form field.
| Field | Type | Description |
|---|---|---|
Name | string | The Sandscale field it fills (the API's JSON name). |
Label | string | The Sandscale form's label. |
ProviderLabel | string | What the provider calls it ("Application (client) ID"). |
Guide
One integration variant's walkthrough.
| Field | Type | Description |
|---|---|---|
Integration | string | Integration names the integration ("scim", "social", "ldap", "dns", "sso"). |
Variant optional | string | The provider or preset ("entra_id", "okta", "active_directory"). |
Title | string | |
ProviderUi optional | string | ProviderUI names the console the click paths are in ("Microsoft Entra admin center"). |
ReviewedAt | string | The date (YYYY-MM-DD) the click paths were last checked against the provider's console and documentation. |
Steps | array of Step | |
Values | object of string | The Sandscale values the steps name, by source: only real values of the caller's configuration, absolute URLs. A source with no value yet is absent. |
Notes optional | array of Note | |
Verify optional | Verify | |
Problems optional | array of Problem | |
DocsPath optional | string | The generated public page, relative to the repository. |
Note
A notice next to the steps.
| Field | Type | Description |
|---|---|---|
Title | string | |
Text | string | |
Tone optional | string | "info" (empty) or "warning". |
Problem
One troubleshooting entry; a test result or the provider names it by Code.
| Field | Type | Description |
|---|---|---|
Code | string | |
Title | string | |
Cause | string | |
Fix | string | |
Settings optional | array of string | The provider settings to change, in order. |
Result
The one answer of every integration's test, so one console component renders them all: the overall state, the code of the first failing check (a Problem of the guide names the fix), Sandscale's own message and the staged checks in the order they ran.
| Field | Type | Description |
|---|---|---|
State | string | StatePassed, StateFailed or StateWaiting (nothing to fail yet, such as a SCIM token no identity provider has used). |
Code optional | string | |
Message | string | |
Checks | array of Check | |
TestedAt | timestamp | When Sandscale ran the checks. |
Step
One step of a walkthrough.
| Field | Type | Description |
|---|---|---|
Key | string | Stable within the guide ("register_app", "provisioning"). |
Where optional | string | |
WizardStep optional | string | Wizard names the Identity Center wizard step the step belongs to. |
Title | string | |
ClickPath optional | array of string | The path through the provider's console, one item per click. |
Values optional | array of Value | What to enter at the provider. |
PasteBack optional | array of Field | The provider's values to bring back into Sandscale. |
Text | string | Text says what to do there. |
Value
One value to enter at the provider: Source names a Sandscale value of Guide.Values (the console shows it with a copy button), Literal is a fixed value.
| Field | Type | Description |
|---|---|---|
Label | string | |
Source optional | string | |
Literal optional | string | |
Format optional | string | FormatText (empty), FormatCommand or FormatJSON. |
Secret optional | boolean | Secret: the value is shown once, when Sandscale issues it (a token); it is never in Guide.Values afterwards. |
Verify
Verify says how the administrator proves the connection works.
| Field | Type | Description |
|---|---|---|
Action | string | What the console offers: "TEST_CONNECTION", "WAIT_FOR_FIRST_REQUEST", "SIGN_IN", "CHECK_DNS". |
Label | string | |
Text | string | Text says what success looks like. |
OrgPolicy
An organization's stored policy.
| Field | Type | Description |
|---|---|---|
email_code_sign_in | boolean | EmailCodeSignIn allows signing in with an emailed code instead of the password. |
email_code_for_admins | boolean | EmailCodeForAdmins lets an administrator without multi-factor authentication finish a password sign-in with an emailed code instead of setting up an authenticator. |
admin_two_factors | boolean | AdminTwoFactors requires an administrator or root user who sets up multi-factor authentication at sign-in to set up two different factors (a passkey and an authenticator app) before continuing: "Not now" is not offered for the second. For a login it holds when any of its organizations requires it. |
mfa_required | string | |
allowed_factors | array of string | The factors that count; by default all three. Never without a passkey or an authenticator app. |
phishing_resistant_for | string | |
enrollment_grace_days | integer | How long a login a raised policy newly affects may still set up the factor it needs at sign-in (0 to 14, default 7). |
organization_id | string | |
updated_by optional | string | |
updated_at optional | timestamp |
Config
| Field | Type | Description |
|---|---|---|
id | string | |
organization_id | string | |
provider | string | |
client_id | string | |
tenant | string | |
enabled | boolean | |
allowed_email_domains | array of string | The email domains that may be linked to existing members or provisioned; JITProvisioning creates users (and adds members) at first sign-in. |
jit_provisioning | boolean | |
callback_url optional | string | The redirect URI Sandscale sends the provider for this connection: the one to register at the provider. Computed, never stored. |
RoleHolder
A principal bound to a role on a node, with the name the Access pages show for it.
| Field | Type | Description |
|---|---|---|
binding_id | string | |
role_id | string | |
principal_type | string | |
principal_id | string | |
display_name | string | |
email optional | string | |
state | string | |
conditional | boolean | |
expires_at optional | timestamp |
Enrollment
Enrollment contains setup information for a new TOTP factor.
| Field | Type | Description |
|---|---|---|
secret | string | |
secret_formatted | string | |
provisioning_uri | string | |
qr_code optional | string | |
algorithm | string | |
digits | integer | |
period | integer | |
expires_at | timestamp | |
backup_codes optional | array of string |
Status
Status represents the TOTP status for a user.
| Field | Type | Description |
|---|---|---|
enabled | boolean | |
enabled_at optional | timestamp | |
last_used_at optional | timestamp | |
failed_attempts optional | integer | |
locked_until optional | timestamp | |
recovery_code_count optional | integer |
Invitation
| Field | Type | Description |
|---|---|---|
id | string | |
organization_id | string | |
email | string | |
display_name | string | |
expires_at | timestamp | |
created_at | timestamp |
InvitationUser
The inviter of an invitation.
| Field | Type | Description |
|---|---|---|
id | string | |
email | string |
InvitationView
An invitation as administrators see it. It never contains the token.
| Field | Type | Description |
|---|---|---|
id | string | |
organization_id | string | |
email | string | |
display_name | string | |
invited_by optional | InvitationUser | |
status | string | |
created_at | timestamp | |
expires_at | timestamp | |
last_sent_at | timestamp | |
send_count | integer |
InviteResult
| Field | Type | Description |
|---|---|---|
invitation | Invitation | |
token | string |
ResendResult
A resent invitation and its new token (shown once).
| Field | Type | Description |
|---|---|---|
invitation | InvitationView | |
token | string |
User
The unified user representation used across NI Auth.
| Field | Type | Description |
|---|---|---|
id | string | Core API fields (always populated from DB) |
email | string | |
display_name | string | |
is_super_admin | boolean | |
email_verified_at optional | timestamp | |
suspended_at optional | timestamp | |
created_at | timestamp | |
updated_at | timestamp | |
username optional | string | Keycloak-compat / multi-realm fields (populated by federation/realm services) |
emailVerified optional | boolean | |
firstName optional | string | |
lastName optional | string | |
realmId optional | string | |
enabled optional | boolean | |
status optional | string | |
federationLink optional | string | |
serviceAccountClientId optional | string | |
attributes optional | object of array of string | |
requiredActions optional | array of string | |
groups optional | array of string | |
realmRoles optional | array of string | |
clientRoles optional | object of array of string | |
notBefore optional | integer | |
totp optional | boolean | |
disabledCredentialTypes optional | array of string | |
origin optional | string | |
temporaryLockExpiry optional | timestamp | |
failedLoginAttempts optional | integer | |
passwordLastChanged optional | timestamp | |
lastLoginTimestamp optional | timestamp | |
createdTimestamp optional | timestamp | |
updatedTimestamp optional | timestamp |
MFAResetResult
What a reset removed.
| Field | Type | Description |
|---|---|---|
user_id | string | |
factors | array of string | |
totp_removed | boolean | |
passkeys_removed | integer | |
recovery_codes_removed | integer | |
sessions_ended | integer | |
refresh_tokens_revoked | integer |
addFilePatternRequest
A file pattern create body. Omitted fields take their defaults (pattern_type glob, category custom, action block, severity high).
| Field | Type | Description |
|---|---|---|
pattern optional | string | |
pattern_type optional | string | |
category optional | string | |
action optional | string | |
severity optional | string | |
description optional | string | |
enabled optional | boolean | |
created_by optional | string | Accepted for compatibility; the caller is recorded |
apiKeyRequest
| Field | Type | Description |
|---|---|---|
name | string | |
created_by_user_id optional | string | Accepted only for compatibility: the creator is always the authenticated principal, and a different value is refused. |
scopes | array of string | |
expires_at optional | timestamp |
brandingRequest
| Field | Type | Description |
|---|---|---|
display_name optional | string | |
tagline optional | string | |
logo_url optional | string | |
favicon_url optional | string | |
primary_color optional | string | |
secondary_color optional | string | |
accent_color optional | string | |
background_color optional | string | |
text_color optional | string | |
font_family optional | string | |
border_radius optional | string | |
support_email optional | string | |
support_url optional | string | |
privacy_url optional | string | |
terms_url optional | string | |
agent_display_name optional | string |
confirmChangeRequest
| Field | Type | Description |
|---|---|---|
reason | string |
createPrivacySettingRequest
| Field | Type | Description |
|---|---|---|
data_class optional | string |
invitationRequest
InvitationRequest: the organization defaults to the caller's; only a super admin may invite into another organization. The inviter is always the caller.
| Field | Type | Description |
|---|---|---|
organization_id optional | string | |
email | string | |
display_name | string | |
role_id optional | string | The account role the invitee receives (an organization role such as Admin, or a built-in account role such as security_compliance or billing); empty means Member. The inviter must be able to grant it. |
ldapAuthRequest
| Field | Type | Description |
|---|---|---|
username | string | |
password | string |
ldapRequest
| Field | Type | Description |
|---|---|---|
name | string | |
url | string | |
bind_dn | string | |
bind_password | string | |
base_dn | string | |
user_filter | string | |
username_attribute | string | |
email_attribute | string | |
display_name_attribute | string | |
start_tls | boolean | |
insecure_skip_verify | boolean | |
enabled | boolean | |
group_filter | string | |
group_base_dn | string | |
group_member_attribute | string | |
group_name_attribute | string | |
sync_enabled | boolean | |
sync_interval_minutes | integer |
ldapSetup
| Field | Type | Description |
|---|---|---|
presets | array of Preset | |
preset | string | |
guide | Guide | The preset's walkthrough. |
ldapTestRequest
The optional body of the connection test: a sample login the user filter must find exactly once.
| Field | Type | Description |
|---|---|---|
username | string |
memberRequest
| Field | Type | Description |
|---|---|---|
user_id | string | |
role_id optional | string | RoleID or RoleName optionally names the role of the new member; the default is the organization's least-privilege Member role, never Admin. |
role_name optional | string |
mfaResetRequest
| Field | Type | Description |
|---|---|---|
reason | string | |
factors | array of string |
organizationRequest
| Field | Type | Description |
|---|---|---|
name | string | |
slug | string | |
owner_email optional | string | OwnerEmail or OwnerUserID (super admins, on create only) names the first owner. |
owner_user_id optional | string |
roleAssignmentRequest
| Field | Type | Description |
|---|---|---|
role_id | string |
roleRequest
| Field | Type | Description |
|---|---|---|
name | string | |
description | string | |
permissions | array of string |
scimSetup
| Field | Type | Description |
|---|---|---|
scim_base_url | string | The absolute SCIM base URL of this deployment. |
identity_providers | array of IdentityProvider | |
idp | string | |
guide | Guide | The identity provider's walkthrough. |
result | Result | The setup's staged checks, computed from the provisioning status. |
scimTokenRequest
| Field | Type | Description |
|---|---|---|
description | string | |
expires_in_days optional | integer | The token's lifetime in days: 90 when omitted, at most 365. |
seatAssignBody
| Field | Type | Description |
|---|---|---|
seat_type | string | |
reason | string |
seatDecisionBody
| Field | Type | Description |
|---|---|---|
reason | string |
seatRequestBody
| Field | Type | Description |
|---|---|---|
seat_type | string | |
message | string |
seatSettingsBody
| Field | Type | Description |
|---|---|---|
auto_assign | boolean | |
auto_assign_type | string | |
reclaim_after_days optional | integer | |
reclaim_notice_days | integer | |
reason | string |
shareResponse
| Field | Type | Description |
|---|---|---|
id | string | |
workspace_id | string | |
org_id | string | |
shared_with | string | |
role | string | |
expires_at optional | timestamp | |
created_by | string | |
created_at | timestamp |
signInPolicyRequest
| Field | Type | Description |
|---|---|---|
email_code_sign_in optional | boolean | |
email_code_for_admins optional | boolean | |
admin_two_factors optional | boolean | |
mfa_required optional | string | |
allowed_factors optional | array of string | |
phishing_resistant_for optional | string | |
enrollment_grace_days optional | integer |
socialRequest
| Field | Type | Description |
|---|---|---|
client_id | string | |
client_secret | string | |
tenant | string | |
enabled | boolean | |
allowed_email_domains | array of string | |
jit_provisioning optional | boolean |
socialSetup
| Field | Type | Description |
|---|---|---|
provider | string | |
callback_url | string | The redirect URI Sandscale sends the provider: the one to register. |
homepage_url | string | The deployment's public URL (GitHub asks for a homepage). |
guide | Guide | The provider's walkthrough. |
totpEnrollRequest
| Field | Type | Description |
|---|---|---|
account | string | |
current_password | string |
totpVerifyRequest
| Field | Type | Description |
|---|---|---|
code | string |
updatePolicyRequest
| Field | Type | Description |
|---|---|---|
min_length | integer | |
max_length | integer | |
require_uppercase | boolean | |
require_lowercase | boolean | |
require_digit | boolean | |
require_special | boolean | |
history_count | integer | |
max_age_days | integer | |
lockout_threshold | integer | |
lockout_duration_minutes | integer |
userRequest
| Field | Type | Description |
|---|---|---|
email | string | |
display_name | string | |
password | string | |
invitation_token optional | string | Required unless registration is open (NI_AUTH_REGISTRATION_MODE). |
product_line optional | string |
webhookRequest
| Field | Type | Description |
|---|---|---|
name | string | |
url | string | |
events | array of string |
This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.