Stytch · Schema

api_organization_v1_organizations_members_oauth_providers_GoogleResponse

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
provider_type string Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc.
provider_subject string The unique identifier for the User within a given OAuth provider. Also commonly called the `sub` or "Subject field" in OAuth protocols.
id_token string The `id_token` returned by the OAuth provider. ID Tokens are JWTs that contain structured information about a user. The exact content of each ID Token varies from provider to provider. ID Tokens are r
scopes array The OAuth scopes included for a given provider. See each provider's section above to see which scopes are included by default and how to add custom scopes.
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
access_token string The `access_token` that you may use to access the User's data in the provider's API.
access_token_expires_in integer The number of seconds until the access token expires.
refresh_token string The `refresh_token` that you may use to obtain a new `access_token` for the User within the provider's API.
View JSON Schema on GitHub

JSON Schema

stytch-api-organization-v1-organizations-members-oauth-providers-go-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_organization_v1_organizations_members_oauth_providers_GoogleResponse",
  "title": "api_organization_v1_organizations_members_oauth_providers_GoogleResponse",
  "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."
    },
    "provider_type": {
      "type": "string",
      "description": "Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc."
    },
    "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."
    },
    "id_token": {
      "type": "string",
      "description": "The `id_token` returned by the OAuth provider. ID Tokens are JWTs that contain structured information about a user. The exact content of each ID Token varies from provider to provider. ID Tokens are returned from OAuth providers that conform to the [OpenID Connect](https://openid.net/foundation/) specification, which is based on OAuth."
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The OAuth scopes included for a given provider. See each provider's section above to see which scopes are included by default and how to add custom scopes."
    },
    "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."
    },
    "access_token": {
      "type": "string",
      "description": "The `access_token` that you may use to access the User's data in the provider's API."
    },
    "access_token_expires_in": {
      "type": "integer",
      "format": "int32",
      "description": "The number of seconds until the access token expires."
    },
    "refresh_token": {
      "type": "string",
      "description": "The `refresh_token` that you may use to obtain a new `access_token` for the User within the provider's API."
    }
  },
  "required": [
    "request_id",
    "provider_type",
    "provider_subject",
    "id_token",
    "scopes",
    "status_code"
  ]
}