stytch_codecs - v1.0.0-rc2

stytch_codecs

Types

AuthenticateResponse

</>

Response from Stytch when attempting to autenticate with any method.

pub type AuthenticateResponse {
  AuthenticateResponse(
    status_code: Int,
    request_id: String,
    user_id: String,
    method_id: String,
    session_token: String,
    session_jwt: String,
  )
}

Constructors 

  • AuthenticateResponse(
  status_code: Int,
  request_id: String,
  user_id: String,
  method_id: String,
  session_token: String,
  session_jwt: String,
)

Email

</>

Email identifying a user. Stytch separates email_id (not PII) from email and indicates whether the user has verified that they can access that address.

pub type Email {
  Email(email_id: String, email: String, verified: Bool)
}

Constructors 

  • Email(email_id: String, email: String, verified: Bool)

LoginOrCreateResponse

</>

Response to a request to create or log into an account.

Used by both magic links and OTP login_or_create

pub type LoginOrCreateResponse {
  LoginOrCreateResponse(
    status_code: Int,
    request_id: String,
    user_id: String,
    email_id: String,
  )
}

Constructors 

  • LoginOrCreateResponse(
  status_code: Int,
  request_id: String,
  user_id: String,
  email_id: String,
)

MagicLinkLoginOrCreateRequest

</>

Request to create a magic link. When stytch receives this request, it will send an e-mail, authenticate the user in the clicked link, and redirect back to somewhere in your service.

pub type MagicLinkLoginOrCreateRequest {
  MagicLinkLoginOrCreateRequest(email: String)
}

Constructors 

  • MagicLinkLoginOrCreateRequest(email: String)

Name

</>

Name identifying a user.

pub type Name {
  Name(
    first_name: String,
    middle_name: String,
    last_name: String,
  )
}

Constructors 

  • Name(first_name: String, middle_name: String, last_name: String)

PasscodeAuthenticateRequest

</> 
pub type PasscodeAuthenticateRequest {
  PasscodeAuthenticateRequest(
    code: String,
    method_id: String,
    session_duration_minutes: Int,
  )
}

Constructors 

  • PasscodeAuthenticateRequest(
  code: String,
  method_id: String,
  session_duration_minutes: Int,
)

PasscodeLoginOrCreateRequest

</>

Request to log in with a passcode. When stytch receives this it will send a passcode to the user’s e-mail address. It is up to you to process the passcode and authenticate it with stytch.

pub type PasscodeLoginOrCreateRequest {
  PasscodeLoginOrCreateRequest(email: String)
}

Constructors 

  • PasscodeLoginOrCreateRequest(email: String)

PasskeyAuthenticateRequest

</>

Complete passkey authentication, passing the credential returned by the browser’s navigator.credentials.get() call as a JSON string.

pub type PasskeyAuthenticateRequest {
  PasskeyAuthenticateRequest(
    public_key_credential: String,
    session_duration_minutes: Int,
  )
}

Constructors 

  • PasskeyAuthenticateRequest(
  public_key_credential: String,
  session_duration_minutes: Int,
)

PasskeyAuthenticateStartRequest

</>

Start authenticating with a passkey. No user_id is supplied; the browser’s passkey picker identifies the user via discoverable credentials.

pub type PasskeyAuthenticateStartRequest {
  PasskeyAuthenticateStartRequest(
    domain: String,
    use_base64_url_encoding: Bool,
    return_passkey_credential_options: Bool,
  )
}

Constructors 

  • PasskeyAuthenticateStartRequest(
  domain: String,
  use_base64_url_encoding: Bool,
  return_passkey_credential_options: Bool,
)

PasskeyAuthenticateStartResponse

</>

Response to a request to start passkey authentication.

pub type PasskeyAuthenticateStartResponse {
  PasskeyAuthenticateStartResponse(
    request_id: String,
    user_id: String,
    public_key_credential_request_options: String,
    status_code: Int,
  )
}

Constructors 

  • PasskeyAuthenticateStartResponse(
  request_id: String,
  user_id: String,
  public_key_credential_request_options: String,
  status_code: Int,
)

PasskeyCredentialPayload

</>

