API by area

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

MethodPathWhat it does
GET/api/v1/departmentsList departments
POST/api/v1/departmentsCreate a department
GET/api/v1/departments/{dept_id}/teamsList the teams of a department
POST/api/v1/departments/{dept_id}/teamsCreate 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}/assignmentsList the assignments of an application
POST/api/v1/directory/applications/{client}/assignmentsCreate an assignment for an application
DELETE/api/v1/directory/applications/{client}/assignments/{type}/{principal}Delete one {type}
GET/api/v1/directory/applications/{client}/settingsSettings of an application
PUT/api/v1/directory/applications/{client}/settingsRequires (or stops requiring) an assignment: access.role:change.
GET/api/v1/directory/applications/{client}/sign-in-checkSign in check of an application
GET/api/v1/directory/applications/{client}/sign-in-usersList the sign in users of an application
GET/api/v1/directory/exportStreams 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/groupsList groups
POST/api/v1/directory/groupsCreate a group
GET/api/v1/directory/groups:lookupLookup groups
POST/api/v1/directory/groups:validateRuleValidate 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-membersList the effective members of a group
GET/api/v1/directory/groups/{id}/membersList the members of a group
POST/api/v1/directory/groups/{id}/membersRe-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}/usageUsage of a group
POST/api/v1/directory/importCreate an import
GET/api/v1/directory/me/nodesList nodes
GET/api/v1/directory/me/projectsList projects
GET/api/v1/directory/me/teamsList teams
GET/api/v1/directory/nodesList nodes
POST/api/v1/directory/nodesCreate a node
POST/api/v1/directory/nodes:batchCreateBatch create nodes
POST/api/v1/directory/nodes:batchMoveBatch move nodes
GET/api/v1/directory/nodes:lookupLookup nodes
GET/api/v1/directory/nodes:searchSearch 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}/ancestorsList the ancestors of a node
GET/api/v1/directory/nodes/{id}/childrenChildren of a node
GET/api/v1/directory/nodes/{id}/membersList the members of a node
POST/api/v1/directory/nodes/{id}/membersCreate 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}/membershipsList the memberships of a node
GET/api/v1/directory/nodes/{id}/subtreeSubtree of a node
POST/api/v1/directory/nodes/{ref}Archive and :restore.
GET/api/v1/directory/peopleList 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}/accountsList the accounts of a people
GET/api/v1/directory/people/{id}/factorsList the factors of a people
GET/api/v1/directory/people/{id}/groupsList the groups of a people
GET/api/v1/directory/people/{id}/nodesList the nodes of a people
GET/api/v1/directory/people/{id}/sessionsList the sessions of a people
GET/api/v1/directory/people/{id}/sign-insList 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}/groupsList the groups of a {type}
GET/api/v1/directory/projects:byRepositoryBy repository projects
GET/api/v1/directory/service-accountsList service accounts
POST/api/v1/directory/service-accountsCreate 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}/credentialsList the credentials of a service account
POST/api/v1/directory/service-accounts/{id}/credentialsCreate 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}/revokeRevokes a key at once: credential:revoke (protective; machines allowed).
POST/api/v1/directory/service-accounts/{id}/credentials/{link}/rotateMints a successor and retires the old key: credential:rotate.
POST/api/v1/directory/service-accounts/{id}/credentials/issueMints 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}/membersList the members of a group
POST/api/v1/groups/{id}/membersCreate a member for a group
DELETE/api/v1/groups/{id}/members/{user_id}Delete one member
POST/api/v1/invitations/{token}/acceptRecords that the signed-in caller accepted an invitation (a share record; it grants no access to the workspace).
GET/api/v1/organizationsList organizations
POST/api/v1/organizationsCreate 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-keysList the api keys of an organization
POST/api/v1/organizations/{id}/api-keysMints 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-reportLists 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-logsList the audit logs of an organization
GET/api/v1/organizations/{id}/brandingBranding of an organization
PUT/api/v1/organizations/{id}/brandingSet the branding of an organization
GET/api/v1/organizations/{id}/ldapLdap of an organization
PUT/api/v1/organizations/{id}/ldapSet the ldap of an organization
POST/api/v1/organizations/{id}/ldap/authenticateCreate an authenticate
GET/api/v1/organizations/{id}/ldap/setupAnswers the LDAP presets and the walkthrough of one (?preset=, default active_directory).
POST/api/v1/organizations/{id}/ldap/syncSyncs the organization's LDAP groups into the Directory and returns what changed.
POST/api/v1/organizations/{id}/ldap/testRuns 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}/membersList the members of an organization
POST/api/v1/organizations/{id}/membersAdds 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}/rolesCreate 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-policyPassword policy of an organization
PUT/api/v1/organizations/{id}/password-policySet the password policy of an organization
GET/api/v1/organizations/{id}/rolesList the roles of an organization
POST/api/v1/organizations/{id}/rolesCreate 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-detectionsPages the hardcoded secret detections of AI-generated code, newest first: ?status filters; ?limit and ?cursor page.
GET/api/v1/organizations/{id}/secret-file-patternsList the secret file patterns of an organization
POST/api/v1/organizations/{id}/secret-file-patternsCreate 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-policiesList the secret policies of an organization
POST/api/v1/organizations/{id}/secret-policiesAnswers 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/evaluateAnswers the former access policy writes and evaluations.
POST/api/v1/organizations/{id}/secret-policies/evaluateAnswers the former access policy writes and evaluations.
GET/api/v1/organizations/{id}/secretsLists the organization's retired secrets: metadata and the vault path each value moved to, never a value.
POST/api/v1/organizations/{id}/secretsAnswers 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}/rotateAnswers the former value writes (store, rotate): values are written to the vault.
POST/api/v1/organizations/{id}/secrets/access-tokensCreate an access token
GET/api/v1/organizations/{id}/secrets/auditPages 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/leasesCreate a lease
GET/api/v1/organizations/{id}/signin-policySignin policy of an organization
PUT/api/v1/organizations/{id}/signin-policySet the signin policy of an organization
GET/api/v1/organizations/{id}/socialSocial of an organization
PUT/api/v1/organizations/{id}/social/{provider}Replace one social
GET/api/v1/organizations/{id}/social/{provider}/setupAnswers a provider's walkthrough. An unknown provider is 404.
GET/api/v1/organizations/{id}/webhooksList the webhooks of an organization
POST/api/v1/organizations/{id}/webhooksCreate a webhook for an organization
DELETE/api/v1/organizations/{id}/webhooks/{webhook_id}Delete one webhook
POST/api/v1/organizations/{id}/webhooks/testCreate a test
GET/api/v1/organizations/{org_id}/privacy-settingsReturns all privacy settings for an org.
POST/api/v1/organizations/{org_id}/privacy-settingsCreates 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-cacheReturns the privacy cache for agents to sync.
POST/api/v1/organizations/{org_id}/privacy-settings/apply-presetApplies a preset template to an org.
GET/api/v1/organizations/{org_id}/privacy-settings/changesReturns the change history for an org's privacy settings.
POST/api/v1/organizations/{org_id}/privacy-settings/changes/{change_id}/confirmConfirms a pending loosening change.
GET/api/v1/organizations/{org_id}/scim/setupAnswers 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/statusReports 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/tokensReturns the organization's tokens' metadata, never a token or its hash.
POST/api/v1/organizations/{org_id}/scim/tokensIssues 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/seatsList 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-rulesList 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/syncSeats the members already in the ruled groups (a rule applies to people who join afterwards by itself).
GET/api/v1/seats/meList me
GET/api/v1/seats/requestsList requests
POST/api/v1/seats/requestsCreate a request
POST/api/v1/seats/requests/{id}/approveApprove a request
POST/api/v1/seats/requests/{id}/declineDecline a request
GET/api/v1/seats/settingsList settings
PUT/api/v1/seats/settingsSet 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}/groupsList the groups of a team
POST/api/v1/teams/{team_id}/groupsCreate a group for a team
GET/api/v1/usersList users
POST/api/v1/usersCreate 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/resetCreate a reset
GET/api/v1/users/{id}/passkeysList 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-codesCreate a recovery code for a user
GET/api/v1/users/{id}/recovery-codes/countList count
POST/api/v1/users/{id}/suspendSuspend a user
GET/api/v1/users/{id}/totpTotp of a user
DELETE/api/v1/users/{id}/totpDelete the totp of a user
POST/api/v1/users/{id}/totp/enrollCreate an enroll
POST/api/v1/users/{id}/totp/verifyCreate a verify
POST/api/v1/users/{id}/unsuspendUnsuspend a user
GET/api/v1/users/{id}/workspace-quotaWorkspace quota of a user
PUT/api/v1/users/{id}/workspace-quotaSet the workspace quota of a user
DELETE/api/v1/users/{id}/workspace-quotaRemoves 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}/quotasList the quotas of a user
GET/api/v1/users/invitationsLists the organization's pending (default) or expired invitations, newest first. Tokens are never returned.
POST/api/v1/users/invitationsCreate an invitation
POST/api/v1/users/invitations/{id}/resendIssues 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}/revokeRevokes a pending or expired invitation.
GET/api/v1/users/meList 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

