GitHub Actions OIDC claims to match against. Each field is a regular expression. The sub claim is required; all other claims are optional. A token matches only when all provided patterns match simultaneously (AND semantics).

Hierarchy

  • GitHubOIDCClaimPatterns

Constructors

Properties

actor?: string

Regular expression matched against the actor claim.

actorId?: string

Regular expression matched against the actor_id claim.

enterprise?: string

Regular expression matched against the enterprise claim.

enterpriseId?: string

Regular expression matched against the enterprise_id claim.

environment?: string

Regular expression matched against the environment claim.

eventName?: string

Regular expression matched against the event_name claim.

jobWorkflowRef?: string

Regular expression matched against the job_workflow_ref claim.

ref?: string

Regular expression matched against the ref claim.

refType?: string

Regular expression matched against the ref_type claim.

repository?: string

Regular expression matched against the repository claim.

repositoryId?: string

Regular expression matched against the repository_id claim.

repositoryOwner?: string

Regular expression matched against the repository_owner claim.

repositoryOwnerId?: string

Regular expression matched against the repository_owner_id claim.

repositoryVisibility?: string

Regular expression matched against the repository_visibility claim.

runnerEnvironment?: string

Regular expression matched against the runner_environment claim.

sub: string

Regular expression matched against the entire sub (subject) claim, the primary GitHub Actions OIDC identifier (for example, repo:<OWNER>/<REPO>:ref:refs/heads/main). The pattern must begin with repo:<OWNER>/, where <OWNER> is a literal repository-owner name rather than a regular expression.

workflow?: string

Regular expression matched against the workflow claim.

workflowRef?: string

Regular expression matched against the workflow_ref claim.

Generated using TypeDoc