Payload sent by a browser after a WebAuthn ceremony. The server is responsible for adding the authenticated user’s id and session policy before forwarding to Stytch — the browser must not assert identity.

pub type PasskeyCredentialPayload {
  PasskeyCredentialPayload(public_key_credential: String)
}

Constructors 

  • PasskeyCredentialPayload(public_key_credential: String)

PasskeyRegisterFinishRequest

</>

Complete registering a new passkey, passing the credential created by the browser’s navigator.credentials.create() call as a JSON string.

pub type PasskeyRegisterFinishRequest {
  PasskeyRegisterFinishRequest(
    user_id: String,
    public_key_credential: String,
    session_duration_minutes: Int,
  )
}

Constructors 

  • PasskeyRegisterFinishRequest(
  user_id: String,
  public_key_credential: String,
  session_duration_minutes: Int,
)

PasskeyRegisterStartRequest

</>

Start registering a new passkey for a user with a known id.

pub type PasskeyRegisterStartRequest {
  PasskeyRegisterStartRequest(
    user_id: String,
    domain: String,
    use_base64_url_encoding: Bool,
    return_passkey_credential_options: Bool,
    user_agent: option.Option(String),
  )
}

Constructors 

  • PasskeyRegisterStartRequest(
  user_id: String,
  domain: String,
  use_base64_url_encoding: Bool,
  return_passkey_credential_options: Bool,
  user_agent: option.Option(String),
)

PasskeyRegisterStartResponse

</>

Response to a request to register a new passkey for an authenticated user.

pub type PasskeyRegisterStartResponse {
  PasskeyRegisterStartResponse(
    request_id: String,
    user_id: String,
    public_key_credential_creation_options: String,
    status_code: Int,
  )
}

Constructors 

  • PasskeyRegisterStartResponse(
  request_id: String,
  user_id: String,
  public_key_credential_creation_options: String,
  status_code: Int,
)

PasskeySessionResponse

</>

Response to a completed passkey registration or authentication. Both Stytch endpoints return the same shape: session credentials plus the full user.

pub type PasskeySessionResponse {
  PasskeySessionResponse(
    request_id: String,
    user_id: String,
    webauthn_registration_id: String,
    session_token: String,
    session_jwt: String,
    user: StytchUser,
    status_code: Int,
  )
}

Constructors 

  • PasskeySessionResponse(
  request_id: String,
  user_id: String,
  webauthn_registration_id: String,
  session_token: String,
  session_jwt: String,
  user: StytchUser,
  status_code: Int,
)

SessionAuthenticateResponse

</> 
pub type SessionAuthenticateResponse {
  SessionAuthenticateResponse(
    status_code: Int,
    request_id: String,
    user: StytchUser,
    session_token: String,
    session_jwt: String,
  )
}

Constructors 

  • SessionAuthenticateResponse(
  status_code: Int,
  request_id: String,
  user: StytchUser,
  session_token: String,
  session_jwt: String,
)

SessionRevokeRequest

</>

Request to revoke a session.

Use for signout.

pub type SessionRevokeRequest {
  SessionRevokeRequest(session_token: String)
}

Constructors 

  • SessionRevokeRequest(session_token: String)

SessionRevokeResponse

</>

Response from stytch to a request to revoke a given session token.

pub type SessionRevokeResponse {
  SessionRevokeResponse(request_id: String, status_code: Int)
}

Constructors 

  • SessionRevokeResponse(request_id: String, status_code: Int)

SessionTokenAuthenticateRequest

</> 
pub type SessionTokenAuthenticateRequest {
  SessionTokenAuthenticateRequest(
    session_token: String,
    session_duration_minutes: Int,
  )
}

Constructors 

  • SessionTokenAuthenticateRequest(
  session_token: String,
  session_duration_minutes: Int,
)

StytchClientError

</>

Error messages received from the stytch service

pub type StytchClientError {
  StytchClientError(
    status_code: Int,
    request_id: String,
    error_type: String,
    error_message: String,
    error_url: String,
  )
}

Constructors 

  • StytchClientError(
  status_code: Int,
  request_id: String,
  error_type: String,
  error_message: String,
  error_url: String,
)

StytchUser

