/
Contact usSee pricingStart building
    Introduction
    Overview
    Postman
    Users
      Create user
      Search users
      Get user
      Update user
      Exchange primary factor

    • Delete

        • Delete user
        Delete user email
        Delete user phone number
        Delete user WebAuthn registration
        Delete user biometric registration
        Delete user TOTP
        Delete user crypto wallet
        Delete user password
        Delete user OAuth registration
    Magic links

    • Via email

        • Send magic link
        Log in or create user
        Invite
        Revoke pending invite

    • Embeddable

        • Create
      Authenticate
    OAuth
      Attach
      Authenticate

    • Start

        • Google
        Amazon
        Apple
        Bitbucket
        Coinbase
        Discord
        Facebook
        Figma
        GitHub
        GitLab
        Linkedin
        Microsoft
        Salesforce
        Slack
        Snapchat
        TikTok
        Twitch
        Twitter
        Yahoo
    Passwords
      Create
      Authenticate
      Strength check
      Migrate

    • Reset options

        • Password reset by email start
        Password reset by email
        Password reset by existing password
        Password reset by session
    One-time passcodes (OTP)

    • Via SMS

        • Send
        Login or create user

    • Via Whatsapp

        • Send
        Login or create user

    • Via email

        • Send
        Login or create user
      Authenticate
    Session management
      Session object
      Get JWKS
      Get sessions
      Authenticate Session
      Revoke session
      Migrate session
    Passkeys & WebAuthn

    • Register

        • Start
        Register

    • Authenticate

        • Start
        Authenticate
      Update
      List WebAuthn Credentials
    Time-based one-time passcodes (TOTP)
      Create
      Authenticate
      Get recovery codes
      Recover
    Crypto wallets
      Authenticate start
      Authenticate
    M2M Authentication
      M2M Client Object

    • Token

        • Get Access Token
        Authenticate Access Token

    • M2M Client

        • Create M2M client
        Get M2M client
        Search M2M clients
        Update M2M client
        Delete M2M client

    • Rotate secret

        • Start secret rotation
        Rotate secret
        Cancel secret rotation
    Connected AppsBeta
      Get Access Token

    • Tokens

        • Connected App ID Token Object
        Connected App Access Token Object

    • Configuration

        • Get JWKS
        Get OpenID Configuration

    • Methods

        • Introspect Token
        Authenticate Access Token (Local)
        Exchange Access Token
        Revoke Token
        Get UserInfo

    • Management

        • Dynamic Client Registration
        Get Authorized Connected Apps for a User
        Revoke Connected App Access to a User
    User Impersonation
      Authenticate Token
    Resources
      Email templates
      URL validation
      Metadata
      User states
    Errors
      Overview
      Error object
      400
      401
      403
      404
      405
      429
      499
      500
      503
Get support on SlackVisit our developer forum

Contact us

Consumer Authentication

/

API reference

/

Connected Apps

/

Tokens

/

Connected App ID Token Object

Connected App ID Token object

An ID Token is a security token that contains claims about theUserissued by Stytch to a particular Connected App Client.

ID Tokens are issued by the Token Endpoint automatically when the openid scope is granted to the Client during an OAuth flow.

The contents of an ID Token depend on the scopes granted to the client:

  • All ID Tokens will always contain the iss, sub, aud, exp, nbf, and iat claims.
  • If the profile scope is granted, the name, given_name, family_name, profile_picture, and locale claims will be returned.
  • If the email scope is granted, the email and email_verified claims will be returned.
  • If the phone scope is granted, the phone_number and phone_number_verified claims will be returned.

ID tokens granted to Connected App clients are JWTs (JSON Web Tokens) signed by your Stytch project's JWKS (JSON Web Key Set) using the RS256 algorithm. They can be validated locally using any Stytch Backend SDK, or any library that supports the JWT protocol.

ID tokens are defined by the OpenID Connect Core specification.

Fields

iss string
sub string
aud string
exp string
nbf string
iat string
name string
given_name string
middle_name string
family_name string
picture string
locale string
email string
email_verified boolean
phone_number string
phone_number_verified boolean
OBJECT
{
    "iss" : "stytch.com/PROJECT_ID",
    "sub" : "user-test-16d9ba61-97a1-4ba4-9720-b03761dc50c6",
    "aud" : [
        "connected-app-test-d731954d-dab3-4a2b-bdee-07f3ad1be888"
    ],
    "exp" : 1738786128,
    "nbf" : 1738782528,
    "iat" : 1738782528,
    "name" : "Jane Doe",
    "given_name" : "Jane",
    "family_name" : "Doe",
    "middle_name" : "",
    "email" : "sandbox@stytch.com",
    "email_verified" : true,
    "phone_number" : "+12025550162",
    "phone_number_verified" : true
}