GitHub Authentication Resource
The GitHub Authentication Resource authenticates with the GitHub OAuth 2 API.
Properties
Environment Profiles
| Prop | profiles |
|---|---|
| Type | array |
| Default | [ { 'scope': '', 'route': '', 'isSignInProvider': true, 'enableGroups': false, 'useLegacyCallbackURL': false, 'groupOrganization': '', 'environment': '' } ] |
The profiles configured for this resource in an environment
Environment Profile
| Prop | profiles[] |
|---|---|
| Type | object |
| Default | undefined |
A profile of this resource for an environment
Client ID
| Prop | profiles[].clientID |
|---|---|
| Type | string |
| Default | undefined |
The OpenID Connect Client ID to use.
Client Secret
| Prop | profiles[].clientSecret |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
The OpenID Connect Client Secret to use.
Scope
| Prop | profiles[].scope |
|---|---|
| Type | string |
| Default | undefined |
The list of claims to request from the provider, space separated.
On Callback
| Prop | profiles[].onCallback |
|---|---|
| Type | ({ function: { ref: string } } | null) |
| Default | undefined |
The event handler to be called upon the successful completion of the authentication. This property can be used to chain function calls.
Callback Route Override
| Prop | profiles[].route |
|---|---|
| Type | string |
| Default | undefined |
The route where the callback endpoint should be mounted, relative to the project's endpoints root URL. Supports all routes supported by express via path-to-regexp.
Use as Sign-in Provider
| Prop | profiles[].isSignInProvider |
|---|---|
| Type | boolean |
| Default | undefined |
Whether this OpenID Connect resource can be used as a sign-in provider. Users may use this resource to authenticate with the application current user.
Enable Groups
| Prop | profiles[].enableGroups |
|---|---|
| Type | boolean |
| Default | undefined |
Whether this resource can retrieve group memberships.
Display Name
| Prop | profiles[].displayName |
|---|---|
| Type | string |
| Default | undefined |
The human-readable name of the sign-in provider. This is used to display the name of the sign-in provider in the application.
Use Legacy Callback URL
| Prop | profiles[].useLegacyCallbackURL |
|---|---|
| Type | boolean |
| Default | undefined |
Whether this resource should use the legacy callback URL for the OAuth2 authentication process. This will not apply to all new apps.
GitHub Organization
| Prop | profiles[].groupOrganization |
|---|---|
| Type | string |
| Default | undefined |
GitHub organization name
Environment
| Prop | profiles[].environment |
|---|---|
| Type | string |
| Default | undefined |
The name of the environment with which this profile is associated
Actions
Start authentication flow
Generates a redirect URL for the start of the OpenID Connect authentication flow.
| Parameter | Type | Default |
|---|
Revoke OIDC authorization
Revokes the OpenID Connect authorization flow.
| Parameter | Type | Default |
|---|
Get authentication session
Gets the authentication session for.
| Parameter | Type | Default |
|---|---|---|
path | string | undefined |