Get-GitHubOidcClaim

SYNOPSIS

Get the supported OIDC claim keys for a GitHub instance

SYNTAX

__AllParameterSets

Get-GitHubOidcClaim [[-Context] <Object>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Retrieves the list of supported OpenID Connect (OIDC) claim keys from the OIDC discovery endpoint of a GitHub instance. This endpoint is public and requires no authentication.

The claim keys returned can be used with Set-GitHubOidcSubjectClaim to customize the OIDC subject claim template for organizations and repositories.

EXAMPLES

EXAMPLE 1

Get-GitHubOidcClaim

Gets the supported OIDC claim keys for github.com.

EXAMPLE 2

Get-GitHubOidcClaim -Context $GitHubContext

Gets the supported OIDC claim keys for the GitHub instance associated with the given context.

PARAMETERS

-Context

The context to run the command in. Used to determine the GitHub instance hostname. When not provided, defaults to github.com.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.String

{{ Fill in the Description }}

NOTES

OpenID Connect Discovery

RELATED LINKS