Permission
api:access
Path parameters
dept_id
Request body
object
Response
201: Team
Errors
400: invalid_body, validation_error; 401: unauthorized; 403: cross_org_forbidden, forbidden; 404: not_found; 409: conflict; 503: unavailable

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

Permission
directory.groups:manage
Request body
object
Response
200: RuleCheck

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

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 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

Permission
api:access
Path parameters
id
Request body
object
Response
200: Group
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}

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

Permission
api:access
Path parameters
id
Request body
object
Response
200: Team
Errors
400: invalid_body, validation_error; 401: unauthorized; 403: cross_org_forbidden, forbidden; 404: not_found; 409: conflict; 503: unavailable

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

Permission
api:access
Path parameters
team_id
Request body
object
Response
201: Group
Errors
400: invalid_body, validation_error; 401: unauthorized; 403: cross_org_forbidden, forbidden; 404: not_found; 409: conflict; 503: unavailable

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

FieldTypeDescription
current_passwordstring
codestring
recovery_codestring

object

FieldTypeDescription
namestring

object

FieldTypeDescription
namestring
slugstring
descriptionstring

object

FieldTypeDescription
namestring
slugstring
descriptionstring

object

FieldTypeDescription
rulestring

object

FieldTypeDescription
user_idstring

object

FieldTypeDescription
namestring
slugstring
descriptionstring
kindstring
rule optionalJSON

object

FieldTypeDescription
current_passwordstring
totpstring
recovery_codestring

object

FieldTypeDescription
namestring
slugstring
descriptionstring

object

FieldTypeDescription
namestring
slugstring
descriptionstring

object

FieldTypeDescription
namestring
slugstring
descriptionstring

object

