• Reference
  • Nodes
  • Resources
  • One Time PIN Authentication

One Time PIN Authentication Resource

The One Time PIN Auth Resource provides user authentication via a one-time PIN auth flow.

Properties

Environment Profiles

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

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject

A profile of this resource for an environment

Use as Sign-in Provider

Propprofiles[].isSignInProvider
Typeboolean

Whether this resource can be used as a sign-in provider. Users may use this resource to authenticate with the application.

Environment

Propprofiles[].environment
Typestring

The name of the environment with which this profile is associated

Actions

Send PIN code

Start the OTP auth flow by sending a code to the provided email.

ParameterTypeDefault
emailstringundefined

Log in with PIN code

Validate the PIN code and create a valid login session.

ParameterTypeDefault
otpCodestringundefined
loginTokenKeystringundefined

Revoke PIN code authorization

Revoke the user session.

ParameterTypeDefault
Last updated on November 1, 2022