• Reference
  • Nodes
  • Resources
  • Okta Authentication

Okta Authentication Resource

The Okta Authentication Resource authenticates with the Okta OAuth 2 API.

Properties

Environment Profiles

Propprofiles
Typearray
Default[ { 'scope': '', 'route': '', 'isSignInProvider': '{{true}}', 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject

A profile of this resource for an environment

Client ID

Propprofiles[].clientID
Typestring

The OpenID Connect Client ID to use.

Client Secret

Propprofiles[].clientSecret
Type({ ref: string } | undefined)

The OpenID Connect Client Secret to use.

Scope

Propprofiles[].scope
Typestring

The list of claims to request from the provider, space separated.

On Callback

Propprofiles[].onCallback
Type({ function: { ref: string } } | null)

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

Propprofiles[].route
Typestring

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

Propprofiles[].isSignInProvider
Typeboolean

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

Propprofiles[].displayName
Typestring

The human-readable name of the sign-in provider. This is used to display the name of the sign-in provider in the application.

Okta Domain

Propprofiles[].oktaDomain
Typestring

The base Okta domain to use.

Environment

Propprofiles[].environment
Typestring

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.

ParameterTypeDefault

Revoke OIDC authorization

Revokes the OpenID Connect authorization flow.

ParameterTypeDefault

Get authentication session

Gets the authentication session for.

ParameterTypeDefault
pathstringundefined
Last updated on November 1, 2022