FieldTypeDescription
membership_idstring
organization_idstring
membership_created_attimestamp
user_idstring
emailstring
display_namestring
email_verified_at optionaltimestamp
suspended_at optionaltimestamp
role_idstring
role_namestring

LegacyAssignment

A role assignment in the deprecated API.

FieldTypeDescription
idstring
membership_idstring
role_idstring
created_attimestamp

APIKey

FieldTypeDescription
idstring
organization_idstring
created_by_user_id optionalstring
created_by_api_key_id optionalstringSet on keys another API key created.
namestring
key_prefixstring
scopesarray of string
expires_at optionaltimestamp
last_used_at optionaltimestamp
revoked_at optionaltimestamp
created_attimestamp
harness_runner optionalstringSet on harness eval runner keys ("org" or "platform"), which a super admin creates and which alone hold the harness:eval:submit scope.

Created

FieldTypeDescription
api_keyAPIKey
keystring

ScopeFinding

One live key of a scope report.

FieldTypeDescription
api_key_idstring
namestring
key_prefixstring
scopesarray of string
created_by_user_id optionalstring
created_by_api_key_id optionalstring
reasonstring
excess_scopesarray of string
created_attimestamp
last_used_at optionaltimestamp

ScopeReport

FieldTypeDescription
organization_idstring
generated_attimestamp
checked_keysinteger
findingsarray of ScopeFinding

ImportCounts

ImportCounts counts what an import did with one record type.

FieldTypeDescription
createdinteger
updatedinteger
unchangedinteger
skippedinteger

ImportReport

The outcome of an import.

FieldTypeDescription
recordsinteger
countsobject of ImportCounts
notes optionalarray of stringNotes explains skipped records.

Assignment

One person's seat in one Organization.

FieldTypeDescription
organization_idstring
user_idstring
seat_typestring
sourcestring
assigned_attimestamp

GroupRule

One group's seat type.

FieldTypeDescription
group_idstring
seat_typestring

SeatRequest

A member's request for a seat.

FieldTypeDescription
idstring
organization_idstring
user_idstring
seat_typestring
statusstring
message optionalstring
decided_by optionalstring
decided_at optionaltimestamp
created_attimestamp

Settings

An Organization's seat settings.

FieldTypeDescription
auto_assignboolean
auto_assign_typestring
reclaim_after_days optionalinteger
reclaim_notice_daysinteger

SyncResult

SyncResult counts what one synchronisation did.

FieldTypeDescription
assignedinteger
shortintegerShort counts the people a rule covers who got no seat for lack of one.
releasedintegerReleased counts group-sourced seats given back.

AddMemberInput

AddMemberInput puts a principal directly on a node.

FieldTypeDescription
principalPrincipalKey

AppAssignment

AppAssignment assigns a user, group or node to an OAuth client.

FieldTypeDescription
idstring
client_idstring
principalPrincipalRef
creator_id optionalstring
create_timetimestamp

AppAssignmentInput

AppAssignmentInput adds or removes an assignment.

FieldTypeDescription
principalPrincipalKey

BusinessUnitDetails

The attributes of a business unit node.

FieldTypeDescription
legacy_slugstringThe slug the unit had as a department, or its node slug.
suspendedboolean
subdomain optionalstringSubdomain and CustomDomain are managed by the subdomain resolver.
custom_domain optionalstring

BusinessUnitDetailsInput

BusinessUnitDetailsInput sets business unit attributes.

FieldTypeDescription
legacy_slug optionalstring
suspended optionalboolean

CreateGroupInput

CreateGroupInput creates an assigned or dynamic group.

FieldTypeDescription
owner_nodestringThe id or path of the owning node.
slugstring
display_namestring
descriptionstring
membership_typestring
rule optionalstring
labelsobject of string

CreateNodeInput

CreateNodeInput creates a node.

FieldTypeDescription
parentstringThe id or path of the parent node.
kindstring
slugstring
display_namestring
descriptionstring
labelsobject of string
details optionalNodeDetailsInput

CreateServiceAccountInput

CreateServiceAccountInput creates a service account.

FieldTypeDescription
owner_nodestring
owner_user_idstring
slugstring
display_namestring
descriptionstring
labelsobject of string

CredentialLink links an API key or OAuth client to a service account.

FieldTypeDescription
idstring
service_account_idstring
typestring
credential_idstring
creator_id optionalstring
create_timetimestamp
name optionalstringThe 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 optionalstring
state optionalstring
expire_time optionaltimestamp
revoke_time optionaltimestamp
last_used_time optionaltimestamp

GroupMember

A direct member of a group.

FieldTypeDescription
idstringID identifies the membership row.
group_idstring
memberPrincipalRef
originstring
creator_id optionalstring
create_timetimestamp

GroupMemberInput

GroupMemberInput adds or removes a direct member of an assigned group.

FieldTypeDescription
memberPrincipalKey

GroupResource

A group as the API returns it.

FieldTypeDescription
namestringThe AIP resource name, groups/{id}.
idstring
org_idstring
slugstring
display_namestring
descriptionstring
owner_node_idstring
owner_pathstring
membership_typestring
rule optionalstring
sync_source optionalstring
external_id optionalstring
labelsobject of string
creator_id optionalstring
create_timetimestamp
update_timetimestamp
last_sync_time optionaltimestamp
revisioninteger
etagstring

GroupUsage

Where a group is used: what its members receive through it.

