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@v3

Inputs

NameRequiredDefaultDescription
client-idNononeGitHub App Client ID
app-idNononeDeprecated Use 'client-id' instead.
private-keyYesnoneGitHub App private key
ownerNononeThe owner of the GitHub App installation (defaults to current repository owner)
repositoriesNononeComma or newline-separated list of repositories to grant the token access to (defaults to current repository if owner is unset)
enterpriseNononeThe slug of the enterprise account where the GitHub App is installed (cannot be used with 'owner' or 'repositories')
skip-token-revokeNofalseIf true, the token will not be revoked when the current job is complete
github-api-urlNo${{ github.api_url }}The URL of the GitHub REST API.
permission-actionsNononeThe level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be set to 'read' or 'write'.
permission-administrationNononeThe 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-metadataNononeThe level of permission to grant the access token to create and retrieve build artifact metadata records. Can be set to 'read' or 'write'.
permission-attestationsNononeThe level of permission to create and retrieve the access token for repository attestations. Can be set to 'read' or 'write'.
permission-checksNononeThe level of permission to grant the access token for checks on code. Can be set to 'read' or 'write'.
permission-code-qualityNononeThe level of permission to grant the access token to view and manage code quality data. Can be set to 'read' or 'write'.
permission-codespacesNononeThe level of permission to grant the access token to create, edit, delete, and list Codespaces. Can be set to 'read' or 'write'.
permission-contentsNononeThe 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-organizationsNononeThe 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-secretsNononeThe level of permission to grant the access token to manage Dependabot secrets. Can be set to 'read' or 'write'.
permission-deploymentsNononeThe level of permission to grant the access token for deployments and deployment statuses. Can be set to 'read' or 'write'.
permission-discussionsNononeThe level of permission to grant the access token for discussions and related comments and labels. Can be set to 'read' or 'write'.
permission-email-addressesNononeThe 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-organizationsNononeThe 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-environmentsNononeThe level of permission to grant the access token for managing repository environments. Can be set to 'read' or 'write'.
permission-followersNononeThe 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-keysNononeThe level of permission to grant the access token to manage git SSH keys. Can be set to 'read' or 'write'.
permission-gpg-keysNononeThe 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-limitsNononeThe 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-issuesNononeThe 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-membersNononeThe level of permission to grant the access token for organization teams and members. Can be set to 'read' or 'write'.
permission-merge-queuesNononeThe level of permission to grant the access token to manage the merge queues for a repository. Can be set to 'read' or 'write'.
permission-metadataNononeThe 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-administrationNononeThe level of permission to grant the access token to manage access to an organization. Can be set to 'read' or 'write'.
permission-organization-announcement-bannersNononeThe 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-settingsNononeThe 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-managementNononeThe 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-rolesNononeThe level of permission to grant the access token for custom organization roles management. Can be set to 'read' or 'write'.
permission-organization-custom-propertiesNononeThe 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-rolesNononeThe level of permission to grant the access token for custom repository roles management. Can be set to 'read' or 'write'.
permission-organization-eventsNononeThe 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-reposNononeThe 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-hooksNononeThe 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-packagesNononeThe 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-requestsNononeThe 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-tokensNononeThe 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-planNononeThe level of permission to grant the access token for viewing an organization's plan. Can be set to 'read'.
permission-organization-projectsNononeThe 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-secretsNononeThe level of permission to grant the access token to manage organization secrets. Can be set to 'read' or 'write'.
permission-organization-self-hosted-runnersNononeThe 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-blockingNononeThe 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-packagesNononeThe level of permission to grant the access token for packages published to GitHub Packages. Can be set to 'read' or 'write'.
permission-pagesNononeThe 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-profileNononeThe level of permission to grant the access token to manage the profile settings belonging to a user. Can be set to 'write'.
permission-pull-requestsNononeThe 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-propertiesNononeThe 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-hooksNononeThe 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-projectsNononeThe 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-alertsNononeThe level of permission to grant the access token to view and manage secret scanning alerts. Can be set to 'read' or 'write'.
permission-secretsNononeThe level of permission to grant the access token to manage repository secrets. Can be set to 'read' or 'write'.
permission-security-eventsNononeThe 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-fileNononeThe level of permission to grant the access token to manage just a single file. Can be set to 'read' or 'write'.
permission-starringNononeThe 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-statusesNononeThe level of permission to grant the access token for commit statuses. Can be set to 'read' or 'write'.
permission-vulnerability-alertsNononeThe level of permission to grant the access token to manage Dependabot alerts. Can be set to 'read' or 'write'.
permission-workflowsNononeThe level of permission to grant the access token to update GitHub Actions workflow files. Can be set to 'write'.

Outputs

NameDescription
tokenGitHub installation access token
installation-idGitHub App installation ID
app-slugGitHub 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.