actions/create-github-app-token@v3
GitHub Action for creating a GitHub App installation access token
At a glance
- Latest major
v3- Repository
- actions/create-github-app-token
- Inputs
- 64 (1 required)
- Outputs
- 3
- Runs using
node24- License
- MIT
- Last checked
Inputs and outputs come straight from the action's official action.yml. See our editorial standards.
Usage
- uses: actions/create-github-app-token@v3Inputs
| Name | Required | Default | Description |
|---|---|---|---|
client-id | No | none | GitHub App Client ID |
app-id | No | none | Deprecated Use 'client-id' instead. |
private-key | Yes | none | GitHub App private key |
owner | No | none | The owner of the GitHub App installation (defaults to current repository owner) |
repositories | No | none | Comma or newline-separated list of repositories to grant the token access to (defaults to current repository if owner is unset) |
enterprise | No | none | The slug of the enterprise account where the GitHub App is installed (cannot be used with 'owner' or 'repositories') |
skip-token-revoke | No | false | If true, the token will not be revoked when the current job is complete |
github-api-url | No | ${{ github.api_url }} | The URL of the GitHub REST API. |
permission-actions | No | none | The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be set to 'read' or 'write'. |
permission-administration | No | none | The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be set to 'read' or 'write'. |
permission-artifact-metadata | No | none | The level of permission to grant the access token to create and retrieve build artifact metadata records. Can be set to 'read' or 'write'. |
permission-attestations | No | none | The level of permission to create and retrieve the access token for repository attestations. Can be set to 'read' or 'write'. |
permission-checks | No | none | The level of permission to grant the access token for checks on code. Can be set to 'read' or 'write'. |
permission-code-quality | No | none | The level of permission to grant the access token to view and manage code quality data. Can be set to 'read' or 'write'. |
permission-codespaces | No | none | The level of permission to grant the access token to create, edit, delete, and list Codespaces. Can be set to 'read' or 'write'. |
permission-contents | No | none | The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be set to 'read' or 'write'. |
permission-custom-properties-for-organizations | No | none | The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. Can be set to 'read' or 'write'. |
permission-dependabot-secrets | No | none | The level of permission to grant the access token to manage Dependabot secrets. Can be set to 'read' or 'write'. |
permission-deployments | No | none | The level of permission to grant the access token for deployments and deployment statuses. Can be set to 'read' or 'write'. |
permission-discussions | No | none | The level of permission to grant the access token for discussions and related comments and labels. Can be set to 'read' or 'write'. |
permission-email-addresses | No | none | The level of permission to grant the access token to manage the email addresses belonging to a user. Can be set to 'read' or 'write'. |
permission-enterprise-custom-properties-for-organizations | No | none | The level of permission to grant the access token for organization custom properties management at the enterprise level. Can be set to 'read', 'write', or 'admin'. |
permission-environments | No | none | The level of permission to grant the access token for managing repository environments. Can be set to 'read' or 'write'. |
permission-followers | No | none | The level of permission to grant the access token to manage the followers belonging to a user. Can be set to 'read' or 'write'. |
permission-git-ssh-keys | No | none | The level of permission to grant the access token to manage git SSH keys. Can be set to 'read' or 'write'. |
permission-gpg-keys | No | none | The level of permission to grant the access token to view and manage GPG keys belonging to a user. Can be set to 'read' or 'write'. |
permission-interaction-limits | No | none | The level of permission to grant the access token to view and manage interaction limits on a repository. Can be set to 'read' or 'write'. |
permission-issues | No | none | The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be set to 'read' or 'write'. |
permission-members | No | none | The level of permission to grant the access token for organization teams and members. Can be set to 'read' or 'write'. |
permission-merge-queues | No | none | The level of permission to grant the access token to manage the merge queues for a repository. Can be set to 'read' or 'write'. |
permission-metadata | No | none | The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be set to 'read' or 'write'. |
permission-organization-administration | No | none | The level of permission to grant the access token to manage access to an organization. Can be set to 'read' or 'write'. |
permission-organization-announcement-banners | No | none | The level of permission to grant the access token to view and manage announcement banners for an organization. Can be set to 'read' or 'write'. |
permission-organization-copilot-agent-settings | No | none | The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization. Can be set to 'read' or 'write'. |
permission-organization-copilot-seat-management | No | none | 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 public preview and is subject to change. Can be set to 'read' or 'write'. |
permission-organization-custom-org-roles | No | none | The level of permission to grant the access token for custom organization roles management. Can be set to 'read' or 'write'. |
permission-organization-custom-properties | No | none | The level of permission to grant the access token for repository custom properties management at the organization level. Can be set to 'read', 'write', or 'admin'. |
permission-organization-custom-roles | No | none | The level of permission to grant the access token for custom repository roles management. Can be set to 'read' or 'write'. |
permission-organization-events | No | none | The level of permission to grant the access token to view events triggered by an activity in an organization. Can be set to 'read'. |
permission-organization-external-properties-for-repos | No | none | The level of permission to grant the access token for managing external custom properties for repositories in an organization. Can be set to 'read', 'write', or 'admin'. |
permission-organization-hooks | No | none | The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be set to 'read' or 'write'. |
permission-organization-packages | No | none | The level of permission to grant the access token for organization packages published to GitHub Packages. Can be set to 'read' or 'write'. |
permission-organization-personal-access-token-requests | No | none | 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. Can be set to 'read' or 'write'. |
permission-organization-personal-access-tokens | No | none | The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. Can be set to 'read' or 'write'. |
permission-organization-plan | No | none | The level of permission to grant the access token for viewing an organization's plan. Can be set to 'read'. |
permission-organization-projects | No | none | The level of permission to grant the access token to manage organization projects and projects public preview (where available). Can be set to 'read', 'write', or 'admin'. |
permission-organization-secrets | No | none | The level of permission to grant the access token to manage organization secrets. Can be set to 'read' or 'write'. |
permission-organization-self-hosted-runners | No | none | The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be set to 'read' or 'write'. |
permission-organization-user-blocking | No | none | The level of permission to grant the access token to view and manage users blocked by the organization. Can be set to 'read' or 'write'. |
permission-packages | No | none | The level of permission to grant the access token for packages published to GitHub Packages. Can be set to 'read' or 'write'. |
permission-pages | No | none | The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be set to 'read' or 'write'. |
permission-profile | No | none | The level of permission to grant the access token to manage the profile settings belonging to a user. Can be set to 'write'. |
permission-pull-requests | No | none | The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be set to 'read' or 'write'. |
permission-repository-custom-properties | No | none | The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. Can be set to 'read' or 'write'. |
permission-repository-hooks | No | none | The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be set to 'read' or 'write'. |
permission-repository-projects | No | none | The level of permission to grant the access token to manage repository projects, columns, and cards. Can be set to 'read', 'write', or 'admin'. |
permission-secret-scanning-alerts | No | none | The level of permission to grant the access token to view and manage secret scanning alerts. Can be set to 'read' or 'write'. |
permission-secrets | No | none | The level of permission to grant the access token to manage repository secrets. Can be set to 'read' or 'write'. |
permission-security-events | No | none | The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be set to 'read' or 'write'. |
permission-single-file | No | none | The level of permission to grant the access token to manage just a single file. Can be set to 'read' or 'write'. |
permission-starring | No | none | The level of permission to grant the access token to list and manage repositories a user is starring. Can be set to 'read' or 'write'. |
permission-statuses | No | none | The level of permission to grant the access token for commit statuses. Can be set to 'read' or 'write'. |
permission-vulnerability-alerts | No | none | The level of permission to grant the access token to manage Dependabot alerts. Can be set to 'read' or 'write'. |
permission-workflows | No | none | The level of permission to grant the access token to update GitHub Actions workflow files. Can be set to 'write'. |
Outputs
| Name | Description |
|---|---|
token | GitHub installation access token |
installation-id | GitHub App installation ID |
app-slug | GitHub App slug |
Read an output with ${{ steps.<step-id>.outputs.<name> }}; the step needs an id.
Something out of date or wrong? Report it on our Contact page. This page is rebuilt from the action's repository roughly once a week.