</> 
pub type StytchUser {
  StytchUser(
    user_id: String,
    name: Name,
    emails: List(Email),
    webauthn_registrations: List(WebAuthnRegistration),
  )
}

Constructors

TokenAuthenticateRequest

</>

Request to authenticate a stytch token returned from login.

pub type TokenAuthenticateRequest {
  TokenAuthenticateRequest(
    token: String,
    session_duration_minutes: Int,
  )
}

Constructors 

  • TokenAuthenticateRequest(
  token: String,
  session_duration_minutes: Int,
)

WebAuthnRegistration

</>

A passkey or WebAuthn registration associated with a user.

pub type WebAuthnRegistration {
  WebAuthnRegistration(
    webauthn_registration_id: String,
    domain: String,
    user_agent: String,
    verified: Bool,
    authenticator_type: String,
    name: String,
  )
}

Constructors 

  • WebAuthnRegistration(
  webauthn_registration_id: String,
  domain: String,
  user_agent: String,
  verified: Bool,
  authenticator_type: String,
  name: String,
)

Values

authenticate_response_decoder

</> 
pub fn authenticate_response_decoder() -> decode.Decoder(
  AuthenticateResponse,
)

authenticate_response_to_json

</> 
pub fn authenticate_response_to_json(
  magic_link_authenticate_response: AuthenticateResponse,
) -> json.Json

email_decoder

</> 
pub fn email_decoder() -> decode.Decoder(Email)

email_to_json

</> 
pub fn email_to_json(email: Email) -> json.Json

login_or_create_response_decoder

</> 
pub fn login_or_create_response_decoder() -> decode.Decoder(
  LoginOrCreateResponse,
)

login_or_create_response_to_json

</> 
pub fn login_or_create_response_to_json(
  magic_link_login_or_create_response: LoginOrCreateResponse,
) -> json.Json
</> 
pub fn magic_link_login_or_create_request_decoder() -> decode.Decoder(
  MagicLinkLoginOrCreateRequest,
)
</> 
pub fn magic_link_login_or_create_request_to_json(
  magic_link_login_or_create_request: MagicLinkLoginOrCreateRequest,
) -> json.Json

name_decoder

</> 
pub fn name_decoder() -> decode.Decoder(Name)

name_to_json

</> 
pub fn name_to_json(name: Name) -> json.Json

passcode_authenticate_request_decoder

</> 
pub fn passcode_authenticate_request_decoder() -> decode.Decoder(
  PasscodeAuthenticateRequest,
)

passcode_authenticate_request_to_json

</> 
pub fn passcode_authenticate_request_to_json(
  passcode_authenticate_request: PasscodeAuthenticateRequest,
) -> json.Json

passcode_login_or_create_request_decoder

</> 
pub fn passcode_login_or_create_request_decoder() -> decode.Decoder(
  PasscodeLoginOrCreateRequest,
)

passcode_login_or_create_request_to_json

</> 
pub fn passcode_login_or_create_request_to_json(
  passcode_login_or_create_request: PasscodeLoginOrCreateRequest,
) -> json.Json

passkey_authenticate_request_decoder

</> 
pub fn passkey_authenticate_request_decoder() -> decode.Decoder(
  PasskeyAuthenticateRequest,
)

passkey_authenticate_request_to_json

</> 
pub fn passkey_authenticate_request_to_json(
  passkey_authenticate_request: PasskeyAuthenticateRequest,
) -> json.Json

passkey_authenticate_start_request_decoder

</> 
pub fn passkey_authenticate_start_request_decoder() -> decode.Decoder(
  PasskeyAuthenticateStartRequest,
)

passkey_authenticate_start_request_to_json

</> 
pub fn passkey_authenticate_start_request_to_json(
  passkey_authenticate_start_request: PasskeyAuthenticateStartRequest,
) -> json.Json

passkey_authenticate_start_response_decoder

</> 
pub fn passkey_authenticate_start_response_decoder() -> decode.Decoder(
  PasskeyAuthenticateStartResponse,
)

passkey_authenticate_start_response_to_json

</> 
pub fn passkey_authenticate_start_response_to_json(
  passkey_authenticate_start_response: PasskeyAuthenticateStartResponse,
) -> json.Json

