api_oauth_v1_AuthenticateResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_oauth_v1_AuthenticateResponse",
  "title": "api_oauth_v1_AuthenticateResponse",
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue."
    },
    "user_id": {
      "type": "string",
      "description": "The unique ID of the affected User."
    },
    "provider_subject": {
      "type": "string",
      "description": "The unique identifier for the User within a given OAuth provider. Also commonly called the \"sub\" or \"Subject field\" in OAuth protocols."
    },
    "provider_type": {
      "type": "string",
      "description": "Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Facebook, GitHub etc."
    },
    "session_token": {
      "type": "string",
      "description": "A secret token for a given Stytch Session."
    },
    "session_jwt": {
      "type": "string",
      "description": "The JSON Web Token (JWT) for a given Stytch Session."
    },
    "provider_values": {
      "$ref": "#/components/schemas/api_oauth_v1_ProviderValues",
      "description": "The `provider_values` object lists relevant identifiers, values, and scopes for a given OAuth provider. For example this object will include a provider's `access_token` that you can use to access the provider's API for a given user.\n\n  Note that these values will vary based on the OAuth provider in question, e.g. `id_token` is only returned by OIDC compliant identity providers."
    },
    "user": {
      "$ref": "#/components/schemas/api_user_v1_User",
      "description": "The `user` object affected by this API call. See the [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details."
    },
    "reset_sessions": {
      "type": "boolean",
      "description": "Indicates if all other of the User's Sessions need to be reset. You should check this field if you aren't using Stytch's Session product. If you are using Stytch's Session product, we revoke the User's other sessions for you."
    },
    "oauth_user_registration_id": {
      "type": "string",
      "description": "The unique ID for an OAuth registration."
    },
    "status_code": {
      "type": "integer",
      "format": "int32",
      "description": "The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors."
    },
    "user_session": {
      "$ref": "#/components/schemas/api_session_v1_Session",
      "description": "A `Session` object. For backwards compatibility reasons, the session from an OAuth authenticate call is labeled as `user_session`, but is otherwise just a standard stytch `Session` object.\n\n  See [Session object](https://stytch.com/docs/api/session-object) for complete response fields.\n  "
    },
    "user_device": {
      "$ref": "#/components/schemas/api_device_history_v1_DeviceInfo",
      "description": "If a valid `telemetry_id` was passed in the request and the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `user_device` response field will contain information about the user's device attributes."
    }
  },
  "required": [
    "request_id",
    "user_id",
    "provider_subject",
    "provider_type",
    "session_token",
    "session_jwt",
    "provider_values",
    "user",
    "reset_sessions",
    "oauth_user_registration_id",
    "status_code"
  ]
}