# app-permissions

From **GitHub v3 REST API**.

The permissions granted to the user-to-server access token.

- Type: `object`
- Example: `{
  "contents": "read",
  "deployments": "write",
  "issues": "read",
  "single_file": "read"
}`

## Properties

### `actions`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.

### `administration`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `checks`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.

### `content_references`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `contents`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `deployments`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.

### `environments`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.

### `issues`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `members`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.

### `metadata`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `organization_administration`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.

### `organization_hooks`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `organization_packages`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.

### `organization_plan`

- Required: false
- Type: `string`
- Allowed values: `"read"`

The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.

### `organization_projects`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`, `"admin"`

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`.

### `organization_secrets`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.

### `organization_self_hosted_runners`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `organization_user_blocking`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `packages`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.

### `pages`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `pull_requests`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `repository_hooks`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `repository_projects`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`, `"admin"`

The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.

### `secret_scanning_alerts`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.

### `secrets`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.

### `security_events`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

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`.

### `single_file`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.

### `statuses`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.

### `team_discussions`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.

### `vulnerability_alerts`

- Required: false
- Type: `string`
- Allowed values: `"read"`, `"write"`

The level of permission to grant the access token to manage Dependabot alerts. Can be one of: `read` or `write`.

### `workflows`

- Required: false
- Type: `string`
- Allowed values: `"write"`

The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.

## JSON Schema

```json
{"description":"The permissions granted to the user-to-server access token.","example":{"contents":"read","deployments":"write","issues":"read","single_file":"read"},"properties":{"actions":{"description":"The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"administration":{"description":"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`.","enum":["read","write"],"type":"string"},"checks":{"description":"The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"content_references":{"description":"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`.","enum":["read","write"],"type":"string"},"contents":{"description":"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`.","enum":["read","write"],"type":"string"},"deployments":{"description":"The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"environments":{"description":"The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"issues":{"description":"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`.","enum":["read","write"],"type":"string"},"members":{"description":"The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"metadata":{"description":"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`.","enum":["read","write"],"type":"string"},"organization_administration":{"description":"The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"organization_hooks":{"description":"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`.","enum":["read","write"],"type":"string"},"organization_packages":{"description":"The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"organization_plan":{"description":"The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.","enum":["read"],"type":"string"},"organization_projects":{"description":"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`.","enum":["read","write","admin"],"type":"string"},"organization_secrets":{"description":"The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"organization_self_hosted_runners":{"description":"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`.","enum":["read","write"],"type":"string"},"organization_user_blocking":{"description":"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`.","enum":["read","write"],"type":"string"},"packages":{"description":"The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"pages":{"description":"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`.","enum":["read","write"],"type":"string"},"pull_requests":{"description":"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`.","enum":["read","write"],"type":"string"},"repository_hooks":{"description":"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`.","enum":["read","write"],"type":"string"},"repository_projects":{"description":"The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.","enum":["read","write","admin"],"type":"string"},"secret_scanning_alerts":{"description":"The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"secrets":{"description":"The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"security_events":{"description":"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`.","enum":["read","write"],"type":"string"},"single_file":{"description":"The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"statuses":{"description":"The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"team_discussions":{"description":"The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"vulnerability_alerts":{"description":"The level of permission to grant the access token to manage Dependabot alerts. Can be one of: `read` or `write`.","enum":["read","write"],"type":"string"},"workflows":{"description":"The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.","enum":["write"],"type":"string"}},"title":"App Permissions","type":"object"}
```

## Example

```json
{
  "contents": "read",
  "deployments": "write",
  "issues": "read",
  "single_file": "read"
}
```
