Stytch · Schema

api_idp_v1_idp_oauth_AuthorizeStartRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
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`.
scopes	array	An array of scopes requested by the client.
user_id	string	The unique ID of a specific User. You may use an `external_id` here if one is set for the user.
session_token	string	The `session_token` associated with a User's existing Session.
session_jwt	string	The `session_jwt` associated with a User's existing 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.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_idp_v1_idp_oauth_AuthorizeStartRequest",
  "title": "api_idp_v1_idp_oauth_AuthorizeStartRequest",
  "type": "object",
  "properties": {
    "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`."
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of scopes requested by the client."
    },
    "user_id": {
      "type": "string",
      "description": "The unique ID of a specific User. You may use an `external_id` here if one is set for the user."
    },
    "session_token": {
      "type": "string",
      "description": "The `session_token` associated with a User's existing Session."
    },
    "session_jwt": {
      "type": "string",
      "description": "The `session_jwt` associated with a User's existing 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."
    }
  },
  "description": "Request type",
  "required": [
    "client_id",
    "redirect_uri",
    "response_type",
    "scopes"
  ]
}