FieldTypeDescription
group_idstring
grants_adminboolean
role_bindingsarray of UsageItem
permission_setsarray of UsageItem
policiesarray of UsageItem
applicationsarray of UsageItem
nodesarray of UsageItem
parent_groupsarray of UsageItem
truncatedbooleanTrue when a list was cut at MaxUsageItems.

IssueCredentialInput

IssueCredentialInput mints a credential for a service account.

FieldTypeDescription
namestring
expire_time optionaltimestamp

IssuedCredential

A credential just minted: Secret is shown this once and never stored.

FieldTypeDescription
credentialCredentialLink
secretstring

LinkCredentialInput

LinkCredentialInput links an API key or OAuth client to a service account.

FieldTypeDescription
typestring
credential_idstring

MemberSource

One way a principal belongs to a node.

FieldTypeDescription
typestring
group_id optionalstringThe group (a direct member of the node) through which the principal belongs, for SourceGroup.

Membership

A direct membership of a principal on a node.

FieldTypeDescription
idstring
node_idstring
node_kindstring
principalPrincipalRef
creator_id optionalstring
create_timetimestamp
legacy_project_role optionalstringThe role of a legacy project membership, kept for brief 08 to fold into role bindings.
rolestringMember, or owner for a user who owns the node (a team or project owner).
etagstring

MyNode

A node the caller belongs to.

FieldTypeDescription
nodeNodeResource
sourcesarray of MemberSource

NodeDetails

The kind-specific attributes kept in the legacy detail tables. Exactly one field is set, for business units, teams and projects.

FieldTypeDescription
business_unit optionalBusinessUnitDetails
team optionalTeamDetails
project optionalProjectDetails

NodeDetailsInput

NodeDetailsInput sets kind-specific attributes. Nil fields are left unchanged on update and take their defaults on create.

FieldTypeDescription
business_unit optionalBusinessUnitDetailsInput
team optionalTeamDetailsInput
project optionalProjectDetailsInput

NodeEtagInput

NodeEtagInput names a node and, optionally, its expected etag.

FieldTypeDescription
etag optionalstring

NodeMember

A principal that belongs to a node, with every way it does.

FieldTypeDescription
principalPrincipalRef
sourcesarray of MemberSource

NodeResource

A node as the API returns it.

FieldTypeDescription
namestringThe AIP resource name (the path).
idstring
org_idstring
kindstring
parent_id optionalstring
slugstring
display_namestring
descriptionstring
labelsobject of string
statestring
depthinteger
archive_root_id optionalstringThe node whose archive archived this one (itself when it was archived directly).
details optionalNodeDetails
creator_id optionalstring
create_timetimestamp
update_timetimestamp
archive_time optionaltimestamp
revisioninteger
etagstring

Nullable

A PATCH field that can be set, cleared (JSON null) or left out (Set is false).

FieldTypeDescription
Setboolean
Value optionalnumber

Person

A member of the caller's organization as the Directory shows them.

FieldTypeDescription
namestringThe resource name, people/{id}.
idstring
emailstring
display_namestring
job_titlestring
departmentstring
cost_centerstring
locationstring
statusstring
sourcestring
source_connection_id optionalstringThe LDAP or SSO connection of an LDAP or JIT person.
read_only_fieldsarray of stringThe fields the person's source owns.
mfa_enrolledboolean
rootbooleanThe account's root user: never suspended or removed through the Directory.
join_timetimestamp
last_sign_in_time optionaltimestamp
suspend_time optionaltimestamp
actionsarray of string

PrincipalKey

PrincipalKey names a principal of the caller's organization in a request.

FieldTypeDescription
typestring
idstring

PrincipalRef

PrincipalRef identifies a principal in explanations and API payloads.

FieldTypeDescription
typestring
idstring

ProjectDetails

The attributes of a project node.

FieldTypeDescription
legacy_slugstring
classificationstring
compliance_frameworksarray of string
budget_usd optionalnumber
suspendedboolean
metadataobject of any
owner_team optionalstringThe legacy free-text owner team; when the project sits under a team it is that team's slug.
repositoriesarray of stringThe repository identifiers bound to the project, sorted. A repository belongs to at most one project of the organization.

ProjectDetailsInput

ProjectDetailsInput sets project attributes.

FieldTypeDescription
legacy_slug optionalstring
classification optionalstring
compliance_frameworks optionalarray of string
budget_usdNullable
suspended optionalboolean
metadata optionalobject of any
owner_team optionalstringOwnerTeam sets the legacy free-text owner team of a project that is not under a team (the deprecated project routes).
repositories optionalarray of stringRepositories replaces the project's repositories; each is normalized with NormalizeRepository.

PutAppSettingsInput

PutAppSettingsInput sets AppSettings.AssignmentRequired.

FieldTypeDescription
assignment_required optionalboolean
etag optionalstring

ReconcileReport

The outcome of a full LDAP reconciliation.

FieldTypeDescription
Createdinteger
Updatedinteger
Deletedinteger
Membersinteger

RotateCredentialInput

RotateCredentialInput mints a successor of a credential and retires it.

FieldTypeDescription
overlap_secondsintegerOverlapSeconds 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.

FieldTypeDescription
validboolean
error optionalstring

ServiceAccountEtagInput

ServiceAccountEtagInput names a service account and, optionally, its expected etag.

FieldTypeDescription
etag optionalstring

ServiceAccountResource

A service account as the API returns it.

