Authenticators
Authenticators are used to verify the identity of a user. The Onegini Cordova Plugin currently supports PIN and fingerprint authenticators. The fingerprint authenticator is only available on devices with a fingerprint sensor.
![copy link to clipboard](../../../../../theme/img/icon-link.svg)
onegini.user.authenticators.getAll
- Used to get an array of authenticators available for a specific user.
- Requires an object containing a
profileId
.
Property | Example | Description |
---|---|---|
profileID |
"W8DUJ2" | The profile ID as received from onegini.user.registration |
The success callback contains an array of objects with these properties:
Property | Example | Description |
---|---|---|
authenticatorType |
"PIN" | The authenticator type |
authenticatorId |
"PIN" | The authenticator ID, which distinguishes between authenticators of type "Custom". (Only required for custom authenticators) |
The error callback contains an object with these properties:
Property | Example | Description |
---|---|---|
code |
8003 | The error code |
description |
"Onegini: No registered user found." | Human readable error description |
![copy link to clipboard](../../../../../theme/img/icon-link.svg)
onegini.user.authenticators.getNotRegistered
- Used to get an array of authenticators that are not currently registered for a specific user.
- Requires an object containing a
profileId
:
Property | Example | Description |
---|---|---|
profileID |
"W8DUJ2" | The profile ID as received from onegini.user.register |
The success callback contains an array of objects with these properties:
Property | Example | Description |
---|---|---|
authenticatorType |
"PIN" | The authenticator type |
authenticatorId |
"PIN" | The authenticator ID, which distinguishes between authenticators of type "Custom". (Only required for custom authenticators) |
The error callback contains an object with these properties:
Property | Example | Description |
---|---|---|
code |
8003 | The error code |
description |
"Onegini: No registered user found." | Human readable error description |
![copy link to clipboard](../../../../../theme/img/icon-link.svg)
onegini.user.authenticators.getPreferred
- Used to get the preferred authenticator for the currently authenticated user.
- Does not require any arguments.
The success callback contains an object with these properties:
Property | Example | Description |
---|---|---|
authenticatorType |
"PIN" | The authenticator type |
authenticatorId |
"PIN" | The authenticator ID, which distinguishes between authenticators of type "Custom". (Only required for custom authenticators) |
The error callback contains an object with these properties:
Property | Example | Description |
---|---|---|
code |
8003 | The error code |
description |
"Onegini: No registered user found." | Human readable error description |
![copy link to clipboard](../../../../../theme/img/icon-link.svg)
onegini.user.authenticators.setPreferred
- Used to set the preferred authenticator for the currently authenticated user.
- Requires an argument with an
authenticatorType
:
Property | Example | Description |
---|---|---|
authenticatorType |
"PIN" | The authenticator type |
authenticatorId |
"PIN" | The authenticator ID, which distinguishes between authenticators of type "Custom". (Only required for custom authenticators) |
The error callback contains an object with these properties:
Property | Example | Description |
---|---|---|
code |
8003 | The error code |
description |
"Onegini: No registered user found." | Human readable error description |
![copy link to clipboard](../../../../../theme/img/icon-link.svg)
onegini.user.authenticators.registerNew
- Used to register a new authenticator for the currently authenticated user.
- Return a new AuthenticationHandler.
- Requires an argument with an
authenticatorType
:
Property | Example | Description |
---|---|---|
authenticatorType |
"PIN" | The authenticator type |
authenticatorId |
"PIN" | The authenticator ID, which distinguishes between authenticators of type "Custom". (Only required for custom authenticators) |
The error callback contains an object with these properties:
Property | Example | Description |
---|---|---|
code |
8003 | The error code |
description |
"Onegini: No registered user found." | Human readable error description |
![copy link to clipboard](../../../../../theme/img/icon-link.svg)
onegini.user.authenticators.deregister
- Used to deregister an authenticator for the currently authenticated user.
- Requires an argument with an
authenticatorType
:
Property | Example | Description |
---|---|---|
authenticatorType |
"Fingerprint" | The authenticator type |
authenticatorId |
"Fingerprint" | The authenticator ID, which distinguishes between authenticators of type "Custom". (Only required for custom authenticators) |
The error callback contains an object with these properties:
Property | Example | Description |
---|---|---|
code |
8003 | The error code |
description |
"Onegini: No registered user found." | Human readable error description |