passkey_credential_payload_decoder

</> 
pub fn passkey_credential_payload_decoder() -> decode.Decoder(
  PasskeyCredentialPayload,
)

passkey_credential_payload_to_json

</> 
pub fn passkey_credential_payload_to_json(
  passkey_credential_payload: PasskeyCredentialPayload,
) -> json.Json

passkey_register_finish_request_decoder

</> 
pub fn passkey_register_finish_request_decoder() -> decode.Decoder(
  PasskeyRegisterFinishRequest,
)

passkey_register_finish_request_to_json

</> 
pub fn passkey_register_finish_request_to_json(
  passkey_register_finish_request: PasskeyRegisterFinishRequest,
) -> json.Json

passkey_register_start_request_decoder

</> 
pub fn passkey_register_start_request_decoder() -> decode.Decoder(
  PasskeyRegisterStartRequest,
)

passkey_register_start_request_to_json

</> 
pub fn passkey_register_start_request_to_json(
  passkey_register_start_request: PasskeyRegisterStartRequest,
) -> json.Json

passkey_register_start_response_decoder

</> 
pub fn passkey_register_start_response_decoder() -> decode.Decoder(
  PasskeyRegisterStartResponse,
)

passkey_register_start_response_to_json

</> 
pub fn passkey_register_start_response_to_json(
  passkey_register_start_response: PasskeyRegisterStartResponse,
) -> json.Json

passkey_session_response_decoder

</> 
pub fn passkey_session_response_decoder() -> decode.Decoder(
  PasskeySessionResponse,
)

passkey_session_response_to_json

</> 
pub fn passkey_session_response_to_json(
  passkey_session_response: PasskeySessionResponse,
) -> json.Json

session_authenticate_response_decoder

</> 
pub fn session_authenticate_response_decoder() -> decode.Decoder(
  SessionAuthenticateResponse,
)

session_authenticate_response_to_json

</> 
pub fn session_authenticate_response_to_json(
  session_authenticate_response: SessionAuthenticateResponse,
) -> json.Json

session_revoke_request_decoder

</> 
pub fn session_revoke_request_decoder() -> decode.Decoder(
  SessionRevokeRequest,
)

session_revoke_request_to_json

</> 
pub fn session_revoke_request_to_json(
  session_revoke_request: SessionRevokeRequest,
) -> json.Json

session_revoke_response_decoder

</> 
pub fn session_revoke_response_decoder() -> decode.Decoder(
  SessionRevokeResponse,
)

session_revoke_response_to_json

</> 
pub fn session_revoke_response_to_json(
  session_revoke_response: SessionRevokeResponse,
) -> json.Json

session_token_authenticate_request_decoder

</> 
pub fn session_token_authenticate_request_decoder() -> decode.Decoder(
  SessionTokenAuthenticateRequest,
)

session_token_authenticate_request_to_json

</> 
pub fn session_token_authenticate_request_to_json(
  session_token_authenticate_request: SessionTokenAuthenticateRequest,
) -> json.Json

stytch_client_error_decoder

</> 
pub fn stytch_client_error_decoder() -> decode.Decoder(
  StytchClientError,
)

stytch_client_error_to_json

</> 
pub fn stytch_client_error_to_json(
  stytch_client_error: StytchClientError,
) -> json.Json

stytch_user_decoder

</> 
pub fn stytch_user_decoder() -> decode.Decoder(StytchUser)

stytch_user_to_json

</> 
pub fn stytch_user_to_json(stytch_user: StytchUser) -> json.Json

token_authenticate_request_decoder

</> 
pub fn token_authenticate_request_decoder() -> decode.Decoder(
  TokenAuthenticateRequest,
)

token_authenticate_request_to_json

</> 
pub fn token_authenticate_request_to_json(
  token_authenticate_request: TokenAuthenticateRequest,
) -> json.Json

webauthn_registration_decoder

</> 
pub fn webauthn_registration_decoder() -> decode.Decoder(
  WebAuthnRegistration,
)

webauthn_registration_to_json

</> 
pub fn webauthn_registration_to_json(
  webauthn_registration: WebAuthnRegistration,
) -> json.Json
✨ Search Document