Your account and API keys
83 endpoints. Paths are relative to https://api.sandscale.dev; values in braces are ones you fill in.
API reference · Authentication · Errors
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/account/api-keys | List api keys |
POST | /api/v1/account/api-keys | Create an api key |
DELETE | /api/v1/account/api-keys/{id} | Delete one api key |
POST | /api/v1/account/api-keys/{id}/rotate | Rotate an api key |
GET | /api/v1/account/console-preferences | List console preferences |
PUT | /api/v1/account/console-preferences | Set console preferences |
GET | /api/v1/account/devices | List devices |
POST | /api/v1/account/devices | Create a device |
POST | /api/v1/account/devices/{deviceId}/revoke | Revoke a device |
POST | /api/v1/account/email | Create an email |
GET | /api/v1/account/invitations | The pending invitations sent to the signed-in person's verified address, for information. None can be accepted from this list: accepting needs the invitation's token, which only its link carries. |
POST | /api/v1/account/invitations/accept | With the invitation's token, the signed-in person joins the organization that invited their address, with the role the invitation gives. |
POST | /api/v1/account/invitations/lookup | The invitation of the token the person holds, when it is pending and was sent to their address (the console shows it before the person accepts). |
GET | /api/v1/account/organizations | List organizations |
POST | /api/v1/account/password | Create a password |
GET | /api/v1/account/profile | List profile |
PATCH | /api/v1/account/profile | Update profile |
GET | /api/v1/account/remembered-devices | List remembered devices |
DELETE | /api/v1/account/remembered-devices | Delete remembered devices |
DELETE | /api/v1/account/remembered-devices/{id} | Delete one remembered device |
GET | /api/v1/account/resolve/{ref} | Get one resolve |
GET | /api/v1/account/security | List security |
GET | /api/v1/account/security/checklist | List checklist |
GET | /api/v1/account/sessions | List sessions |
DELETE | /api/v1/account/sessions/{id} | Delete one session |
POST | /api/v1/account/sessions/revoke-others | Create a revoke other |
GET | /api/v1/account/sign-in-alerts | List sign in alerts |
POST | /api/v1/account/sign-in-alerts/{id}/confirm | Confirm a sign in alert |
POST | /api/v1/account/sign-in-alerts/{id}/report | Report a sign in alert |
GET | /api/v1/account/sign-ins | List sign ins |
GET | /api/v1/account/ssh-keys | List ssh keys |
POST | /api/v1/account/ssh-keys | Create a ssh key |
DELETE | /api/v1/account/ssh-keys/{keyID} | Delete one ssh key |
POST | /api/v1/account/step-up | Create a step up |
POST | /api/v1/account/step-up-handoff/deny | Create a deny |
POST | /api/v1/account/step-up-handoff/lookup | Create a lookup |
POST | /api/v1/account/step-up-handoff/proofs | Create a proof |
POST | /api/v1/account/step-up/{id}/email | Email a step up |
POST | /api/v1/account/step-up/{id}/handoff | Handoff a step up |
POST | /api/v1/account/step-up/{id}/handoff/token | Create a token |
POST | /api/v1/account/step-up/{id}/proofs | Create a proof for a step up |
GET | /api/v1/me/access-requests | The caller's own requests in their organization (never resource_access ones). Query: status (default all), limit (1-200), offset. |
POST | /api/v1/me/access-requests | Create an access request |
GET | /api/v1/me/harness | Returns the signed pack chain that applies to the caller (GET /api/v1/me/harness). The service delivers only a chain whose every pack the caller may use (harness.packs:use): a more specific assignment with an unusable pack is passed over for the next one and listed in the response's skipped. |
POST | /api/v1/me/harness/events | Is the user-authenticated harness activity ingest route (POST /api/v1/me/harness/events), rate-limited per user. |
GET | /api/v1/me/notification-settings | List notification settings |
PUT | /api/v1/me/notification-settings | Set notification settings |
GET | /api/v1/me/notifications | List notifications |
POST | /api/v1/me/notifications/{id}/read | Read a notification |
POST | /api/v1/me/notifications/read-all | Create a read all |
GET | /api/v1/me/notifications/unread-count | List unread count |
GET | /api/v1/me/observe/metrics | The caller's own series of the built-in namespaces only, since anyone with observe:write could put a custom series naming someone else's UserId with their values per period and the statistic over the whole window, all computed here. Query parameters: Namespace, Stat (default Sum), Period in seconds (default 3600), StartTime and EndTime (RFC 3339, default the last 24 hours). |
GET | /api/v1/me/permissions | List permissions |
GET | /api/v1/me/policies | List policies |
GET | /api/v1/me/sessions | List sessions |
GET | /api/v1/me/usage | List usage |
GET | /api/v1/notifications/unsubscribe | List unsubscribe |
POST | /api/v1/notifications/unsubscribe | Create an unsubscribe |
POST | /api/v1/passkeys/register/begin | Create a begin |
POST | /api/v1/passkeys/register/complete | Create a complete |
GET | /api/v1/privacy/dsar | One's own requests. |
POST | /api/v1/privacy/dsar | A member files a request for themselves: the subject is always the signed-in person, with their account email. |
POST | /api/v1/privacy/dsar-exports/download | The export behind a valid signed link, recorded as downloaded. The link is the credential: it names one export and expires after ten minutes. |
GET | /api/v1/privacy/dsar/{id} | One's own request. |
POST | /api/v1/privacy/dsar/{id}/exports/{exportID}/link | The subject's own export. |
GET | /api/v1/sessions/{id}/budget | Budget of a session |
POST | /api/v1/sessions/{id}/budget | Budget a session |
POST | /api/v1/sessions/{id}/usage | Usage a session |
POST | /api/v1/svc/account/CloseAccount | Close account |
POST | /api/v1/svc/account/DeleteAlternateContact | Delete alternate contact |
POST | /api/v1/svc/account/DisableRegion | Disable region |
POST | /api/v1/svc/account/EnableRegion | Enable region |
POST | /api/v1/svc/account/GetAccountInformation | Get account information |
POST | /api/v1/svc/account/GetAlternateContact | Get alternate contact |
POST | /api/v1/svc/account/GetContactInformation | Get contact information |
POST | /api/v1/svc/account/GetRegionOptStatus | Get region opt status |
POST | /api/v1/svc/account/ListRegions | List regions |
POST | /api/v1/svc/account/PutAccountName | Put account name |
POST | /api/v1/svc/account/PutAlternateContact | Put alternate contact |
POST | /api/v1/svc/account/PutContactInformation | Put contact information |
POST | /api/v1/svc/account/PutIamBillingAccess | Put iam billing access |
POST | /api/v1/svc/account/ReopenAccount | Reopen account |
POST | /api/v1/svc/account/UpdateRootEmail | Update root email |
Endpoints
GET /api/v1/account/api-keys
List api keys
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:person_required; 503:unavailable
POST /api/v1/account/api-keys
Create an api key
- Permission
signed in- Request body
- personalKeyRequest
- Response
- 201: personalKeyCreated
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:person_required,regional_api_keys_unavailable; 415:content_type; 503:unavailable
DELETE /api/v1/account/api-keys/{id}
Delete one api key
- Permission
signed in- Path parameters
id- Errors
- 401:
unauthorized; 403:person_required; 503:unavailable
POST /api/v1/account/api-keys/{id}/rotate
Rotate an api key
- Permission
signed in- Path parameters
id- Request body
- personalRotateRequest
- Response
- 200: personalKeyCreated
- Errors
- 400:
invalid_json; 401:unauthorized; 403:person_required,regional_api_keys_unavailable; 415:content_type; 503:unavailable
GET /api/v1/account/console-preferences
List console preferences
- Permission
signed in- Response
- 200: ConsolePreferences
- Errors
- 401:
unauthorized; 403:forbidden
PUT /api/v1/account/console-preferences
Set console preferences
- Permission
signed in- Request body
- object
- Response
- 200: ConsolePreferences
- Errors
- 400:
invalid_json,invalid_request; 401:unauthorized; 403:forbidden,role_session_read_only; 415:content_type
GET /api/v1/account/devices
List devices
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized
POST /api/v1/account/devices
Create a device
- Permission
signed in- Request body
- deviceHeartbeatRequest
- Response
- 200: object of any
- Errors
- 400:
invalid_json; 401:unauthorized; 415:content_type
POST /api/v1/account/devices/{deviceId}/revoke
Revoke a device
- Permission
signed in- Path parameters
deviceId- Errors
- 401:
unauthorized
POST /api/v1/account/email
Create an email
- Permission
signed in- Request body
- object
- Response
- 200: object of any
- Errors
- 400:
email_unavailable,invalid_invitation,invalid_json,invitation_email_mismatch,validation_error; 401:invalid_credentials,unauthorized; 403:registration_closed,role_session_refused,sso_required; 404:not_found; 409:conflict,contained,last_super_admin; 415:content_type; 422:failed_precondition
GET /api/v1/account/invitations
The pending invitations sent to the signed-in person's verified address, for information. None can be accepted from this list: accepting needs the invitation's token, which only its link carries.
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:email_not_verified,forbidden,operator_access_required; 404:invalid_invitation; 409:conflict,root_not_linked; 503:unavailable
POST /api/v1/account/invitations/accept
With the invitation's token, the signed-in person joins the organization that invited their address, with the role the invitation gives.
- Permission
signed in- Response
- 200: AcceptedInvitation
- Errors
- 400:
invalid_json; 401:unauthorized; 403:email_not_verified,forbidden,operator_access_required; 404:invalid_invitation; 409:conflict,root_not_linked; 415:content_type; 503:unavailable
POST /api/v1/account/invitations/lookup
The invitation of the token the person holds, when it is pending and was sent to their address (the console shows it before the person accepts).
- Permission
signed in- Response
- 200: UserInvitation
- Errors
- 400:
invalid_json; 401:unauthorized; 403:email_not_verified,forbidden,operator_access_required; 404:invalid_invitation; 409:conflict,root_not_linked; 415:content_type; 503:unavailable
GET /api/v1/account/organizations
List organizations
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:person_required; 503:unavailable
POST /api/v1/account/password
Create a password
- Permission
signed in- Request body
- object
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:invalid_credentials; 415:content_type; 503:temporarily_unavailable
GET /api/v1/account/profile
List profile
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:role_session_refused; 404:not_found
PATCH /api/v1/account/profile
Update profile
- Permission
signed in- Request body
- object
- Errors
- 400:
invalid_json; 401:unauthorized; 403:role_session_refused; 415:content_type
GET /api/v1/account/remembered-devices
List remembered devices
- Permission
api:access- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:person_required
DELETE /api/v1/account/remembered-devices
Delete remembered devices
- Permission
api:access- Errors
- 401:
unauthorized; 403:person_required; 404:not_found
DELETE /api/v1/account/remembered-devices/{id}
Delete one remembered device
- Permission
api:access- Path parameters
id- Errors
- 401:
unauthorized; 403:person_required; 404:not_found
GET /api/v1/account/resolve/{ref}
Get one resolve
- Permission
signed in- Path parameters
ref- Response
- 200: ResolvedAccount
- Errors
- 401:
unauthorized; 404:not_found
GET /api/v1/account/security
List security
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:role_session_refused; 503:temporarily_unavailable
GET /api/v1/account/security/checklist
List checklist
- Permission
api:access- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:person_required,role_session_refused; 503:temporarily_unavailable
GET /api/v1/account/sessions
List sessions
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:role_session_refused
DELETE /api/v1/account/sessions/{id}
Delete one session
- Permission
signed in- Path parameters
id- Errors
- 401:
unauthorized; 403:role_session_refused; 404:not_found
POST /api/v1/account/sessions/revoke-others
Create a revoke other
- Permission
signed in- Errors
- 401:
unauthorized; 403:role_session_refused
GET /api/v1/account/sign-in-alerts
List sign in alerts
- Permission
api:access- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:person_required,role_session_refused; 503:temporarily_unavailable
POST /api/v1/account/sign-in-alerts/{id}/confirm
Confirm a sign in alert
- Permission
api:access- Path parameters
id- Response
- 200: alertView
- Errors
- 400:
invalid_request; 401:unauthorized; 403:confirm_needs_earlier_session,person_required,role_session_refused; 404:not_found; 409:alert_reported; 413:invalid_request; 503:temporarily_unavailable
POST /api/v1/account/sign-in-alerts/{id}/report
Report a sign in alert
- Permission
api:access- Path parameters
id- Response
- 200: object of any
- Errors
- 400:
invalid_request; 401:unauthorized; 403:person_required,role_session_refused; 404:not_found; 409:alert_reported; 413:invalid_request; 503:temporarily_unavailable
GET /api/v1/account/sign-ins
List sign ins
- Permission
api:access- Response
- 200: object of any
- Errors
- 400:
validation_error; 401:unauthorized; 403:person_required,role_session_refused; 409:no_account; 503:temporarily_unavailable
GET /api/v1/account/ssh-keys
List ssh keys
- Permission
api:access- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:forbidden; 503:unavailable
POST /api/v1/account/ssh-keys
Create a ssh key
- Permission
workspaces:create- Request body
- addSSHKeyBody
- Response
- 201: Key
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:forbidden,person_required; 409:duplicate,too_many_keys; 415:content_type; 503:unavailable
DELETE /api/v1/account/ssh-keys/{keyID}
Delete one ssh key
- Permission
workspaces:create- Path parameters
keyID- Errors
- 401:
unauthorized; 403:forbidden,person_required; 404:not_found; 503:unavailable
POST /api/v1/account/step-up
Create a step up
- Permission
api:access- Request body
- elevationBeginRequest
- Response
- 201: ElevationChallenge
- Errors
- 400:
invalid_json; 415:content_type
POST /api/v1/account/step-up-handoff/deny
Create a deny
- Permission
api:access- Request body
- handoffCodeRequest
- Response
- 200: object of string
- Errors
- 400:
invalid_json; 415:content_type
POST /api/v1/account/step-up-handoff/lookup
Create a lookup
- Permission
api:access- Request body
- handoffCodeRequest
- Response
- 200: HandoffView
- Errors
- 400:
invalid_json; 415:content_type
POST /api/v1/account/step-up-handoff/proofs
Create a proof
- Permission
api:access- Request body
- handoffProofRequest
- Response
- 200: object of string
- Errors
- 400:
invalid_json; 415:content_type
POST /api/v1/account/step-up/{id}/email
Email a step up
- Permission
api:access- Path parameters
id- Response
- 202: object of string
POST /api/v1/account/step-up/{id}/handoff
Handoff a step up
- Permission
api:access- Path parameters
id- Response
- 201: object of any
POST /api/v1/account/step-up/{id}/handoff/token
Create a token
- Permission
api:access- Path parameters
id- Response
- 200: object of any
POST /api/v1/account/step-up/{id}/proofs
Create a proof for a step up
- Permission
api:access- Path parameters
id- Request body
- elevationProofRequest
- Response
- 200: object of any
- Errors
- 400:
invalid_json; 415:content_type
GET /api/v1/me/access-requests
The caller's own requests in their organization (never resource_access ones). Query: status (default all), limit (1-200), offset.
- Permission
api:access- Query parameters
status- Errors
- 400:
invalid_query,validation_error; 401:unauthorized; 503:requests_unavailable
POST /api/v1/me/access-requests
Create an access request
- Permission
api:access- Request body
- object
- Response
- 201: AccessRequest
- Errors
- 400:
invalid_body,validation_error; 401:unauthorized
GET /api/v1/me/harness
Returns the signed pack chain that applies to the caller (GET /api/v1/me/harness). The service delivers only a chain whose every pack the caller may use (harness.packs:use): a more specific assignment with an unusable pack is passed over for the next one and listed in the response's skipped.
- Permission
harness:read- Query parameters
engine,project,reason- Response
- 200: Resolution
- Errors
- 400:
reason_in_query,validation_error; 401:unauthorized; 403:forbidden; 404:not_found; 409:conflict,eval_gate; 503:authorization_unavailable,signing_unavailable
POST /api/v1/me/harness/events
Is the user-authenticated harness activity ingest route (POST /api/v1/me/harness/events), rate-limited per user.
- Permission
harness:read- Query parameters
reason- Request body
- object
- Response
- 202: IngestResult
- Errors
- 400:
invalid_json,reason_in_query,validation_error; 401:unauthorized; 403:forbidden; 404:not_found; 409:conflict,eval_gate; 429:rate_limited; 503:authorization_unavailable,signing_unavailable
GET /api/v1/me/notification-settings
List notification settings
- Permission
signed in- Errors
- 401:
unauthorized; 403:person_required
PUT /api/v1/me/notification-settings
Set notification settings
- Permission
signed in- Request body
- object
- Errors
- 400:
invalid_request; 401:unauthorized; 403:person_required,role_session_read_only; 503:unavailable
GET /api/v1/me/notifications
List notifications
- Permission
signed in- Query parameters
after,limit,unread- Response
- 200: Page
- Errors
- 400:
invalid_request; 401:unauthorized; 403:person_required
POST /api/v1/me/notifications/{id}/read
Read a notification
- Permission
signed in- Path parameters
id- Errors
- 401:
unauthorized; 403:person_required,role_session_read_only; 404:not_found
POST /api/v1/me/notifications/read-all
Create a read all
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:person_required,role_session_read_only
GET /api/v1/me/notifications/unread-count
List unread count
- Permission
signed in- Response
- 200: object of any
- Errors
- 401:
unauthorized; 403:person_required
GET /api/v1/me/observe/metrics
The caller's own series of the built-in namespaces only, since anyone with observe:write could put a custom series naming someone else's UserId with their values per period and the statistic over the whole window, all computed here. Query parameters: Namespace, Stat (default Sum), Period in seconds (default 3600), StartTime and EndTime (RFC 3339, default the last 24 hours).
- Permission
signed in- Query parameters
EndTime,Namespace,Period,StartTime,Stat- Response
- 200: MyMetricsOutput
GET /api/v1/me/permissions
List permissions
- Permission
signed in- Query parameters
node- Response
- 200: Effective; 200: object of JSON
- Errors
- 401:
unauthorized; 403:permission_denied
GET /api/v1/me/policies
List policies
- Permission
api:access- Response
- 200: object of any
- Errors
- 401:
unauthorized
GET /api/v1/me/sessions
List sessions
- Permission
api:access- Response
- 200: object of any
- Errors
- 400:
invalid_query; 401:unauthorized
GET /api/v1/me/usage
List usage
- Permission
api:access- Response
- 200: MyUsage
- Errors
- 401:
unauthorized
GET /api/v1/notifications/unsubscribe
List unsubscribe
- Permission
none- Query parameters
token
POST /api/v1/notifications/unsubscribe
Create an unsubscribe
- Permission
none- Query parameters
token- Errors
- 400:
invalid_request,invalid_token
POST /api/v1/passkeys/register/begin
Create a begin
- Permission
api:access- Request body
- object
- Response
- 200: RegistrationOptions
- Errors
- 400:
invalid_json; 401:unauthorized; 415:content_type; 503:step_up_unavailable
POST /api/v1/passkeys/register/complete
Create a complete
- Permission
api:access- Request body
- completeRegistrationRequest
- Response
- 201: object of any
- Errors
- 400:
invalid_json,registration_failed,validation_error; 401:unauthorized; 415:content_type; 503:step_up_unavailable
GET /api/v1/privacy/dsar
One's own requests.
- Permission
api:access- Query parameters
sla,status- Errors
- 400:
invalid_query,resolution_required,validation_error; 403:person_required; 404:not_found; 409:already_extended,export_required,invalid_transition,no_export,request_closed; 410:link_invalid; 503:privacy_unavailable
POST /api/v1/privacy/dsar
A member files a request for themselves: the subject is always the signed-in person, with their account email.
- Permission
api:access- Request body
- object
- Response
- 201: object of any
- Errors
- 400:
invalid_body,resolution_required,validation_error; 403:person_required; 404:not_found; 409:already_extended,export_required,invalid_transition,no_export,request_closed; 410:link_invalid; 503:audit_unavailable,privacy_unavailable
POST /api/v1/privacy/dsar-exports/download
The export behind a valid signed link, recorded as downloaded. The link is the credential: it names one export and expires after ten minutes.
- Permission
none- Request body
- object
- Errors
- 400:
invalid_body,resolution_required,validation_error; 404:not_found; 409:already_extended,export_required,invalid_transition,no_export,request_closed; 410:link_invalid; 429:rate_limited; 503:privacy_unavailable
GET /api/v1/privacy/dsar/{id}
One's own request.
- Permission
api:access- Path parameters
id- Errors
- 400:
resolution_required,validation_error; 403:person_required; 404:not_found; 409:already_extended,export_required,invalid_transition,no_export,request_closed; 410:link_invalid; 503:privacy_unavailable
POST /api/v1/privacy/dsar/{id}/exports/{exportID}/link
The subject's own export.
- Permission
api:access- Path parameters
id,exportID- Errors
- 400:
resolution_required,validation_error; 403:person_required; 404:not_found; 409:already_extended,export_required,invalid_transition,no_export,request_closed; 410:link_invalid; 503:privacy_unavailable
GET /api/v1/sessions/{id}/budget
Budget of a session
- Permission
api:access- Path parameters
id- Response
- 200: SessionBudget
- Errors
- 401:
unauthorized; 404:not_found
POST /api/v1/sessions/{id}/budget
Budget a session
- Permission
api:access- Path parameters
id- Request body
- declareBudgetRequest
- Response
- 201: SessionBudget
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:budget.session_write_denied; 404:not_found; 409:budget_exists; 415:content_type; 422:budget_exceeds_caps
POST /api/v1/sessions/{id}/usage
Usage a session
- Permission
api:access- Path parameters
id- Request body
- recordUsageRequest
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:budget.session_write_denied,not_session_owner; 404:not_found; 409:session_inactive; 415:content_type
POST /api/v1/svc/account/CloseAccount
Close account
- Permission
account.lifecycle:closeaccount- Request body
- accountIDIn
- Response
- 200: object
POST /api/v1/svc/account/DeleteAlternateContact
Delete alternate contact
- Permission
account.contacts:deletealternatecontact
POST /api/v1/svc/account/DisableRegion
Disable region
- Permission
account.regions:disableregion
POST /api/v1/svc/account/EnableRegion
Enable region
- Permission
account.regions:enableregion
POST /api/v1/svc/account/GetAccountInformation
Get account information
- Permission
account.info:getaccountinformation
POST /api/v1/svc/account/GetAlternateContact
Get alternate contact
- Permission
account.contacts:getalternatecontact
POST /api/v1/svc/account/GetContactInformation
Get contact information
- Permission
account.contacts:getcontactinformation
POST /api/v1/svc/account/GetRegionOptStatus
Get region opt status
- Permission
account.regions:getregionoptstatus
POST /api/v1/svc/account/ListRegions
List regions
- Permission
account.regions:listregions
POST /api/v1/svc/account/PutAccountName
Put account name
- Permission
account.info:putaccountname
POST /api/v1/svc/account/PutAlternateContact
Put alternate contact
- Permission
account.contacts:putalternatecontact
POST /api/v1/svc/account/PutContactInformation
Put contact information
- Permission
account.contacts:putcontactinformation
POST /api/v1/svc/account/PutIamBillingAccess
Put iam billing access
- Permission
account.billingaccess:putiambillingaccess
POST /api/v1/svc/account/ReopenAccount
Reopen account
- Permission
account.lifecycle:reopenaccount
POST /api/v1/svc/account/UpdateRootEmail
Update root email
- Permission
account.root:updaterootemail
Objects
object
| Field | Type | Description |
|---|---|---|
display_name | string |
object
| Field | Type | Description |
|---|---|---|
new_email | string | |
current_password | string |
object
| Field | Type | Description |
|---|---|---|
current_password | string | |
new_password | string |
object
| Field | Type | Description |
|---|---|---|
request_type | string | |
target_resource | string | |
business_reason | string | |
session_id | string |
object
| Field | Type | Description |
|---|---|---|
events | array of ActivityEvent |
object
| Field | Type | Description |
|---|---|---|
email | string | |
display_name | string |
object
| Field | Type | Description |
|---|---|---|
type | string | |
notes | string |
object
| Field | Type | Description |
|---|---|---|
token | string |
object
| Field | Type | Description |
|---|---|---|
getting_started_hidden optional | boolean | |
sidebar_collapsed optional | boolean |
object
| Field | Type | Description |
|---|---|---|
category | string | |
in_app optional | boolean | |
email optional | boolean |
object
No fields.
SessionBudget
SessionBudget represents the budget constraints and usage for an agent session.
| Field | Type | Description |
|---|---|---|
id | string | |
agent_id | string | |
session_id | string | |
max_cost_usd optional | number | |
max_input_tokens optional | integer | |
max_output_tokens optional | integer | |
max_session_duration_minutes optional | integer | |
max_idle_minutes | integer | |
max_turns optional | integer | |
input_tokens_used | integer | |
output_tokens_used | integer | |
turns_used | integer | |
started_at | timestamp | |
last_activity_at | timestamp | |
status | string | |
created_at | timestamp | |
owner_user_id optional | string | OwnerUserID and OwnerAPIKeyID name who declared the budget: only they, or an administrator, write it. Both are empty for a budget declared before owners were kept. |
owner_api_key_id optional | string |
ConditionStep
The evaluation of one condition of an IAM policy statement, with the request's value for its key.
| Field | Type | Description |
|---|---|---|
operator | string | |
key | string | |
values | array of string | |
context optional | array of string | |
missing optional | boolean | |
result | string | |
error optional | string |
Dimension
A name and value pair that identifies a metric together with its namespace and name.
| Field | Type | Description |
|---|---|---|
Name | string | |
Value | string |
Explanation
A decision with the chain of objects that produced it.
| Field | Type | Description |
|---|---|---|
allowed | boolean | |
decided_by | string | DecidedBy names the step that decided. |
revision | string | The organization's access revision the decision was computed at. |
step_up optional | StepUpRequirement | Set when a deny policy asks for re-verification. |
permission | string | |
node | NodeRef | |
resource optional | ResourceRef | Set for a check on one object; Node is then its owner node. |
principal | PrincipalRef | |
steps | array of Step | |
action optional | string | The permission's IAM action; ResourceNRN the NRN the check's IAM policy statements were matched against ("*" for an action without resource types). |
resource_nrn optional | string | |
missing_context_keys optional | array of string | The condition keys an evaluated IAM policy statement read that the request did not have. |
mac optional | MACOutcome | How mandatory access control decided (step 4.5). |
MACLabel
A classification label as an explanation and the API show it.
| Field | Type | Description |
|---|---|---|
classification | string | |
compartments | array of string |
MACOutcome
How MAC decided a check. It is always set by the engine; the labels are filled in explanations only.
| Field | Type | Description |
|---|---|---|
evaluated | boolean | Set when the MAC step ran. |
rule optional | string | Rule names the rule that applied (MACRule*). |
relaxed optional | boolean | Set for a write allowed only by the organization's own-level rule. |
bypass optional | string | Set when a super admin passed MAC on platform metadata, with the reason. |
resource optional | MACLabel | The effective label of the checked node; Clearances the principal's. |
clearances optional | array of MACLabel |
MyMetric
One of the member's own series with its values over the requested window.
| Field | Type | Description |
|---|---|---|
Namespace | string | |
MetricName | string | |
Dimensions | array of Dimension | |
Unit | string | |
Stat | string | |
Timestamps | array of timestamp | |
Values | array of number | |
Total optional | number | The statistic over the whole window. |
MyMetricsOutput
| Field | Type | Description |
|---|---|---|
StartTime | timestamp | |
EndTime | timestamp | |
Period | integer | |
Metrics | array of MyMetric |
NodeRef
NodeRef identifies a node in explanations.
| Field | Type | Description |
|---|---|---|
id | string | |
kind | string | |
path | string |
PrincipalRef
PrincipalRef identifies a principal in explanations and API payloads.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string |
ResourceRef
ResourceRef identifies a shared object in explanations and API payloads.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string |
Step
One entry in an explanation.
| Field | Type | Description |
|---|---|---|
kind | string | |
id optional | string | |
node_id optional | string | |
inherited_from optional | string | Set when the step's object is on an ancestor of the checked node. |
role optional | string | |
via optional | PrincipalRef | |
resource optional | ResourceRef | Set on a step of a resource binding. |
effect | string | |
reason optional | string | |
policy_nrn optional | string | The statement of an IAM policy step. |
policy_type optional | string | |
version_id optional | string | |
sid optional | string | |
statement optional | integer | |
attached_to optional | PrincipalRef | |
conditions optional | array of ConditionStep |
StepUpRequirement
What a deny-with-step-up asks: a factor of at least Strength proved within MaxAgeSeconds.
| Field | Type | Description |
|---|---|---|
strength | string | |
max_age_seconds | integer |
AccessRequest
A single row in self_service_access_requests.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
requester_id | string | |
request_type | string | |
target_resource | string | |
business_reason | string | |
session_id optional | string | |
status | string | |
reviewed_by optional | string | |
review_reason optional | string | |
approved_until optional | timestamp | |
created_at | timestamp | |
reviewed_at optional | timestamp | |
ide_device_id optional | string | IDE requests (filed by the device agent): the device, the app and action asked for, the minutes asked for, and when the pending request expires. |
ide_app optional | string | |
ide_action optional | string | |
requested_minutes optional | integer | |
expires_at optional | timestamp | |
revoked_at optional | timestamp | |
decidable | boolean | Decidable: the request is pending and unexpired. |
MyUsage
MyUsage holds self-service usage figures for the portal dashboard.
| Field | Type | Description |
|---|---|---|
today_cost_usd | number | |
month_cost_usd | number | |
top_tools | array of ToolBreakdown |
ToolBreakdown
A (tool, cost) pair used in MyUsage.
| Field | Type | Description |
|---|---|---|
tool | string | |
cost_usd | number |
ActivityEvent
One harness event from the IDE. It carries identifiers, counts and outcomes only; there is deliberately no field for code, prompts or completions.
| Field | Type | Description |
|---|---|---|
event_id | string | |
type | string | |
occurred_at | timestamp | |
pack | PackRef | |
experiment_id optional | string | |
arm optional | string | |
engine | string | |
model | string | |
project optional | string | |
outcome optional | string | |
reworked optional | boolean | |
duration_ms optional | integer | |
input_tokens optional | integer | |
output_tokens optional | integer | |
cost_usd optional | number |
ChainEntry
One signed layer in a /me/harness response, starter first.
| Field | Type | Description |
|---|---|---|
id | string | |
publisher | string | |
version | string | |
kind | string | |
name | string | |
parent optional | ParentRef | |
status | string | |
published_at | string | |
manifest | JSON | |
sha256 | string | |
signature | string | |
pq_signature optional | string | |
key_id | string |
IngestResult
IngestResult reports how many events were stored and how many were already known.
| Field | Type | Description |
|---|---|---|
accepted | integer | |
duplicates | integer |
PackRef
PackRef identifies the pack version an event is about, as the IDE knows it from /me/harness.
| Field | Type | Description |
|---|---|---|
id | string | |
publisher | string | |
version | string |
ParentRef
ParentRef names the layer a pack version builds on.
| Field | Type | Description |
|---|---|---|
id | string | |
publisher | string | |
version | string |
Resolution
The /api/v1/me/harness response. Assignment is null when nothing is assigned and the platform starter for the requested engine is served.
| Field | Type | Description |
|---|---|---|
assignment optional | ResolvedAssignment | |
chain | array of ChainEntry | |
skipped optional | array of SkippedAssignment | |
etag | string |
ResolvedAssignment
ResolvedAssignment tells the IDE where its pack came from, and the experiment arm to tag metrics with.
| Field | Type | Description |
|---|---|---|
scope | string | |
scope_id | string | |
experiment_id optional | string | |
arm optional | string |
SkippedAssignment
An assignment (or an experiment's candidate arm, Arm set) that resolution passed over, and why.
| Field | Type | Description |
|---|---|---|
scope | string | |
scope_id | string | |
arm optional | string | |
reason | string |
Notification
One notification for one person in one organization.
| Field | Type | Description |
|---|---|---|
id | uuid | |
kind | string | Kind names what it is about, dotted ("approval.decided"). |
title | string | |
body optional | string | |
link optional | string | A console path under the account ("/approvals/<id>"), never an address. |
created_at | timestamp | |
read_at optional | timestamp |
Page
One page of a person's inbox, newest first.
| Field | Type | Description |
|---|---|---|
notifications | array of Notification | |
next optional | string | The cursor of the following page; empty on the last page. |
AuthenticationOptions
| Field | Type | Description |
|---|---|---|
challenge | string | |
timeout | integer | |
rpId | string | |
userVerification | string | |
allowCredentials optional | array of CredentialDescriptor |
AuthenticatorSelection
| Field | Type | Description |
|---|---|---|
authenticatorAttachment optional | string | |
residentKey | string | |
userVerification | string |
CredentialDescriptor
| Field | Type | Description |
|---|---|---|
type | string | |
id | string | |
transports optional | array of string |
PubKeyCredParam
| Field | Type | Description |
|---|---|---|
type | string | |
alg | integer |
PublicKeyUser
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
displayName | string |
RegistrationOptions
| Field | Type | Description |
|---|---|---|
challenge | string | |
rp | RelyingParty | |
user | PublicKeyUser | |
pubKeyCredParams | array of PubKeyCredParam | |
timeout | integer | |
attestation | string | |
authenticatorSelection | AuthenticatorSelection | |
excludeCredentials optional | array of CredentialDescriptor |
RelyingParty
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
Effective
A principal's effective permissions on a node.
| Field | Type | Description |
|---|---|---|
principal | PrincipalRef | |
node | NodeRef | |
revision | string | |
permissions | array of string | |
explanations optional | array of Explanation | Explanations, when requested, cover every granted permission and every permission a binding would grant but a deny policy, ceiling, separation-of-duties rule or disabled state blocks. |
Key
A stored public key.
| Field | Type | Description |
|---|---|---|
id | uuid | |
name | string | |
public_key | string | |
fingerprint | string | |
created_at | timestamp |
ElevationChallenge
A started or partly proved re-verification.
| Field | Type | Description |
|---|---|---|
id | string | |
action | string | |
methods | array of string | |
factors_required | integer | |
methods_done | array of string | |
reasons optional | array of string | |
expires_at | timestamp | |
passkey optional | AuthenticationOptions | The assertion request when a passkey is accepted. |
email_sent optional | boolean | EmailSent says a code was emailed (the email code is accepted). |
HandoffView
What the console page shows of a claimed hand-off.
| Field | Type | Description |
|---|---|---|
action | string | |
factors_required | integer | |
methods_done | array of string | |
requested_at | timestamp | |
requested_from optional | string | |
request_user_agent optional | string | |
expires_at | timestamp | |
passkey optional | AuthenticationOptions | A fresh assertion request for this person. |
AcceptedInvitation
What accepting an invitation as an existing login did.
| Field | Type | Description |
|---|---|---|
invitation_id | string | |
organization_id | string | |
membership_id | string | |
role_id | string |
UserInvitation
A pending invitation addressed to a person, as the person sees it.
| Field | Type | Description |
|---|---|---|
id | string | |
organization_id | string | |
organization_name | string | |
role_name | string | |
invited_by optional | string | |
created_at | timestamp | |
expires_at | timestamp |
ConsolePreferences
A person's console presentation choices in one account. They decide nothing about access: they only shape what the console shows that person.
| Field | Type | Description |
|---|---|---|
getting_started_hidden | boolean | GettingStartedHidden: the person turned off "Show Get started when I sign in" (the console then lands a sign-in on Home instead of Get started). Presentation only. |
sidebar_collapsed optional | boolean | SidebarCollapsed: the person collapsed the service sidebar to its rail (Cmd+B); absent until they first choose (db/migrations/006650_console_sidebar_preference.up.sql). |
updated_at optional | timestamp | When the person last changed them; absent while they are the defaults. |
ResolvedAccount
| Field | Type | Description |
|---|---|---|
account_id | string | The 12-digit Account ID, the form console URLs carry. |
organization_id | string | The organization UUID, the ID every other API route takes. |
name | string | |
alias | string | The account alias (the organization slug). |
matched_by | string | What the reference was: account_id, alias or organization_id. |
canonical | boolean | True when the reference is exactly the Account ID. |
current | boolean | True when the caller's credentials are for this account; otherwise the caller is a member who has to sign in to it to act there. |
accountIDIn
| Field | Type | Description |
|---|---|---|
AccountId | string |
addSSHKeyBody
| Field | Type | Description |
|---|---|---|
name | string | |
public_key | string |
alertView
| Field | Type | Description |
|---|---|---|
id | string | |
reasons | array of string | |
ip | string | |
country | string | |
user_agent | string | |
created_at | timestamp | |
link_expires_at | timestamp | |
confirmed_at optional | timestamp | |
reported_at optional | timestamp | |
state | string | |
browser | string | |
answers | array of string | The answers the alert accepts from the calling session, decided here (signinguard.Answers): "confirm" only from a session that started before the alerted sign-in, "report" until the alert is reported. |
completeRegistrationRequest
| Field | Type | Description |
|---|---|---|
response | JSON | |
name | string | |
credential_id | string | Fields of the former unverified registration body, refused with an explanation. |
public_key | string | |
aaguid | string | |
sign_count | integer | |
transports | array of string | |
backed_up | boolean |
declareBudgetRequest
| Field | Type | Description |
|---|---|---|
agent_id | string | |
max_cost_usd optional | number | |
max_input_tokens optional | integer | |
max_output_tokens optional | integer | |
max_session_duration_minutes optional | integer | |
max_idle_minutes optional | integer | |
max_turns optional | integer |
deviceHeartbeatRequest
| Field | Type | Description |
|---|---|---|
machineId | string | |
deviceName | string | |
version | string | |
os | string | |
lastActive | string | |
isActive | boolean |
elevationBeginRequest
| Field | Type | Description |
|---|---|---|
action | string | |
request_hash | string |
elevationProofRequest
| Field | Type | Description |
|---|---|---|
method | string | |
code | string | |
credential_id | string | |
client_data_json | string | |
authenticator_data | string | |
signature | string | |
user_handle | string |
handoffCodeRequest
| Field | Type | Description |
|---|---|---|
user_code | string |
handoffProofRequest
| Field | Type | Description |
|---|---|---|
user_code | string | |
credential_id | string | |
client_data_json | string | |
authenticator_data | string | |
signature | string | |
user_handle | string |
personalKeyCreated
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
key_prefix | string | |
scopes | array of string | |
expires_at optional | timestamp | |
last_used_at optional | timestamp | |
revoked_at optional | timestamp | |
created_at | timestamp | |
state | string | Active, expired or revoked, decided by the server. |
key | string | |
rotated_from optional | string | RotatedFrom and PreviousExpiresAt describe the key a rotation replaced. |
previous_expires_at optional | timestamp |
personalKeyRequest
| Field | Type | Description |
|---|---|---|
name | string | |
scopes | array of string | |
expires_at optional | timestamp |
personalRotateRequest
| Field | Type | Description |
|---|---|---|
overlap_seconds optional | integer |
recordUsageRequest
| Field | Type | Description |
|---|---|---|
input_tokens | integer | |
output_tokens | integer | |
cost_usd | number |
This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.