FieldTypeDescription
namestringThe AIP resource name, serviceAccounts/{id}.
idstring
org_idstring
slugstring
display_namestring
descriptionstring
owner_node_idstring
owner_pathstring
owner_user_id optionalstring
labelsobject of string
disabledboolean
disable_time optionaltimestamp
creator_id optionalstring
create_timetimestamp
update_timetimestamp
revisioninteger
etagstring

SetMemberRoleInput

SetMemberRoleInput makes a user member an owner of a node, or a plain member again.

FieldTypeDescription
rolestring

SignInCheck

SignInCheck answers whether a person may sign in to an application now.

FieldTypeDescription
client_idstring
user_idstring
assignment_requiredboolean
allowedboolean

TeamDetails

The attributes of a team node.

FieldTypeDescription
legacy_slugstring
department_id optionalstringThe nearest business unit above the team.

TeamDetailsInput

TeamDetailsInput sets team attributes.

FieldTypeDescription
legacy_slug optionalstring

UpdateNodeInput

UpdateNodeInput changes a node; nil fields are left unchanged. Etag, when set, must be the node's current etag.

FieldTypeDescription
slug optionalstring
display_name optionalstring
description optionalstring
labels optionalobject of string
details optionalNodeDetailsInput
etag optionalstring

UpdateServiceAccountInput

UpdateServiceAccountInput changes a service account; nil fields are left unchanged.

FieldTypeDescription
owner_node optionalstring
owner_user_id optionalstring
slug optionalstring
display_name optionalstring
description optionalstring
labels optionalobject of string
etag optionalstring

UsageItem

One place a group is used.

FieldTypeDescription
idstring
namestring
detail optionalstring
via_group_id optionalstringThe 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.

FieldTypeDescription
idstring
org_idstring
namestring
slugstring
description optionalstring
created_attimestamp
updated_attimestamp

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.

FieldTypeDescription
idstring
org_idstring
team_idstring
namestring
slugstring
description optionalstring
kindstring"static" | "dynamic" | "sync"
rule optionalJSON
created_attimestamp
updated_attimestamp

GroupMembership

A user's direct membership of a group.

FieldTypeDescription
idstring
org_idstring
group_idstring
user_idstring
created_attimestamp

Team

A team node. DepartmentID is the nearest business unit above it.

FieldTypeDescription
idstring
org_idstring
department_idstring
namestring
slugstring
description optionalstring
created_attimestamp
updated_attimestamp

accountList

FieldTypeDescription
service_accountsarray of ServiceAccountResource
next_page_token optionalstring

batchCreateRequest

FieldTypeDescription
requestsarray of CreateNodeInput

credentialList

FieldTypeDescription
credentialsarray of CredentialLink

groupList

FieldTypeDescription
groupsarray of GroupResource
next_page_token optionalstring

groupMemberList

FieldTypeDescription
membersarray of GroupMember
next_page_token optionalstring

memberList

FieldTypeDescription
membersarray of NodeMember
next_page_token optionalstring

membershipList

FieldTypeDescription
membershipsarray of Membership
next_page_token optionalstring

myNodeList

FieldTypeDescription
nodesarray of MyNode
next_page_token optionalstring

peopleList

FieldTypeDescription
peoplearray of Person
next_page_token optionalstring

principalList

FieldTypeDescription
membersarray of PrincipalRef
next_page_token optionalstring

Config

FieldTypeDescription
idstring
organization_idstring
namestring
urlstring
bind_dnstring
base_dnstring
user_filterstring
group_filter optionalstring
group_base_dn optionalstring
group_member_attribute optionalstring
group_name_attribute optionalstring
nested_groupsboolean
nested_group_max_depth optionalinteger
username_attributestring
email_attributestring
display_name_attributestring
attribute_mapping optionalobject of string
sync_enabledboolean
sync_interval_minutes optionalinteger
last_sync_at optionaltimestamp
start_tlsboolean
insecure_skip_verifyboolean
insecure_skip_verify_allowedbooleanInsecureSkipVerifyAllowed says whether this deployment lets a connection skip certificate verification (development only); the console offers the option only then.
insecure_skip_verify_refusedbooleanInsecureSkipVerifyRefused: 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.
enabledboolean
bind_password_setbooleanBindPasswordSet says whether a bind password is stored; the password itself is never returned.
last_sync optionalSyncOutcomeHow 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).

FieldTypeDescription
idstring
namestring
defaultsPresetFields
examplesPresetFields

PresetFields

A preset's connection settings, by the API's field names.

FieldTypeDescription
urlstring
bind_dnstring
base_dnstring
user_filterstring
username_attributestring
email_attributestring
display_name_attributestring
start_tlsboolean
group_filterstring
group_base_dnstring
group_member_attributestring
group_name_attributestring

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.

FieldTypeDescription
attimestamp
statusstring
message optionalstring
last_succeeded_at optionaltimestamp
groups_createdinteger
groups_updatedinteger
groups_deletedinteger
membersinteger

CreatedOrganization

A new organization and its owner.

FieldTypeDescription
idstring
namestring
slugstring
account_idstringThe 12-digit Account ID.
home_regionstringThe cell the organization lives in. The database sets it on insert and never changes it; nothing here writes it.
product_linestring
created_attimestamp
updated_attimestamp
owner optionalOwnerResult

Organization

FieldTypeDescription
idstring
namestring
slugstring
account_idstringThe 12-digit Account ID.
home_regionstringThe cell the organization lives in. The database sets it on insert and never changes it; nothing here writes it.
product_linestring
created_attimestamp
updated_attimestamp

OwnerResult

What happened to the named owner.

