Stytch · Schema

api_b2b_impersonation_v1_AuthenticateResponse

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
request_id	string	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
member_id	string	Globally unique UUID that identifies a specific Member.
organization_id	string	Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value.
member	object	The [Member object](https://stytch.com/docs/b2b/api/member-object)
session_token	string	A secret token for a given Stytch Session.
session_jwt	string	The JSON Web Token (JWT) for a given Stytch Session.
organization	object	The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
intermediate_session_token	string	Successfully authenticating an impersonation token will never result in an intermediate session. If the token is valid, a full session will be created.
member_authenticated	boolean	The member will always be fully authenticated if an impersonation token is successfully authenticated.
status_code	integer	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
member_session	object	The [Session object](https://stytch.com/docs/b2b/api/session-object) for the impersonated Member.
mfa_required	object	MFA will not be required when authenticating impersonation tokens.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_impersonation_v1_AuthenticateResponse",
  "title": "api_b2b_impersonation_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."
    },
    "member_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Member."
    },
    "organization_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value."
    },
    "member": {
      "$ref": "#/components/schemas/api_organization_v1_Member",
      "description": "The [Member object](https://stytch.com/docs/b2b/api/member-object)"
    },
    "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."
    },
    "organization": {
      "$ref": "#/components/schemas/api_organization_v1_Organization",
      "description": "The [Organization object](https://stytch.com/docs/b2b/api/organization-object)."
    },
    "intermediate_session_token": {
      "type": "string",
      "description": "Successfully authenticating an impersonation token will never result in an intermediate session. If the token is valid, a full session will be created."
    },
    "member_authenticated": {
      "type": "boolean",
      "description": "The member will always be fully authenticated if an impersonation token is successfully authenticated."
    },
    "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."
    },
    "member_session": {
      "$ref": "#/components/schemas/api_b2b_session_v1_MemberSession",
      "description": "The [Session object](https://stytch.com/docs/b2b/api/session-object) for the impersonated Member."
    },
    "mfa_required": {
      "$ref": "#/components/schemas/api_b2b_mfa_v1_MfaRequired",
      "description": "MFA will not be required when authenticating impersonation tokens."
    }
  },
  "required": [
    "request_id",
    "member_id",
    "organization_id",
    "member",
    "session_token",
    "session_jwt",
    "organization",
    "intermediate_session_token",
    "member_authenticated",
    "status_code"
  ]
}