Package io.github.cdklabs.projen.github.workflows

Interface AppPermissions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AppPermissions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.094Z")
@Stability(Experimental)
public interface AppPermissions
extends software.amazon.jsii.JsiiSerializable

(experimental) The permissions available to a GitHub App.

Typically a token for a GitHub App has all the available scopes/permissions available to the app itself; however, a more limited set of permissions can be specified. When permissions are provided, only the specified permissions are granted to the token.

See Also:

https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#create-an-installation-access-token-for-an-app

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AppPermissions.Builder	A builder for AppPermissions
static class	AppPermissions.Jsii$Proxy	An implementation for AppPermissions

Method Summary

Modifier and Type	Method	Description
static AppPermissions.Builder	builder()
default AppPermission	getActions()
default AppPermission	getAdministration()
default AppPermission	getChecks()
default AppPermission	getContents()
default AppPermission	getDeployments()
default AppPermission	getEnvironments()
default AppPermission	getIssues()
default AppPermission	getMembers()
default AppPermission	getMetadata()
default AppPermission	getOrganizationAdministration()
default AppPermission	getOrganizationAnnouncementBanners()
default AppPermission	getOrganizationCustomRoles()
default AppPermission	getOrganizationHooks()
default AppPermission	getOrganizationPackages()
default AppPermission	getOrganizationPlan()
default AppPermission	getOrganizationProjects()
default AppPermission	getOrganizationSecrets()
default AppPermission	getOrganizationSelfHostedRunners()
default AppPermission	getOrgnaizationUserBlocking()
default AppPermission	getPackages()
default AppPermission	getPages()
default AppPermission	getPullRequests()
default AppPermission	getRepositoryAnnouncementBanners()
default AppPermission	getRepositoryHooks()
default AppPermission	getRepositoryProject()
default AppPermission	getSecrets()
default AppPermission	getSecretScanningAlerts()
default AppPermission	getSecurityEvents()
default AppPermission	getSingleFile()
default AppPermission	getStatuses()
default AppPermission	getTeamDiscussions()
default AppPermission	getVulnerabilityAlerts()
default AppPermission	getWorkflows()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActions

@Stability(Experimental)
@Nullable
default AppPermission getActions()

getAdministration

@Stability(Experimental)
@Nullable
default AppPermission getAdministration()

getChecks

@Stability(Experimental)
@Nullable
default AppPermission getChecks()

getContents

@Stability(Experimental)
@Nullable
default AppPermission getContents()

getDeployments

@Stability(Experimental)
@Nullable
default AppPermission getDeployments()

getEnvironments

@Stability(Experimental)
@Nullable
default AppPermission getEnvironments()

getIssues

@Stability(Experimental)
@Nullable
default AppPermission getIssues()

getMembers

@Stability(Experimental)
@Nullable
default AppPermission getMembers()

getMetadata

@Stability(Experimental)
@Nullable
default AppPermission getMetadata()

getOrganizationAdministration

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationAdministration()

getOrganizationAnnouncementBanners

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationAnnouncementBanners()

getOrganizationCustomRoles

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationCustomRoles()

getOrganizationHooks

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationHooks()

getOrganizationPackages

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationPackages()

getOrganizationPlan

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationPlan()

getOrganizationProjects

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationProjects()

getOrganizationSecrets

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationSecrets()

getOrganizationSelfHostedRunners

@Stability(Experimental)
@Nullable
default AppPermission getOrganizationSelfHostedRunners()

getOrgnaizationUserBlocking

@Stability(Experimental)
@Nullable
default AppPermission getOrgnaizationUserBlocking()

getPackages

@Stability(Experimental)
@Nullable
default AppPermission getPackages()

getPages

@Stability(Experimental)
@Nullable
default AppPermission getPages()

getPullRequests

@Stability(Experimental)
@Nullable
default AppPermission getPullRequests()

getRepositoryAnnouncementBanners

@Stability(Experimental)
@Nullable
default AppPermission getRepositoryAnnouncementBanners()

getRepositoryHooks

@Stability(Experimental)
@Nullable
default AppPermission getRepositoryHooks()

getRepositoryProject

@Stability(Experimental)
@Nullable
default AppPermission getRepositoryProject()

getSecrets

@Stability(Experimental)
@Nullable
default AppPermission getSecrets()

getSecretScanningAlerts

@Stability(Experimental)
@Nullable
default AppPermission getSecretScanningAlerts()

getSecurityEvents

@Stability(Experimental)
@Nullable
default AppPermission getSecurityEvents()

getSingleFile

@Stability(Experimental)
@Nullable
default AppPermission getSingleFile()

getStatuses

@Stability(Experimental)
@Nullable
default AppPermission getStatuses()

getTeamDiscussions

@Stability(Experimental)
@Nullable
default AppPermission getTeamDiscussions()

getVulnerabilityAlerts

@Stability(Experimental)
@Nullable
default AppPermission getVulnerabilityAlerts()

getWorkflows

@Stability(Experimental)
@Nullable
default AppPermission getWorkflows()

builder

@Stability(Experimental)
static AppPermissions.Builder builder()

Returns:

a AppPermissions.Builder of AppPermissions