OpenID Connect Resource

The OpenID Connect Resource authenticates with a compatible OpenID Connect API.

Properties

Environment Profiles

Prop	`profiles`
Type	`array`
Default	`[ { 'scope': '', 'route': '', 'isSignInProvider': true, 'isLegacyOAuth2Compatible': false, 'showIcon': true, 'useLegacyCallbackURL': false, '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.

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.

Discovery Domain

Prop	`profiles[].discoveryDomain`
Type	`string`
Default	`undefined`

The OpenID Connect Discovery domain to use.

Issuer

Prop	`profiles[].issuer`
Type	`string`
Default	`undefined`

The OpenID Connect issuer to use.

Auth URL

Prop	`profiles[].authURL`
Type	`string`
Default	`undefined`

The OpenID Connect Auth URL to use.

Token URL

Prop	`profiles[].tokenURL`
Type	`string`
Default	`undefined`

The OpenID Connect Token URL to use.

Certificates URL

Prop	`profiles[].certsURL`
Type	`string`
Default	`undefined`

The OpenID Connect Certificates URL to use.

Userinfo URL

Prop	`profiles[].userinfoURL`
Type	`string`
Default	`undefined`

The OpenID Connect Userinfo URL to use.

Device Authorization URL

Prop	`profiles[].deviceAuthorizationURL`
Type	`string`
Default	`undefined`

The OpenID Connect Device Authorization URL to use.

Registration URL

Prop	`profiles[].registrationURL`
Type	`string`
Default	`undefined`

The OpenID Connect Registration URL to use.

MFA Challenge URL

Prop	`profiles[].mfaChallengeURL`
Type	`string`
Default	`undefined`

The OpenID Connect MFA Challenge URL to use.

Revocation URL

Prop	`profiles[].revocationURL`
Type	`string`
Default	`undefined`

The OpenID Connect Revocation URL to use.

Legacy OAuth 2 Compatibility

Prop	`profiles[].isLegacyOAuth2Compatible`
Type	`boolean`
Default	`undefined`

Whether or not to only assume the OAuth 2.0 flow, rather than the complete OpenID Connect flow.

Show OIDC Icon

Prop	`profiles[].showIcon`
Type	`boolean`
Default	`undefined`

Whether or not to show the OpenID Connect icon on the sign-in button.

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.

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`

OpenAPI PostgreSQL