Sign-in and OAuth
47 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 | /.well-known/jwks.json | Serves the published signing keys (the active, next and retiring keys) with the keyset's cache lifetime: a next key is published at least twice that long before it signs, so a relying party that honours the header always holds the key of any ID token it is shown. |
GET | /.well-known/oauth-authorization-server | Serves the OAuth 2.0 authorization server metadata (RFC 8414): the OpenID discovery document with the grants and client authentication methods the token endpoint accepts. MCP clients read it after the sandbox MCP server's protected resource metadata names this server. |
GET | /.well-known/openid-configuration | Serves the OpenID Provider metadata. On an Organization's sign-in host the issuer and every endpoint are that host's, so a relying party configured with that issuer validates the document. |
GET | /api/v1/applications | List applications |
POST | /api/v1/applications | Create an application |
GET | /api/v1/applications/{clientId} | Get one application |
PATCH | /api/v1/applications/{clientId} | Update one application |
DELETE | /api/v1/applications/{clientId} | Delete one application |
GET | /api/v1/applications/{clientId}/{view} | One API (clientId "apis"), an application's logs or its grants. |
PUT | /api/v1/applications/{clientId}/apis/{apiId} | Replace one api |
DELETE | /api/v1/applications/{clientId}/apis/{apiId} | Delete one api |
POST | /api/v1/applications/{clientId}/secret/rotate | Create a rotate |
GET | /api/v1/applications/apis | List apis |
POST | /api/v1/applications/apis | Create an api |
PATCH | /api/v1/applications/apis/{apiId} | Update one api |
DELETE | /api/v1/applications/apis/{apiId} | Delete one api |
POST | /api/v1/auth/login | Create a login |
POST | /api/v1/auth/login/step-up | Create a step up |
POST | /api/v1/auth/login/step-up/resend | Create a resend |
POST | /api/v1/auth/logout | Create a logout |
POST | /api/v1/auth/passkeys/authenticate/begin | Create a begin |
POST | /api/v1/auth/passkeys/authenticate/complete | Create a complete |
POST | /api/v1/auth/password/change | Create a change |
POST | /api/v1/auth/password/validate | Create a validate |
POST | /api/v1/auth/recovery-code/verify | Create a verify |
POST | /api/v1/auth/sessions/revoke | Create a revoke |
POST | /api/v1/auth/sessions/revoke-all | Create a revoke all |
POST | /api/v1/auth/token/introspect | Implements RFC 7662 token introspection. The caller must authenticate as a confidential OAuth client (client_secret_basic, or client_id and client_secret in the form). Agent tokens and delegated tokens are reported active only to a resource server of their organization, with their effective scope, aud, act, org_id, token_use and consent_id. |
POST | /api/v1/auth/token/refresh | Create a refresh |
POST | /api/v1/auth/token/revoke | Create a revoke |
POST | /api/v1/oauth2/authorization-details | Create an authorization detail |
GET | /api/v1/oauth2/authorization-details/{clientId} | Get one authorization detail |
DELETE | /api/v1/oauth2/authorization-details/{id} | Delete one authorization detail |
GET | /api/v1/oauth2/clients | List clients |
GET | /oauth2/authorize | List authorize |
POST | /oauth2/authorize | Create an authorize |
POST | /oauth2/device | Create a device |
POST | /oauth2/device/authorize | Create an authorize |
POST | /oauth2/device/token | Create a token |
POST | /oauth2/register | Create a register |
GET | /oauth2/register/{clientId} | Get one register |
PUT | /oauth2/register/{clientId} | Replace one register |
DELETE | /oauth2/register/{clientId} | Delete one register |
POST | /oauth2/revoke | Implements RFC 7009 token revocation. Revoking a refresh or access token ends the Sandscale session it belongs to. Unknown tokens still return 200. |
POST | /oauth2/token | Create a token |
GET | /oauth2/userinfo | Returns the claims of the user an access token was issued to (OIDC Core 5.3). The token must be live, exactly as the authentication middleware requires: a revoked or expired session, a revoked token, a suspended user and an agent or device token are all refused with 401 invalid_token. |
POST | /oauth2/userinfo | Returns the claims of the user an access token was issued to (OIDC Core 5.3). The token must be live, exactly as the authentication middleware requires: a revoked or expired session, a revoked token, a suspended user and an agent or device token are all refused with 401 invalid_token. |
Endpoints
GET /.well-known/jwks.json
Serves the published signing keys (the active, next and retiring keys) with the keyset's cache lifetime: a next key is published at least twice that long before it signs, so a relying party that honours the header always holds the key of any ID token it is shown.
- Permission
none- Response
- 200: object of any
- Errors
- 503:
jwks_unavailable
GET /.well-known/oauth-authorization-server
Serves the OAuth 2.0 authorization server metadata (RFC 8414): the OpenID discovery document with the grants and client authentication methods the token endpoint accepts. MCP clients read it after the sandbox MCP server's protected resource metadata names this server.
- Permission
none- Response
- 200: object of any
GET /.well-known/openid-configuration
Serves the OpenID Provider metadata. On an Organization's sign-in host the issuer and every endpoint are that host's, so a relying party configured with that issuer validates the document.
- Permission
none- Response
- 200: Discovery
GET /api/v1/applications
List applications
- Permission
applications:read- Query parameters
audience,page_token- Response
- 200: object of any
- Errors
- 400:
invalid_request; 401:unauthorized
POST /api/v1/applications
Create an application
- Permission
applications:create- Request body
- ApplicationInput
- Response
- 201: CreatedApplication
- Errors
- 400:
invalid_json; 401:unauthorized; 402:entry_not_enabled; 403:forbidden,person_required; 415:content_type; 503:entitlement_unavailable,unavailable
GET /api/v1/applications/{clientId}
Get one application
- Permission
applications:read- Path parameters
clientId- Response
- 200: Application
- Errors
- 401:
unauthorized
PATCH /api/v1/applications/{clientId}
Update one application
- Permission
applications:update- Path parameters
clientId- Request body
- ApplicationInput
- Response
- 200: Application
- Errors
- 400:
invalid_json,invalid_request; 401:unauthorized; 415:content_type; 503:step_up_unavailable
DELETE /api/v1/applications/{clientId}
Delete one application
- Permission
applications:delete- Path parameters
clientId- Errors
- 401:
unauthorized
GET /api/v1/applications/{clientId}/{view}
One API (clientId "apis"), an application's logs or its grants.
- Permission
applications:read- Path parameters
clientId,view- Query parameters
from,page_token,to- Response
- 200: API; 200: object of any
- Errors
- 400:
invalid_page_token,invalid_request; 401:unauthorized; 403:forbidden; 404:not_found; 503:audit_unavailable,unavailable
PUT /api/v1/applications/{clientId}/apis/{apiId}
Replace one api
DELETE /api/v1/applications/{clientId}/apis/{apiId}
Delete one api
- Permission
applications.apis:manage- Path parameters
clientId,apiId- Errors
- 401:
unauthorized
POST /api/v1/applications/{clientId}/secret/rotate
Create a rotate
- Permission
applications:rotatesecret- Path parameters
clientId- Response
- 200: RotatedSecret
- Errors
- 401:
unauthorized
GET /api/v1/applications/apis
List apis
- Permission
applications.apis:read- Query parameters
page_token- Response
- 200: object of any
- Errors
- 400:
invalid_request; 401:unauthorized
POST /api/v1/applications/apis
Create an api
PATCH /api/v1/applications/apis/{apiId}
Update one api
DELETE /api/v1/applications/apis/{apiId}
Delete one api
- Permission
applications.apis:manage- Path parameters
apiId- Errors
- 401:
unauthorized
POST /api/v1/auth/login
Create a login
- Permission
none- Request body
- loginRequest
- Response
- 200: object of any
- Errors
- 400:
invalid_json,invalid_request; 401:invalid_credentials,invalid_mfa,mfa_required; 403:organization_access_denied,risk_denied; 415:content_type; 429:step_up_rate_limited; 503:step_up_unavailable
POST /api/v1/auth/login/step-up
Create a step up
- Permission
none- Response
- 200: object of any
- Errors
- 401:
invalid_code,invalid_credentials,invalid_mfa,mfa_required,step_up_expired; 403:organization_access_denied; 503:step_up_unavailable
POST /api/v1/auth/login/step-up/resend
Create a resend
- Permission
none- Response
- 202: object of any
- Errors
- 401:
step_up_expired,step_up_locked; 429:resend_too_soon,step_up_rate_limited; 503:step_up_unavailable
POST /api/v1/auth/logout
Create a logout
- Permission
signed in- Response
- 200: object of string
- Errors
- 401:
unauthorized; 503:temporarily_unavailable
POST /api/v1/auth/passkeys/authenticate/begin
Create a begin
- Permission
none- Request body
- passkeyBeginRequest
- Response
- 200: AuthenticationOptions
- Errors
- 400:
invalid_json,validation_error; 401:invalid_credentials; 415:content_type
POST /api/v1/auth/passkeys/authenticate/complete
Create a complete
- Permission
none- Request body
- passkeyCompleteRequest
- Response
- 200: object of any
- Errors
- 400:
invalid_json,invalid_request; 401:invalid_credentials,invalid_mfa,mfa_required,user_verification_required; 403:organization_access_denied,risk_denied; 415:content_type; 503:step_up_unavailable
POST /api/v1/auth/password/change
Create a change
- Permission
signed in- Request body
- object
- Errors
- 400:
invalid_json,validation_error; 401:unauthorized; 403:invalid_credentials; 415:content_type; 503:temporarily_unavailable
POST /api/v1/auth/password/validate
Create a validate
- Permission
none- Request body
- validatePasswordRequest
- Response
- 200: object of any
- Errors
- 400:
invalid_json; 415:content_type
POST /api/v1/auth/recovery-code/verify
Create a verify
- Permission
signed in- Request body
- verifyRecoveryCodeRequest
- 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; 429:rate_limited; 503:temporarily_unavailable
POST /api/v1/auth/sessions/revoke
Create a revoke
- Permission
signed in- Request body
- revokeSessionRequest
- Errors
- 400:
invalid_json,invalid_request; 401:unauthorized; 404:not_found; 415:content_type; 503:temporarily_unavailable
POST /api/v1/auth/sessions/revoke-all
Create a revoke all
- Permission
signed in- Errors
- 401:
unauthorized; 500:server_error
POST /api/v1/auth/token/introspect
Implements RFC 7662 token introspection. The caller must authenticate as a confidential OAuth client (client_secret_basic, or client_id and client_secret in the form). Agent tokens and delegated tokens are reported active only to a resource server of their organization, with their effective scope, aud, act, org_id, token_use and consent_id.
- Permission
none- Request body
- introspectRequest
- Response
- 200: IntrospectionResponse; 200: TokenIntrospection
- Errors
- 400:
invalid_json,invalid_request; 401:invalid_client; 415:content_type; 503:temporarily_unavailable
POST /api/v1/auth/token/refresh
Create a refresh
- Permission
none- Request body
- refreshRequest
- Response
- 200: object of any
- Errors
- 400:
invalid_json,invalid_request; 401:invalid_grant,refresh_token_race,token_reuse_detected; 415:content_type; 503:temporarily_unavailable
POST /api/v1/auth/token/revoke
Create a revoke
- Permission
none- Query parameters
token,token_type_hint- Request body
- revokeRequest
- Errors
- 400:
invalid_json,invalid_request; 415:content_type; 503:temporarily_unavailable
POST /api/v1/oauth2/authorization-details
Create an authorization detail
- Permission
oauth2:manage- Request body
- CreateRARInput
- Response
- 201: value
- Errors
- 400:
invalid_json,invalid_request; 401:unauthorized; 404:not_found; 415:content_type
GET /api/v1/oauth2/authorization-details/{clientId}
Get one authorization detail
- Permission
api:access- Path parameters
clientId- Response
- 200: object of any
- Errors
- 401:
unauthorized; 404:not_found
DELETE /api/v1/oauth2/authorization-details/{id}
Delete one authorization detail
- Permission
oauth2:manage- Path parameters
id- Errors
- 401:
unauthorized; 404:not_found
GET /api/v1/oauth2/clients
List clients
- Permission
api:access- Query parameters
limit,offset- Response
- 200: object of any
- Errors
- 401:
unauthorized
GET /oauth2/authorize
List authorize
- Permission
none- Query parameters
acr_values,client_id,code_challenge,code_challenge_method,connection,intent,login_hint,max_age,nonce,organization,principal,prompt,redirect_uri,restarted,scope,state
POST /oauth2/authorize
Create an authorize
- Permission
none- Query parameters
account_id,acr_values,client_id,code,code_challenge,code_challenge_method,csrf_token,decision,email,intent,max_age,method,nonce,organization,password,principal,prompt,recovery_code,redirect_uri,saved,scope,state,step,ticket- Errors
- 400:
code; 401:code; 403:mfa_not_enrolled; 503:step_up_unavailable
POST /oauth2/device
Create a device
- Permission
none- Response
- 200: object of any
- Errors
- 400:
client_retired,invalid_request,unauthorized_client; 401:invalid_client; 500:server_error
POST /oauth2/device/authorize
Create an authorize
- Permission
none- Response
- 200: object of any
- Errors
- 400:
client_retired,invalid_request,unauthorized_client; 401:invalid_client; 500:server_error
POST /oauth2/device/token
Create a token
- Permission
none- Response
- 200: TokenResponse
- Errors
- 400:
access_denied,authorization_pending,expired_token,invalid_grant,invalid_request,slow_down
POST /oauth2/register
Create a register
- Permission
none- Request body
- RegisterInput
- Response
- 201: object of any
- Errors
- 400:
invalid_client_metadata,invalid_json; 401:invalid_token; 403:insufficient_scope; 415:content_type; 503:entitlement_unavailable
GET /oauth2/register/{clientId}
Get one register
- Permission
none- Path parameters
clientId- Response
- 200: RegisteredClient
- Errors
- 401:
invalid_token; 403:invalid_token; 404:invalid_client
PUT /oauth2/register/{clientId}
Replace one register
- Permission
none- Path parameters
clientId- Request body
- RegisterInput
- Response
- 200: RegisteredClient
- Errors
- 400:
invalid_client_metadata,invalid_json; 401:invalid_token; 403:invalid_token; 415:content_type
DELETE /oauth2/register/{clientId}
Delete one register
- Permission
none- Path parameters
clientId- Errors
- 401:
invalid_token; 403:invalid_token; 404:invalid_client
POST /oauth2/revoke
Implements RFC 7009 token revocation. Revoking a refresh or access token ends the Sandscale session it belongs to. Unknown tokens still return 200.
- Permission
none- Query parameters
client_id,client_secret,token,token_type_hint
POST /oauth2/token
Create a token
- Permission
none- Query parameters
client_id,client_secret,code,code_verifier,device_code,grant_type,organization,redirect_uri,refresh_token,scope- Response
- 200: TokenResponse
- Errors
- 400:
access_denied,authorization_pending,expired_token,invalid_grant,slow_down
GET /oauth2/userinfo
Returns the claims of the user an access token was issued to (OIDC Core 5.3). The token must be live, exactly as the authentication middleware requires: a revoked or expired session, a revoked token, a suspended user and an agent or device token are all refused with 401 invalid_token.
- Permission
signed in- Response
- 200: UserInfo
- Errors
- 401:
invalid_token
POST /oauth2/userinfo
Returns the claims of the user an access token was issued to (OIDC Core 5.3). The token must be live, exactly as the authentication middleware requires: a revoked or expired session, a revoked token, a suspended user and an agent or device token are all refused with 401 invalid_token.
- Permission
signed in- Response
- 200: UserInfo
- Errors
- 401:
invalid_token
Objects
object
| Field | Type | Description |
|---|---|---|
current_password | string | |
new_password | string |
object
| Field | Type | Description |
|---|---|---|
scopes | array of string |
ActorClaim
ActorClaim represents the actor in a delegated token (RFC 8693 §4.1).
| Field | Type | Description |
|---|---|---|
sub | string |
TokenIntrospection
The RFC 7662 answer for an agent token or a delegated token (POST /api/v1/auth/token/introspect). An inactive token has only Active false.
| Field | Type | Description |
|---|---|---|
active | boolean | |
scope optional | string | The token's effective scopes: those the agent, and for a person's delegation the person's consent, still cover. |
token_type optional | string | |
exp optional | integer | |
iat optional | integer | |
nbf optional | integer | |
sub optional | string | |
aud optional | string | The token's audience: a resource server accepts only a token whose aud is its own. |
iss optional | string | |
jti optional | string | |
act optional | ActorClaim | Act names the agent acting for the person of a delegated token. |
org_id optional | string | The organization of the token's agent. |
token_use optional | string | TokenUseAgent or TokenUseDelegated. |
consent_id optional | string | The consent a person's delegation was issued under. |
IntrospectionResponse
IntrospectionResponse implements RFC 7662 Token Introspection.
| Field | Type | Description |
|---|---|---|
active | boolean | |
scope optional | string | |
client_id optional | string | |
username optional | string | |
token_type optional | string | |
exp optional | integer | |
iat optional | integer | |
nbf optional | integer | |
sub optional | string | |
aud optional | string | |
iss optional | string | |
jti optional | string | |
mac optional | MACClaim | The person's clearances under mandatory access control, set only on the service node introspection of Base's Key Service: it narrows what Base's own compartment grants allow, never widens it. |
MACClaim
A person's clearances as Base's Key Service receives them (version 2). Base admits a Base compartment B iff B is not in Governed, or some single clearance has a rank of at least Governed[B].Rank and compartments that include all of Governed[B].Compartments. Clearances are never joined: each is one clearance that applies to the person (their own or a group's).
| Field | Type | Description |
|---|---|---|
version | integer | |
clearances | array of MACClearance | |
governed | object of MACGovernance | |
revision optional | string |
MACClearance
One unexpired clearance that applies to the person: its level, the level's rank in the organization's scheme (0 is the lowest), its MAC compartment keys and the Base compartments those compartments map to.
| Field | Type | Description |
|---|---|---|
classification | string | |
rank | integer | |
compartments | array of string | |
base_compartments | array of string |
MACGovernance
The minimum label a single clearance must dominate to receive a lease for a Base compartment the scheme maps: a level (with its rank) and MAC compartment keys.
| Field | Type | Description |
|---|---|---|
classification | string | |
rank | integer | |
compartments | array of string |
API
A registered API.
| Field | Type | Description |
|---|---|---|
id | string | |
identifier | string | |
name | string | |
description | string | |
scopes | array of APIScope | |
access_token_ttl_seconds optional | integer | |
created_at | timestamp | |
updated_at | timestamp |
APIGrant
An application's grant to an API.
| Field | Type | Description |
|---|---|---|
api_id | string | |
identifier | string | |
name | string | |
scopes | array of string |
APIInput
| Field | Type | Description |
|---|---|---|
identifier optional | string | |
name optional | string | |
description optional | string | |
scopes optional | array of APIScope | |
access_token_ttl_seconds | OptionalInt |
APIScope
One scope of an API.
| Field | Type | Description |
|---|---|---|
value | string | |
description | string |
Application
The Applications API's view of a client.
| Field | Type | Description |
|---|---|---|
client_id | string | |
name | string | |
description | string | |
type | string | |
confidential | boolean | |
redirect_uris | array of string | |
logout_uris | array of string | |
allowed_origins | array of string | |
grant_types | array of string | |
token_endpoint_auth_method | string | |
require_pkce | boolean | |
access_token_ttl_seconds optional | integer | |
refresh_token_ttl_seconds optional | integer | |
logo_uri | string | |
assignment_required | boolean | |
dynamically_registered | boolean | |
created_at | timestamp | |
updated_at | timestamp | |
secret_rotated_at optional | timestamp | |
revision | integer | |
audience | string | Who signs in to the application, chosen at creation and never changed: AudienceWorkforce (Sandscale people) or AudienceCustomers (end users of an Entry tenant). |
entry_tenant_id optional | string | The Entry tenant that holds a customers application; null for workforce. |
external_id optional | string | The Entry application id of a customers application once Entry binds it. |
ApplicationInput
| Field | Type | Description |
|---|---|---|
name optional | string | |
type optional | string | |
description optional | string | |
redirect_uris optional | array of string | |
logout_uris optional | array of string | |
allowed_origins optional | array of string | |
grant_types optional | array of string | |
access_token_ttl_seconds | OptionalInt | |
refresh_token_ttl_seconds | OptionalInt | |
logo_uri optional | string | |
audience optional | string | Audience (create only) is workforce (the default) or customers; it never changes. |
entry_tenant_id optional | string | EntryTenantID (create only, required for customers) is the Entry tenant that holds the application; it never changes. |
CreateRARInput
The input for creating an authorization detail
| Field | Type | Description |
|---|---|---|
client_id | string | |
user_id | string | |
org_id | string | |
type | string | |
actions | array of string | |
locations | array of string | |
datatypes | array of string | |
identifier | string | |
privileges | array of string | |
details | JSON | |
expires_in optional | integer object |
CreatedApplication
Create's result: the secret only for a confidential type, shown once.
| Field | Type | Description |
|---|---|---|
application | Application | |
client_secret optional | string |
OptionalInt
A JSON number that tells absent (Set false), null (Set, Null) and a value apart.
| Field | Type | Description |
|---|---|---|
Set | boolean | |
Null | boolean | |
Value | integer |
RegisterInput
| Field | Type | Description |
|---|---|---|
client_name | string | |
client_uri | string | |
logo_uri | string | |
redirect_uris | array of string | |
grant_types | array of string | |
response_types | array of string | |
scope | string | |
token_endpoint_auth_method | string | |
application_type | string | |
contacts | array of string | |
tos_uri | string | |
policy_uri | string | |
jwks_uri | string | |
software_id | string | |
software_version | string | |
org_id | string |
RegisteredClient
| Field | Type | Description |
|---|---|---|
id | string | |
client_id | string | |
client_name | string | |
client_uri optional | string | |
logo_uri optional | string | |
redirect_uris | array of string | |
grant_types | array of string | |
response_types | array of string | |
scope | string | |
token_endpoint_auth_method | string | |
contacts optional | array of string | |
tos_uri optional | string | |
policy_uri optional | string | |
jwks_uri optional | string | |
software_id optional | string | |
software_version optional | string | |
org_id optional | string | |
registration_client_uri optional | string | |
client_id_issued_at | timestamp | |
updated_at | timestamp |
RotatedSecret
RotateSecret's result, shown once.
| Field | Type | Description |
|---|---|---|
client_secret | string | |
secret_rotated_at | timestamp |
TokenResponse
| Field | Type | Description |
|---|---|---|
access_token | string | |
token_type | string | |
expires_in optional | integer | |
refresh_token optional | string | |
scope optional | string | |
id_token optional | string | |
issued_token_type optional | string | |
principal_type optional | string | "root" for a root user session and empty otherwise; AuthTime (Unix seconds) and AccountID come with it, so the console renders the session from Sandscale's answer instead of reading the token. |
auth_time optional | integer | |
account_id optional | string | |
organization_id optional | string | The organization of the new session of an organization selection; empty for every other grant. |
Discovery
| Field | Type | Description |
|---|---|---|
issuer | string | |
authorization_endpoint | string | |
token_endpoint | string | |
userinfo_endpoint | string | |
jwks_uri | string | |
response_types_supported | array of string | |
subject_types_supported | array of string | |
id_token_signing_alg_values_supported | array of string | |
scopes_supported | array of string | |
claims_supported | array of string | |
code_challenge_methods_supported | array of string | |
device_authorization_endpoint | string | Where an app that cannot open a browser starts the device authorization grant. |
grant_types_supported | array of string | |
authorization_response_iss_parameter_supported | boolean | AuthorizationResponseIssParameterSupported says every authorization response carries the issuer in the iss parameter (RFC 9207), so a client can detect a mix-up attack. |
acr_values_supported | array of string | The acr values ID tokens carry and acr_values may request. |
prompt_values_supported | array of string | The prompt values the authorization endpoint honours. |
UserInfo
| Field | Type | Description |
|---|---|---|
sub | string | |
name optional | string | |
email optional | string | |
email_verified optional | boolean | |
org_id optional | string |
AuthenticationOptions
| Field | Type | Description |
|---|---|---|
challenge | string | |
timeout | integer | |
rpId | string | |
userVerification | string | |
allowCredentials optional | array of CredentialDescriptor |
CredentialDescriptor
| Field | Type | Description |
|---|---|---|
type | string | |
id | string | |
transports optional | array of string |
introspectRequest
| Field | Type | Description |
|---|---|---|
token | string | |
token_type_hint | string | |
client_id | string | |
client_secret | string |
loginRequest
| Field | Type | Description |
|---|---|---|
email | string | |
password | string | |
organization_id | string | |
totp | string | |
recovery_code | string | |
remember_me | boolean | |
device_token | string | The remembered-device token a previous step-up returned (device_token). |
passkeyBeginRequest
| Field | Type | Description |
|---|---|---|
email | string | |
organization_id | string |
passkeyCompleteRequest
| Field | Type | Description |
|---|---|---|
response | JSON | |
totp | string | |
recovery_code | string |
refreshRequest
| Field | Type | Description |
|---|---|---|
refresh_token | string |
revokeRequest
| Field | Type | Description |
|---|---|---|
token | string | |
token_type_hint | string |
revokeSessionRequest
| Field | Type | Description |
|---|---|---|
session_id | string |
validatePasswordRequest
| Field | Type | Description |
|---|---|---|
password | string | |
organization_id | string |
verifyRecoveryCodeRequest
| Field | Type | Description |
|---|---|---|
user_id | string | |
code | 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.