GitHub · Schema
app-permissions
The permissions granted to the user access token.
CodePipelinesPlatformSoftware DevelopmentSource ControlT1
Properties
| Name | Type | Description |
|---|---|---|
| actions | string | The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. |
| administration | string | The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. |
| checks | string | The level of permission to grant the access token for checks on code. |
| codespaces | string | The level of permission to grant the access token to create, edit, delete, and list Codespaces. |
| contents | string | The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. |
| dependabot_secrets | string | The leve of permission to grant the access token to manage Dependabot secrets. |
| deployments | string | The level of permission to grant the access token for deployments and deployment statuses. |
| environments | string | The level of permission to grant the access token for managing repository environments. |
| issues | string | The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. |
| metadata | string | The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. |
| packages | string | The level of permission to grant the access token for packages published to GitHub Packages. |
| pages | string | The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. |
| pull_requests | string | The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. |
| repository_hooks | string | The level of permission to grant the access token to manage the post-receive hooks for a repository. |
| repository_projects | string | The level of permission to grant the access token to manage repository projects, columns, and cards. |
| secret_scanning_alerts | string | The level of permission to grant the access token to view and manage secret scanning alerts. |
| secrets | string | The level of permission to grant the access token to manage repository secrets. |
| security_events | string | The level of permission to grant the access token to view and manage security events like code scanning alerts. |
| single_file | string | The level of permission to grant the access token to manage just a single file. |
| statuses | string | The level of permission to grant the access token for commit statuses. |
| vulnerability_alerts | string | The level of permission to grant the access token to manage Dependabot alerts. |
| workflows | string | The level of permission to grant the access token to update GitHub Actions workflow files. |
| members | string | The level of permission to grant the access token for organization teams and members. |
| organization_administration | string | The level of permission to grant the access token to manage access to an organization. |
| organization_custom_roles | string | The level of permission to grant the access token for custom repository roles management. |
| organization_copilot_seat_management | string | The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to |
| organization_announcement_banners | string | The level of permission to grant the access token to view and manage announcement banners for an organization. |
| organization_events | string | The level of permission to grant the access token to view events triggered by an activity in an organization. |
| organization_hooks | string | The level of permission to grant the access token to manage the post-receive hooks for an organization. |
| organization_personal_access_tokens | string | The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. |
| organization_personal_access_token_requests | string | The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. |
| organization_plan | string | The level of permission to grant the access token for viewing an organization's plan. |
| organization_projects | string | The level of permission to grant the access token to manage organization projects and projects beta (where available). |
| organization_packages | string | The level of permission to grant the access token for organization packages published to GitHub Packages. |
| organization_secrets | string | The level of permission to grant the access token to manage organization secrets. |
| organization_self_hosted_runners | string | The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. |
| organization_user_blocking | string | The level of permission to grant the access token to view and manage users blocked by the organization. |
| team_discussions | string | The level of permission to grant the access token to manage team discussions and related comments. |
| email_addresses | string | The level of permission to grant the access token to manage the email addresses belonging to a user. |
| followers | string | The level of permission to grant the access token to manage the followers belonging to a user. |
| git_ssh_keys | string | The level of permission to grant the access token to manage git SSH keys. |
| gpg_keys | string | The level of permission to grant the access token to view and manage GPG keys belonging to a user. |
| interaction_limits | string | The level of permission to grant the access token to view and manage interaction limits on a repository. |
| profile | string | The level of permission to grant the access token to manage the profile settings belonging to a user. |
| starring | string | The level of permission to grant the access token to list and manage repositories a user is starring. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-repo-tags-api-app-permissions-schema.json",
"title": "app-permissions",
"description": "The permissions granted to the user access token.",
"type": "object",
"properties": {
"actions": {
"type": "string",
"description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.",
"enum": [
"read",
"write"
],
"example": "read"
},
"administration": {
"type": "string",
"description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.",
"enum": [
"read",
"write"
],
"example": "read"
},
"checks": {
"type": "string",
"description": "The level of permission to grant the access token for checks on code.",
"enum": [
"read",
"write"
],
"example": "read"
},
"codespaces": {
"type": "string",
"description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.",
"enum": [
"read",
"write"
],
"example": "read"
},
"contents": {
"type": "string",
"description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.",
"enum": [
"read",
"write"
],
"example": "read"
},
"dependabot_secrets": {
"type": "string",
"description": "The leve of permission to grant the access token to manage Dependabot secrets.",
"enum": [
"read",
"write"
],
"example": "read"
},
"deployments": {
"type": "string",
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
"enum": [
"read",
"write"
],
"example": "read"
},
"environments": {
"type": "string",
"description": "The level of permission to grant the access token for managing repository environments.",
"enum": [
"read",
"write"
],
"example": "read"
},
"issues": {
"type": "string",
"description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.",
"enum": [
"read",
"write"
],
"example": "read"
},
"metadata": {
"type": "string",
"description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.",
"enum": [
"read",
"write"
],
"example": "read"
},
"packages": {
"type": "string",
"description": "The level of permission to grant the access token for packages published to GitHub Packages.",
"enum": [
"read",
"write"
],
"example": "read"
},
"pages": {
"type": "string",
"description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.",
"enum": [
"read",
"write"
],
"example": "read"
},
"pull_requests": {
"type": "string",
"description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.",
"enum": [
"read",
"write"
],
"example": "read"
},
"repository_hooks": {
"type": "string",
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
"enum": [
"read",
"write"
],
"example": "read"
},
"repository_projects": {
"type": "string",
"description": "The level of permission to grant the access token to manage repository projects, columns, and cards.",
"enum": [
"read",
"write",
"admin"
],
"example": "read"
},
"secret_scanning_alerts": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage secret scanning alerts.",
"enum": [
"read",
"write"
],
"example": "read"
},
"secrets": {
"type": "string",
"description": "The level of permission to grant the access token to manage repository secrets.",
"enum": [
"read",
"write"
],
"example": "read"
},
"security_events": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.",
"enum": [
"read",
"write"
],
"example": "read"
},
"single_file": {
"type": "string",
"description": "The level of permission to grant the access token to manage just a single file.",
"enum": [
"read",
"write"
],
"example": "read"
},
"statuses": {
"type": "string",
"description": "The level of permission to grant the access token for commit statuses.",
"enum": [
"read",
"write"
],
"example": "read"
},
"vulnerability_alerts": {
"type": "string",
"description": "The level of permission to grant the access token to manage Dependabot alerts.",
"enum": [
"read",
"write"
]
},
"workflows": {
"type": "string",
"description": "The level of permission to grant the access token to update GitHub Actions workflow files.",
"enum": [
"write"
]
},
"members": {
"type": "string",
"description": "The level of permission to grant the access token for organization teams and members.",
"enum": [
"read",
"write"
]
},
"organization_administration": {
"type": "string",
"description": "The level of permission to grant the access token to manage access to an organization.",
"enum": [
"read",
"write"
]
},
"organization_custom_roles": {
"type": "string",
"description": "The level of permission to grant the access token for custom repository roles management.",
"enum": [
"read",
"write"
]
},
"organization_copilot_seat_management": {
"type": "string",
"description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.",
"enum": [
"write"
]
},
"organization_announcement_banners": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage announcement banners for an organization.",
"enum": [
"read",
"write"
]
},
"organization_events": {
"type": "string",
"description": "The level of permission to grant the access token to view events triggered by an activity in an organization.",
"enum": [
"read"
]
},
"organization_hooks": {
"type": "string",
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
"enum": [
"read",
"write"
]
},
"organization_personal_access_tokens": {
"type": "string",
"description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.",
"enum": [
"read",
"write"
]
},
"organization_personal_access_token_requests": {
"type": "string",
"description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.",
"enum": [
"read",
"write"
]
},
"organization_plan": {
"type": "string",
"description": "The level of permission to grant the access token for viewing an organization's plan.",
"enum": [
"read"
]
},
"organization_projects": {
"type": "string",
"description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).",
"enum": [
"read",
"write",
"admin"
]
},
"organization_packages": {
"type": "string",
"description": "The level of permission to grant the access token for organization packages published to GitHub Packages.",
"enum": [
"read",
"write"
]
},
"organization_secrets": {
"type": "string",
"description": "The level of permission to grant the access token to manage organization secrets.",
"enum": [
"read",
"write"
]
},
"organization_self_hosted_runners": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.",
"enum": [
"read",
"write"
]
},
"organization_user_blocking": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage users blocked by the organization.",
"enum": [
"read",
"write"
]
},
"team_discussions": {
"type": "string",
"description": "The level of permission to grant the access token to manage team discussions and related comments.",
"enum": [
"read",
"write"
]
},
"email_addresses": {
"type": "string",
"description": "The level of permission to grant the access token to manage the email addresses belonging to a user.",
"enum": [
"read",
"write"
]
},
"followers": {
"type": "string",
"description": "The level of permission to grant the access token to manage the followers belonging to a user.",
"enum": [
"read",
"write"
]
},
"git_ssh_keys": {
"type": "string",
"description": "The level of permission to grant the access token to manage git SSH keys.",
"enum": [
"read",
"write"
]
},
"gpg_keys": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.",
"enum": [
"read",
"write"
]
},
"interaction_limits": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage interaction limits on a repository.",
"enum": [
"read",
"write"
]
},
"profile": {
"type": "string",
"description": "The level of permission to grant the access token to manage the profile settings belonging to a user.",
"enum": [
"write"
]
},
"starring": {
"type": "string",
"description": "The level of permission to grant the access token to list and manage repositories a user is starring.",
"enum": [
"read",
"write"
]
}
}
}