{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/ConnectionOptionsGitHub", "title": "ConnectionOptionsGitHub", "description": "Options for the 'github' connection", "type": "object", "additionalProperties": true, "allOf": [ { "$ref": "#/components/schemas/ConnectionOptionsCommon" }, { "type": "object", "properties": { "client_id": { "$ref": "#/components/schemas/ConnectionOptionsClientIdGithub" }, "client_secret": { "$ref": "#/components/schemas/ConnectionOptionsClientSecretGithub" }, "freeform_scopes": { "$ref": "#/components/schemas/ConnectionOptionsFreeformScopesGithub" }, "scope": { "$ref": "#/components/schemas/ConnectionOptionsScopeGithub" }, "set_user_root_attributes": { "$ref": "#/components/schemas/ConnectionSetUserRootAttributesEnum" }, "upstream_params": { "$ref": "#/components/schemas/ConnectionUpstreamParams" } } }, { "type": "object", "properties": { "admin_org": { "type": "boolean", "default": false, "description": "Requests the GitHub admin:org scope so Auth0 can fully manage organizations, teams, and memberships on behalf of the user." }, "admin_public_key": { "type": "boolean", "default": false, "description": "Requests the admin:public_key scope to allow creating, updating, and deleting the user's SSH public keys." }, "admin_repo_hook": { "type": "boolean", "default": false, "description": "Requests the admin:repo_hook scope so Auth0 can read, write, ping, and delete repository webhooks." }, "delete_repo": { "type": "boolean", "default": false, "description": "Requests the delete_repo scope so the user can remove repositories they administer while signing in through Auth0." }, "email": { "type": "boolean", "default": false, "description": "Requests the user:email scope so Auth0 pulls addresses from GitHub's /user/emails endpoint and populates the profile." }, "follow": { "type": "boolean", "default": false, "description": "Requests the user:follow scope to allow following or unfollowing GitHub users for the signed-in account." }, "gist": { "type": "boolean", "default": false, "description": "Requests the gist scope so the application can create or update gists on behalf of the user." }, "notifications": { "type": "boolean", "default": false, "description": "Requests the notifications scope to read GitHub inbox notifications; repo also implicitly grants this access." }, "profile": { "default": true, "description": "Controls the GitHub read:user call that returns the user's basic profile (name, avatar, profile URL) and is on by default for successful logins.", "type": "boolean" }, "public_repo": { "type": "boolean", "default": false, "description": "Requests the public_repo scope for read and write operations on public repositories, deployments, and statuses." }, "read_org": { "type": "boolean", "default": false, "description": "Requests the read:org scope so Auth0 can view organizations, teams, and membership lists without making changes." }, "read_public_key": { "type": "boolean", "default": false, "description": "Requests the read:public_key scope so Auth0 can list and inspect the user's SSH public keys." }, "read_repo_hook": { "type": "boolean", "default": false, "description": "Requests the read:repo_hook scope to read and ping repository webhooks." }, "read_user": { "type": "boolean", "default": false, "description": "Requests the read:user scope to load extended profile information, implicitly covering user:email and user:follow." }, "repo": { "type": "boolean", "default": false, "description": "Requests the repo scope for read and write access to both public and private repositories, deployments, and statuses." }, "repo_deployment": { "type": "boolean", "default": false, "description": "Requests the repo_deployment scope in order to read and write deployment statuses for repositories." }, "repo_status": { "type": "boolean", "default": false, "description": "Requests the repo:status scope to manage commit statuses on public and private repositories." }, "write_org": { "type": "boolean", "default": false, "description": "Requests the write:org scope so Auth0 can change whether organization memberships are publicized." }, "write_public_key": { "type": "boolean", "default": false, "description": "Requests the write:public_key scope to create or update SSH public keys for the user." }, "write_repo_hook": { "type": "boolean", "default": false, "description": "Requests the write:repo_hook scope so Auth0 can read, create, update, and ping repository webhooks." } } } ] }