FieldTypeDescription
statusstring"member" (the account now holds Owner) or "invited".
rolestring
user_id optionalstring
emailstring
membership_id optionalstring
invitation_id optionalstring
token optionalstringThe invitation token, shown once
expires_at optionaltimestamp

ApplyPresetRequest

ApplyPresetRequest applies a preset template to an org.

FieldTypeDescription
preset_idstring
counsel_acknowledgebooleanMust be true for presets requiring review
notes optionalstring

Setting

Setting represents a privacy setting for an org (optionally scoped to data class).

FieldTypeDescription
iduuid
org_iduuid
data_class optionalstringNil = org-wide default
capture_levelstring
retention_daysinteger
legal_basisstring
erasure_policystring
depseudo_policystring
export_modestring
erasure_approversarray of uuid
depseudo_approversarray of uuid
preset_template optionalstring
versioninteger
created_by optionaluuid
created_attimestamp
updated_by optionaluuid
updated_attimestamp

UpdateRequest

UpdateRequest represents a request to update privacy settings.

FieldTypeDescription
capture_level optionalstring
retention_days optionalinteger
legal_basis optionalstring
erasure_policy optionalstring
depseudo_policy optionalstring
export_mode optionalstring
erasure_approvers optionalarray of uuid
depseudo_approvers optionalarray of uuid
confirmation_reason optionalstringFor loosening changes

UserWorkspaceQuotaLimitSource

UserWorkspaceQuotaLimitSource reports where each effective limit came from.

FieldTypeDescription
max_workspaces_per_userstring
max_cpu_cores_per_userstring
max_memory_gb_per_userstring

UserWorkspaceQuotaLimits

UserWorkspaceQuotaLimits reports effective per-user limits. Null means unlimited.

FieldTypeDescription
max_workspaces_per_user optionalinteger
max_cpu_cores_per_user optionalinteger
max_memory_gb_per_user optionalinteger

UserWorkspaceQuotaResponse

The effective per-user workspace quota.

FieldTypeDescription
user_idstring
usageUserWorkspaceQuotaUsage
limitsUserWorkspaceQuotaLimits
sourceUserWorkspaceQuotaLimitSource

UserWorkspaceQuotaUpdateRequest

UserWorkspaceQuotaUpdateRequest replaces a user's org-scoped quota override. Null/omitted fields inherit the org-level per-user default.

FieldTypeDescription
max_workspaces_per_user optionalinteger
max_cpu_cores_per_user optionalinteger
max_memory_gb_per_user optionalinteger

UserWorkspaceQuotaUsage

UserWorkspaceQuotaUsage reports current usage in the user's org bucket.

FieldTypeDescription
workspacesinteger
cpu_coresinteger
memory_mbinteger
memory_gbnumber

IdentityProvider

One identity provider with a SCIM walkthrough.

FieldTypeDescription
idstring
namestring

ProvisioningCounts

The operations of a period by outcome.

FieldTypeDescription
succeededinteger
failedinteger

ProvisioningOperation

One SCIM provisioning operation an identity provider made. It never carries the resource's attributes or the error text.

FieldTypeDescription
operationstring
resource_typestring
statusstring
attimestamp

ProvisioningStatus

The state of an organization's SCIM provisioning, computed from its tokens and its provisioning log.

FieldTypeDescription
statestring
active_tokensinteger
tokens_expiring_sooninteger
last_request_at optionaltimestamp
last_operation optionalProvisioningOperation
last_24_hoursProvisioningCounts
recent_operationsarray of ProvisioningOperation

FilePattern

FilePattern defines file patterns AI tools should not access.

FieldTypeDescription
idstring
org_id optionalstring
patternstring
pattern_typestring
categorystring
actionstring
severitystring
description optionalstring
enabledboolean
is_globalboolean
created_attimestamp

FilePatternInput

FilePatternInput creates (all required fields set) or changes (nil fields kept) a file pattern of the organization.

FieldTypeDescription
pattern optionalstring
pattern_type optionalstring
category optionalstring
action optionalstring
severity optionalstring
description optionalstring
enabled optionalboolean

RoleView

A role with its etag and whether it is privileged or grants roles.

FieldTypeDescription
idstring
org_id optionalstringEmpty for built-in roles.
builtin_key optionalstring
account_role optionalstringOwner, admin or member for the organization's account roles of those names, and empty otherwise.
namestring
descriptionstring
permissionsarray of string
compositesarray of string
versioninteger
created_attimestamp
updated_attimestamp
etagstring
privilegedboolean
grants_rolesboolean
scope optionalstringSet when the role was listed by scope (account or resource).
owner_reservedbooleanOwnerReserved reports whether the role holds the Owner-reserved actions: the account's Owner role only.
holders optionalarray of RoleHolderHolders 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 optionalboolean

Check

One staged check of a test.

FieldTypeDescription
KeystringStable ("connect", "bind", "search_base").
Labelstring
StatestringStatePassed, StateFailed, StateWaiting or StateSkipped (an earlier check failed, or the check does not apply).
Code optionalstringCode names the Problem of a failed or waiting check.
Detail optionalstringSandscale'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.

