Encap (Section)#
Path: /profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/encap
The settings for an Encap authentication provider
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| account-manager | leafref | required | The Account Manager is responsible for credentials and accounts. Depending on whether you pick an account manager that support registration, the html-form will support creating accounts and managing the accounts | |
| client-id | string | required | The ID of the authentication service Encap client | |
| application-id | string | optional | encap | The application ID of the Encap mobile application being used |
| api-key | string | optional | The API key to be used (only applicable when using the public Encap test server) | |
| encap-server-url | uri | required | The URL to where the Encap webservice is located (e.g., https://demo.encapsecurity.com/pt) | |
| allow-registration-during-login | boolean | optional | true | Whether or not users should be able to add a new device during the login process |
| show-info-before-registration | boolean | optional | true | Whether or not the information page should be shown before the registration page |
| client-key-id | leafref | required | The key ID of the private key that will be used when signing messages sent to the Encap server | |
| authentication-app-download-uri | uri | optional | The URL where users may download the mobile authentication application | |
| context-title | string | optional | A title message that is sent to the encap server when starting authentication | |
| context-content | string | optional | A context body that is sent to the encap server when starting authentication, as text/plain | |
| context-content-type | string | optional | text/plain | The content type of the context-content |
| max-allowed-attempts | uint16 | optional | 3 | The maximum number of authentication attempts that is allowed to be sent during one session. When this value is set to 0, there is no maximum attempts enforced. |
| device-expiration | uint32 | optional | Set a device expiration in seconds from the time the device is activated, if not set devices never expire. If this is set, it is not possible to override in the template. | |
| auto-login-enabled | boolean | optional | false | When active a login will be automatically performed after a successful registration |
Subsections#
| Name | Type | Description |
|---|---|---|
| non-interactive-registration | Section | Enables the possibility to activate a new device without user interaction. This can be used when the app also serves as an OpenID Connect client. |