Salesforce · Schema

OAuth2

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
type string
description string
flows object
View JSON Schema on GitHub

JSON Schema

salesforce-o-auth2-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "example": "example_value"
    },
    "description": {
      "type": "string",
      "example": "A sample description."
    },
    "flows": {
      "type": "object",
      "properties": {
        "implicit": {
          "type": "object",
          "properties": {
            "authorizationUrl": {
              "type": "string",
              "example": "https://www.example.com"
            },
            "scopes": {
              "type": "object",
              "properties": {
                "visualforce": {
                  "type": "string",
                  "example": "example_value"
                },
                "address": {
                  "type": "string",
                  "example": "example_value"
                },
                "custom_permissions": {
                  "type": "string",
                  "example": "example_value"
                },
                "openid": {
                  "type": "string",
                  "example": "500123"
                },
                "profile": {
                  "type": "string",
                  "example": "example_value"
                },
                "refresh_token": {
                  "type": "string",
                  "example": "CAUQAA"
                },
                "wave_api": {
                  "type": "string",
                  "example": "example_value"
                },
                "web": {
                  "type": "string",
                  "example": "example_value"
                },
                "phone": {
                  "type": "string",
                  "example": "example_value"
                },
                "offline_access": {
                  "type": "string",
                  "example": "example_value"
                },
                "chatter_api": {
                  "type": "string",
                  "example": "example_value"
                },
                "id": {
                  "type": "string",
                  "example": "abc123"
                },
                "api": {
                  "type": "string",
                  "example": "example_value"
                },
                "eclair_api": {
                  "type": "string",
                  "example": "example_value"
                },
                "email": {
                  "type": "string",
                  "example": "user@example.com"
                },
                "pardot_api": {
                  "type": "string",
                  "example": "example_value"
                },
                "full": {
                  "type": "string",
                  "example": "example_value"
                }
              },
              "required": [
                "visualforce",
                "address",
                "custom_permissions",
                "openid",
                "profile",
                "refresh_token",
                "wave_api",
                "web",
                "phone",
                "offline_access",
                "chatter_api",
                "id",
                "api",
                "eclair_api",
                "email",
                "pardot_api",
                "full"
              ]
            }
          },
          "required": [
            "authorizationUrl",
            "scopes"
          ]
        },
        "password": {
          "type": "object",
          "properties": {
            "tokenUrl": {
              "type": "string",
              "example": "https://www.example.com"
            },
            "scopes": {
              "type": "object",
              "properties": {
                "api": {
                  "type": "string",
                  "example": "example_value"
                }
              },
              "required": [
                "api"
              ]
            }
          },
          "required": [
            "tokenUrl",
            "scopes"
          ]
        },
        "authorizationCode": {
          "type": "object",
          "properties": {
            "authorizationUrl": {
              "type": "string",
              "example": "https://www.example.com"
            },
            "tokenUrl": {
              "type": "string",
              "example": "https://www.example.com"
            },
            "scopes": {
              "type": "object",
              "properties": {
                "visualforce": {
                  "type": "string",
                  "example": "example_value"
                },
                "address": {
                  "type": "string",
                  "example": "example_value"
                },
                "custom_permissions": {
                  "type": "string",
                  "example": "example_value"
                },
                "openid": {
                  "type": "string",
                  "example": "500123"
                },
                "profile": {
                  "type": "string",
                  "example": "example_value"
                },
                "refresh_token": {
                  "type": "string",
                  "example": "CAUQAA"
                },
                "wave_api": {
                  "type": "string",
                  "example": "example_value"
                },
                "web": {
                  "type": "string",
                  "example": "example_value"
                },
                "phone": {
                  "type": "string",
                  "example": "example_value"
                },
                "offline_access": {
                  "type": "string",
                  "example": "example_value"
                },
                "chatter_api": {
                  "type": "string",
                  "example": "example_value"
                },
                "id": {
                  "type": "string",
                  "example": "abc123"
                },
                "api": {
                  "type": "string",
                  "example": "example_value"
                },
                "eclair_api": {
                  "type": "string",
                  "example": "example_value"
                },
                "email": {
                  "type": "string",
                  "example": "user@example.com"
                },
                "pardot_api": {
                  "type": "string",
                  "example": "example_value"
                },
                "full": {
                  "type": "string",
                  "example": "example_value"
                }
              },
              "required": [
                "visualforce",
                "address",
                "custom_permissions",
                "openid",
                "profile",
                "refresh_token",
                "wave_api",
                "web",
                "phone",
                "offline_access",
                "chatter_api",
                "id",
                "api",
                "eclair_api",
                "email",
                "pardot_api",
                "full"
              ]
            }
          },
          "required": [
            "authorizationUrl",
            "tokenUrl",
            "scopes"
          ]
        }
      },
      "required": [
        "implicit",
        "password",
        "authorizationCode"
      ]
    }
  },
  "required": [
    "type",
    "description",
    "flows"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OAuth2"
}