FieldTypeDescription
NamestringThe Sandscale field it fills (the API's JSON name).
LabelstringThe Sandscale form's label.
ProviderLabelstringWhat the provider calls it ("Application (client) ID").

Guide

One integration variant's walkthrough.

FieldTypeDescription
IntegrationstringIntegration names the integration ("scim", "social", "ldap", "dns", "sso").
Variant optionalstringThe provider or preset ("entra_id", "okta", "active_directory").
Titlestring
ProviderUi optionalstringProviderUI names the console the click paths are in ("Microsoft Entra admin center").
ReviewedAtstringThe date (YYYY-MM-DD) the click paths were last checked against the provider's console and documentation.
Stepsarray of Step
Valuesobject of stringThe 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 optionalarray of Note
Verify optionalVerify
Problems optionalarray of Problem
DocsPath optionalstringThe generated public page, relative to the repository.

Note

A notice next to the steps.

FieldTypeDescription
Titlestring
Textstring
Tone optionalstring"info" (empty) or "warning".

Problem

One troubleshooting entry; a test result or the provider names it by Code.

FieldTypeDescription
Codestring
Titlestring
Causestring
Fixstring
Settings optionalarray of stringThe 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.

FieldTypeDescription
StatestringStatePassed, StateFailed or StateWaiting (nothing to fail yet, such as a SCIM token no identity provider has used).
Code optionalstring
Messagestring
Checksarray of Check
TestedAttimestampWhen Sandscale ran the checks.

Step

One step of a walkthrough.

FieldTypeDescription
KeystringStable within the guide ("register_app", "provisioning").
Where optionalstring
WizardStep optionalstringWizard names the Identity Center wizard step the step belongs to.
Titlestring
ClickPath optionalarray of stringThe path through the provider's console, one item per click.
Values optionalarray of ValueWhat to enter at the provider.
PasteBack optionalarray of FieldThe provider's values to bring back into Sandscale.
TextstringText 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.

FieldTypeDescription
Labelstring
Source optionalstring
Literal optionalstring
Format optionalstringFormatText (empty), FormatCommand or FormatJSON.
Secret optionalbooleanSecret: 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.

FieldTypeDescription
ActionstringWhat the console offers: "TEST_CONNECTION", "WAIT_FOR_FIRST_REQUEST", "SIGN_IN", "CHECK_DNS".
Labelstring
TextstringText says what success looks like.

OrgPolicy

An organization's stored policy.

FieldTypeDescription
email_code_sign_inbooleanEmailCodeSignIn allows signing in with an emailed code instead of the password.
email_code_for_adminsbooleanEmailCodeForAdmins lets an administrator without multi-factor authentication finish a password sign-in with an emailed code instead of setting up an authenticator.
admin_two_factorsbooleanAdminTwoFactors 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_requiredstring
allowed_factorsarray of stringThe factors that count; by default all three. Never without a passkey or an authenticator app.
phishing_resistant_forstring
enrollment_grace_daysintegerHow 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_idstring
updated_by optionalstring
updated_at optionaltimestamp

Config

FieldTypeDescription
idstring
organization_idstring
providerstring
client_idstring
tenantstring
enabledboolean
allowed_email_domainsarray of stringThe email domains that may be linked to existing members or provisioned; JITProvisioning creates users (and adds members) at first sign-in.
jit_provisioningboolean
callback_url optionalstringThe 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.

FieldTypeDescription
binding_idstring
role_idstring
principal_typestring
principal_idstring
display_namestring
email optionalstring
statestring
conditionalboolean
expires_at optionaltimestamp

Enrollment

Enrollment contains setup information for a new TOTP factor.

FieldTypeDescription
secretstring
secret_formattedstring
provisioning_uristring
qr_code optionalstring
algorithmstring
digitsinteger
periodinteger
expires_attimestamp
backup_codes optionalarray of string

Status

Status represents the TOTP status for a user.

FieldTypeDescription
enabledboolean
enabled_at optionaltimestamp
last_used_at optionaltimestamp
failed_attempts optionalinteger
locked_until optionaltimestamp
recovery_code_count optionalinteger

Invitation

FieldTypeDescription
idstring
organization_idstring
emailstring
display_namestring
expires_attimestamp
created_attimestamp

InvitationUser

The inviter of an invitation.

FieldTypeDescription
idstring
emailstring

InvitationView

An invitation as administrators see it. It never contains the token.

FieldTypeDescription
idstring
organization_idstring
emailstring
display_namestring
invited_by optionalInvitationUser
statusstring
created_attimestamp
expires_attimestamp
last_sent_attimestamp
send_countinteger

InviteResult

FieldTypeDescription
invitationInvitation
tokenstring

ResendResult

A resent invitation and its new token (shown once).

FieldTypeDescription
invitationInvitationView
tokenstring

User

The unified user representation used across NI Auth.

FieldTypeDescription
idstringCore API fields (always populated from DB)
emailstring
display_namestring
is_super_adminboolean
email_verified_at optionaltimestamp
suspended_at optionaltimestamp
created_attimestamp
updated_attimestamp
username optionalstringKeycloak-compat / multi-realm fields (populated by federation/realm services)
emailVerified optionalboolean
firstName optionalstring
lastName optionalstring
realmId optionalstring
enabled optionalboolean
status optionalstring
federationLink optionalstring
serviceAccountClientId optionalstring
attributes optionalobject of array of string
requiredActions optionalarray of string
groups optionalarray of string
realmRoles optionalarray of string
clientRoles optionalobject of array of string
notBefore optionalinteger
totp optionalboolean
disabledCredentialTypes optionalarray of string
origin optionalstring
temporaryLockExpiry optionaltimestamp
failedLoginAttempts optionalinteger
passwordLastChanged optionaltimestamp
lastLoginTimestamp optionaltimestamp
createdTimestamp optionaltimestamp
updatedTimestamp optionaltimestamp

MFAResetResult

What a reset removed.

FieldTypeDescription
user_idstring
factorsarray of string
totp_removedboolean
passkeys_removedinteger
recovery_codes_removedinteger
sessions_endedinteger
refresh_tokens_revokedinteger

addFilePatternRequest

A file pattern create body. Omitted fields take their defaults (pattern_type glob, category custom, action block, severity high).

FieldTypeDescription
pattern optionalstring
pattern_type optionalstring
category optionalstring
action optionalstring
severity optionalstring
description optionalstring
enabled optionalboolean
created_by optionalstringAccepted for compatibility; the caller is recorded

apiKeyRequest

FieldTypeDescription
namestring
created_by_user_id optionalstringAccepted only for compatibility: the creator is always the authenticated principal, and a different value is refused.
scopesarray of string
expires_at optionaltimestamp

brandingRequest

FieldTypeDescription
display_name optionalstring
tagline optionalstring
logo_url optionalstring
favicon_url optionalstring
primary_color optionalstring
secondary_color optionalstring
accent_color optionalstring
background_color optionalstring
text_color optionalstring
font_family optionalstring
border_radius optionalstring
support_email optionalstring
support_url optionalstring
privacy_url optionalstring
terms_url optionalstring
agent_display_name optionalstring

confirmChangeRequest

FieldTypeDescription
reasonstring

createPrivacySettingRequest

FieldTypeDescription
data_class optionalstring

invitationRequest

InvitationRequest: the organization defaults to the caller's; only a super admin may invite into another organization. The inviter is always the caller.

FieldTypeDescription
organization_id optionalstring
emailstring
display_namestring
role_id optionalstringThe 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

FieldTypeDescription
usernamestring
passwordstring

ldapRequest

FieldTypeDescription
namestring
urlstring
bind_dnstring
bind_passwordstring
base_dnstring
user_filterstring
username_attributestring
email_attributestring
display_name_attributestring
start_tlsboolean
insecure_skip_verifyboolean
enabledboolean
group_filterstring
group_base_dnstring
group_member_attributestring
group_name_attributestring
sync_enabledboolean
sync_interval_minutesinteger

ldapSetup

FieldTypeDescription
presetsarray of Preset
presetstring
guideGuideThe preset's walkthrough.

ldapTestRequest

The optional body of the connection test: a sample login the user filter must find exactly once.

FieldTypeDescription
usernamestring

memberRequest

FieldTypeDescription
user_idstring
role_id optionalstringRoleID or RoleName optionally names the role of the new member; the default is the organization's least-privilege Member role, never Admin.
role_name optionalstring

mfaResetRequest

FieldTypeDescription
reasonstring
factorsarray of string

organizationRequest

FieldTypeDescription
namestring
slugstring
owner_email optionalstringOwnerEmail or OwnerUserID (super admins, on create only) names the first owner.
owner_user_id optionalstring

roleAssignmentRequest

FieldTypeDescription
role_idstring

roleRequest

FieldTypeDescription
namestring
descriptionstring
permissionsarray of string

scimSetup

FieldTypeDescription
scim_base_urlstringThe absolute SCIM base URL of this deployment.
identity_providersarray of IdentityProvider
idpstring
guideGuideThe identity provider's walkthrough.
resultResultThe setup's staged checks, computed from the provisioning status.

scimTokenRequest

FieldTypeDescription
descriptionstring
expires_in_days optionalintegerThe token's lifetime in days: 90 when omitted, at most 365.

seatAssignBody

FieldTypeDescription
seat_typestring
reasonstring

seatDecisionBody

FieldTypeDescription
reasonstring

seatRequestBody

FieldTypeDescription
seat_typestring
messagestring

seatSettingsBody

FieldTypeDescription
auto_assignboolean
auto_assign_typestring
reclaim_after_days optionalinteger
reclaim_notice_daysinteger
reasonstring

shareResponse

FieldTypeDescription
idstring
workspace_idstring
org_idstring
shared_withstring
rolestring
expires_at optionaltimestamp
created_bystring
created_attimestamp

signInPolicyRequest

FieldTypeDescription
email_code_sign_in optionalboolean
email_code_for_admins optionalboolean
admin_two_factors optionalboolean
mfa_required optionalstring
allowed_factors optionalarray of string
phishing_resistant_for optionalstring
enrollment_grace_days optionalinteger

socialRequest

FieldTypeDescription
client_idstring
client_secretstring
tenantstring
enabledboolean
allowed_email_domainsarray of string
jit_provisioning optionalboolean

socialSetup

FieldTypeDescription
providerstring
callback_urlstringThe redirect URI Sandscale sends the provider: the one to register.
homepage_urlstringThe deployment's public URL (GitHub asks for a homepage).
guideGuideThe provider's walkthrough.

totpEnrollRequest

FieldTypeDescription
accountstring
current_passwordstring

totpVerifyRequest

FieldTypeDescription
codestring

updatePolicyRequest

FieldTypeDescription
min_lengthinteger
max_lengthinteger
require_uppercaseboolean
require_lowercaseboolean
require_digitboolean
require_specialboolean
history_countinteger
max_age_daysinteger
lockout_thresholdinteger
lockout_duration_minutesinteger

userRequest

FieldTypeDescription
emailstring
display_namestring
passwordstring
invitation_token optionalstringRequired unless registration is open (NI_AUTH_REGISTRATION_MODE).
product_line optionalstring

webhookRequest

FieldTypeDescription
namestring
urlstring
eventsarray 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.