Stytch · Schema

api_organization_v1_GithubProviderInfo

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
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.
provider_tenant_ids array All tenant IDs returned by the OAuth provider. These is typically used to identify organizations or groups within the provider's domain. For example, in HubSpot this is a Hub ID, in Slack this is the
access_token string The `access_token` that you may use to access the User's data in the provider's API.
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.
View JSON Schema on GitHub

JSON Schema

stytch-api-organization-v1-githubproviderinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_organization_v1_GithubProviderInfo",
  "title": "api_organization_v1_GithubProviderInfo",
  "type": "object",
  "properties": {
    "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_tenant_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "All tenant IDs returned by the OAuth provider. These is typically used to identify organizations or groups within the provider's domain. For example, in HubSpot this is a Hub ID, in Slack this is the Workspace ID, and in GitHub this is an organization ID. Some OAuth providers do not return tenant IDs, some providers are guaranteed to return one, and some may return multiple. This field will always be populated if at least one tenant ID was returned from the OAuth provider and developers should prefer this field over `provider_tenant_id`."
    },
    "access_token": {
      "type": "string",
      "description": "The `access_token` that you may use to access the User's data in the provider's API."
    },
    "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."
    }
  },
  "required": [
    "provider_subject",
    "provider_tenant_ids",
    "access_token",
    "scopes"
  ]
}