Stytch · Schema

api_b2b_idp_v1_b2b_idp_oauth_AuthorizeRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
consent_granted	boolean	Indicates whether the user granted the requested scopes.
scopes	array	An array of scopes requested by the client.
client_id	string	The ID of the Connected App client.
redirect_uri	string	The callback URI used to redirect the user after authentication. This is the same URI provided at the start of the OAuth flow. This field is required when using the `authorization_code` grant.
response_type	string	The OAuth 2.0 response type. For authorization code flows this value is `code`.
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. You may also use the organi
member_id	string	Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set
session_token	string	A secret token for a given Stytch Session.
session_jwt	string	The JSON Web Token (JWT) for a given Stytch Session.
prompt	string	Space separated list that specifies how the Authorization Server should prompt the user for reauthentication and consent. Only `consent` is supported today.
state	string	An opaque value used to maintain state between the request and callback.
nonce	string	A string used to associate a client session with an ID token to mitigate replay attacks.
code_challenge	string	A base64url encoded challenge derived from the code verifier for PKCE flows.
resources	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_idp_v1_b2b_idp_oauth_AuthorizeRequest",
  "title": "api_b2b_idp_v1_b2b_idp_oauth_AuthorizeRequest",
  "type": "object",
  "properties": {
    "consent_granted": {
      "type": "boolean",
      "description": "Indicates whether the user granted the requested scopes."
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of scopes requested by the client."
    },
    "client_id": {
      "type": "string",
      "description": "The ID of the Connected App client."
    },
    "redirect_uri": {
      "type": "string",
      "description": "The callback URI used to redirect the user after authentication. This is the same URI provided at the start of the OAuth flow.  This field is required when using the `authorization_code` grant."
    },
    "response_type": {
      "type": "string",
      "description": "The OAuth 2.0 response type. For authorization code flows this value is `code`."
    },
    "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. You may also use the organization_slug or organization_external_id here as a convenience."
    },
    "member_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member."
    },
    "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."
    },
    "prompt": {
      "type": "string",
      "description": "Space separated list that specifies how the Authorization Server should prompt the user for reauthentication and consent. Only `consent` is supported today."
    },
    "state": {
      "type": "string",
      "description": "An opaque value used to maintain state between the request and callback."
    },
    "nonce": {
      "type": "string",
      "description": "A string used to associate a client session with an ID token to mitigate replay attacks."
    },
    "code_challenge": {
      "type": "string",
      "description": "A base64url encoded challenge derived from the code verifier for PKCE flows."
    },
    "resources": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "Request type",
  "required": [
    "consent_granted",
    "scopes",
    "client_id",
    "redirect_uri",
    "response_type"
  ]
}