AuthenticatorType
The type of authenticator| Value | Description |
|---|---|
0 | Time-based one-time password authenticator |
1 | SMS-based authenticator |
2 | WebAuthn authenticator |
AuthLoginResponse
Related endpoints Type: AuthTokenWithUserIdResponse | AuthMfaRequiredResponseAuthMfaRequiredResponse
| Field | Type | Description |
|---|---|---|
| allowed_methods | string[] | List of allowed MFA methods |
| mfa | enum<true> | Indicates MFA is required to complete authentication |
| sms | boolean | Whether SMS MFA is available |
| sms_phone_hint? | ?string | Masked phone number hint for SMS MFA |
| ticket | string | MFA ticket to use when completing MFA verification |
| totp | boolean | Whether TOTP authenticator MFA is available |
| webauthn | boolean | Whether WebAuthn security key MFA is available |
AuthorizeIpRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| token | string | The IP authorization token from email |
AuthRegisterResponse
Related endpoints Type: AuthTokenWithUserIdResponse | AuthMfaRequiredResponseAuthSessionClientInfo
| Field | Type | Description |
|---|---|---|
| browser? | ?string | The browser reported by the client |
| location? | ?AuthSessionLocation | The geolocation data sent by the client |
| os? | ?string | The operating system reported by the client |
| platform? | ?string | The platform reported by the client |
AuthSessionLocation
| Field | Type | Description |
|---|---|---|
| city? | ?string | The city name reported by the client |
| country? | ?string | The country reported by the client |
| region? | ?string | The region reported by the client |
AuthSessionResponse
| Field | Type | Description |
|---|---|---|
| approx_last_used_at? | ?string (date-time) | Approximate timestamp of the last session activity |
| client_info? | ?AuthSessionClientInfo | Client metadata recorded for this session |
| current | boolean | Whether this is the current session making the request |
| id_hash | SnowflakeType | The base64url-encoded session id hash |
AuthSessionsResponse
Related endpoints Type: AuthSessionResponse[]AuthTokenWithUserIdResponse
Related endpointsPOST /auth/login/mfa/smsPOST /auth/login/mfa/totpPOST /auth/login/mfa/webauthnPOST /auth/webauthn/authenticate
| Field | Type | Description |
|---|---|---|
| token | string | Authentication token for API requests |
| user_id | SnowflakeType | ID of the authenticated user |
EmailRevertRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| password | PasswordType | |
| token | string | Email revert token from email |
ForgotPasswordRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| EmailType |
HandoffCompleteRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| code | string | The handoff code from the initiating session |
| token | string | The authentication token to transfer |
| user_id | SnowflakeType | The user ID associated with the token |
HandoffInitiateResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| code | string | Handoff code to share with the receiving device |
| expires_at | string (date-time) | ISO 8601 timestamp when the handoff code expires |
HandoffStatusResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| status | string | Current status of the handoff (pending, completed, expired) |
| token? | ?string | Authentication token if handoff is complete |
| user_id? | ?SnowflakeType | User ID if handoff is complete |
IpAuthorizationPollResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| completed | boolean | Whether the IP authorization has been completed |
| token? | ?string | Authentication token if authorization is complete |
| user_id? | ?SnowflakeType | User ID if authorization is complete |
LoginRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| EmailType | ||
| invite_code? | ?string | Guild invite code to join after login |
| password | PasswordType |
LogoutAuthSessionsRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| password? | PasswordType | |
| session_id_hashes | SnowflakeType[] | Array of session ID hashes to log out (max 100) |
MfaBackupCodeResponse
| Field | Type | Description |
|---|---|---|
| code | string | The backup code |
| consumed | boolean | Whether the code has been used |
MfaSmsRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| code | string | The SMS verification code |
| ticket | string | The MFA ticket from the login response |
MfaTicketRequest
Related endpointsPOST /auth/ip-authorization/resendPOST /auth/login/mfa/sms/sendPOST /auth/login/mfa/webauthn/authentication-options
| Field | Type | Description |
|---|---|---|
| ticket | string | The MFA ticket from the login response |
MfaTotpRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| code | string | The TOTP code from the authenticator app |
| ticket | string | The MFA ticket from the login response |
RegisterRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| consent | boolean | Whether user consents to terms of service |
| date_of_birth | string | Date of birth in YYYY-MM-DD format |
| email? | EmailType | |
| global_name? | string | Display name shown to other users |
| invite_code? | ?string | Guild invite code to join after registration |
| password? | PasswordType | |
| username? | UsernameType |
ResetPasswordRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| password | PasswordType | |
| token | string | Password reset token from email |
SsoCompleteRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| code | string | Authorization code from the SSO provider |
| state | string | State parameter for CSRF protection |
SsoCompleteResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| redirect_to | string | URL to redirect the user to after completion |
| token | string | Authentication token for the session |
| user_id | SnowflakeType | ID of the authenticated user |
SsoConfigResponse
| Field | Type | Description |
|---|---|---|
| allowed_domains | string[] | |
| authorization_url | ?string | |
| auto_provision | boolean | |
| client_id | ?SnowflakeType | |
| client_secret_set | boolean | |
| display_name | ?string | |
| enabled | boolean | |
| issuer | ?string | |
| jwks_url | ?string | |
| redirect_uri | ?string | |
| scope | ?string | |
| token_url | ?string | |
| userinfo_url | ?string |
SsoStartRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| redirect_to? | ?string | URL to redirect to after SSO completion |
SsoStartResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| authorization_url | string | URL to redirect user to for SSO authentication |
| redirect_uri | string | Redirect URI after SSO completion |
| state | string | State parameter for CSRF protection |
SsoStatusResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| display_name | ?string | Display name of the SSO provider |
| enabled | boolean | Whether SSO is enabled for this instance |
| enforced | boolean | Whether SSO is required for all users |
| redirect_uri | string | OAuth redirect URI for SSO |
UsernameSuggestionsRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| global_name | string | Display name to generate username suggestions from |
UsernameSuggestionsResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| suggestions | string[] | List of suggested usernames |
VerifyEmailRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| token | string | Email verification token from email |
WebAuthnAuthenticateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| challenge | string | The challenge string from authentication options |
| response | JSON value | WebAuthn authentication response |
WebAuthnAuthenticationOptionsResponse
Related endpoints Type: JSON valueWebAuthnCredentialResponse
| Field | Type | Description |
|---|---|---|
| created_at | string | When the credential was registered |
| id | SnowflakeType | The credential ID |
| last_used_at | ?string | When the credential was last used |
| name | string | User-assigned name for the credential |
WebAuthnMfaRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| challenge | string | The challenge string from authentication options |
| response | JSON value | WebAuthn authentication response |
| ticket | string | The MFA ticket from the login response |