App Permissions
objectThe permissions granted to the user-to-server access token.
The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for checks on code. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for deployments and deployment statuses. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for managing repository environments. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: read, write, or admin.
Allowed values:readwriteadmin
The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage repository secrets. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage just a single file. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for commit statuses. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage Dependabot alerts. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: write.
Allowed values:write
The level of permission to grant the access token for organization teams and members. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage access to an organization. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for viewing an organization’s plan. Can be one of: read.
Allowed values:read
The level of permission to grant the access token to manage organization projects and projects beta (where available). Can be one of: read, write, or admin.
Allowed values:readwriteadmin
The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage organization secrets. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token to manage team discussions and related comments. Can be one of: read or write.
Allowed values:readwrite
The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: read or write.
Allowed values:readwrite
Simple User
objectSimple User
Example:octocat
Example:1
Example:MDQ6VXNlcjE=
Example:https://github.com/images/error/octocat_happy.gif
Example:41d064eb2195891e12d0413f63227ea7
Example:https://api.github.com/users/octocat
Example:https://github.com/octocat
Example:https://api.github.com/users/octocat/followers
Example:https://api.github.com/users/octocat/following{/other_user}
Example:https://api.github.com/users/octocat/gists{/gist_id}
Example:https://api.github.com/users/octocat/starred{/owner}{/repo}
Example:https://api.github.com/users/octocat/subscriptions
Example:https://api.github.com/users/octocat/orgs
Example:https://api.github.com/users/octocat/repos
Example:https://api.github.com/users/octocat/events{/privacy}
Example:https://api.github.com/users/octocat/received_events
Example:User
Example:"2020-07-09T00:17:55Z"
Scoped Installation
objectThe permissions granted to the user-to-server access token.
Example:{"contents":"read","issues":"read","deployments":"write","single_file":"read"}
Show Child Parameters
Describe whether all repositories have been selected or there’s a selection involved
Allowed values:allselected
Example:config.yaml
Example:true
Example:config.yml, .github/issue_TEMPLATE.md
Example:https://api.github.com/users/octocat/repos
Simple User
Show Child Parameters
Authorization
objectThe authorization for an OAuth app, GitHub App, or a Personal Access Token.
A list of scopes that this authorization is in.
Show Child Parameters
Simple User
Show Child Parameters
Show Child Parameters
GitHub app
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
Unique identifier of the GitHub app
Example:37
The slug name of the GitHub app
Example:probot-owners
Example:MDExOkludGVncmF0aW9uMQ==
Simple User
Show Child Parameters
The name of the GitHub app
Example:Probot Owners
Example:The description of the app.
Example:https://example.com
Example:https://github.com/apps/super-ci
Example:2017-07-08T16:18:44-04:00
Example:2017-07-08T16:18:44-04:00
The set of permissions for the GitHub app
Example:{"issues":"read","deployments":"write"}
Show Child Parameters
The list of events for the GitHub app
Example:label, deployment
The number of installations associated with the GitHub app
Example:5
Example:"Iv1.25b5d1e65ffc4022"
Example:"1d4b2097ac622ba702d19de498f005747a8b21d3"
Example:"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"
Example:"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"