Alarms

alarms

The top container for this module.

Path :/alarms

Control

alarms/control

Configuration to control the alarm behavior.

Path :

/alarms/control

Parameters:
  • max-alarm-status-changes

    union

    (default: 32)

    The ‘status-change’ entries are kept in a circular list per alarm. When this number is exceeded, the oldest status change entry is automatically removed. If the value is ‘infinite’, the status-change entries are accumulated infinitely.

  • notify-status-changes

    enumeration all-state-changes, raise-and-clear, severity-level

    (default: all-state-changes)

    This leaf controls the notifications sent for alarm status updates. There are three options: 1. Notifications are sent for all updates, severity-level changes, and alarm-text changes. 2. Notifications are only sent for alarm raise and clear. 3. Notifications are sent for status changes equal to or above the specified severity level. Clear notifications shall always be sent. Notifications shall also be sent for state changes that make an alarm less severe than the specified level. For example, in option 3, assume that the severity level is set to major and that the alarm has the following state changes: [(Time, severity, clear)]: [(T1, major, -), (T2, minor, -), (T3, warning, -), (T4, minor, -), (T5, major, -), (T6, critical, -), (T7, major. -), (T8, major, clear)] In that case, notifications will be sent at times T1, T2, T5, T6, T7, and T8.

  • notify-severity-level

    severity indeterminate, warning, minor, major, critical

    (optional)

    Only send notifications for alarm-state changes crossing the specified level. Always send clear notifications.

Alarm-shelving

alarms/control/alarm-shelving

The ‘alarm-shelving/shelf’ list is used to shelve (block/filter) alarms. The conditions in the shelf criteria are logically ANDed. The first matching shelf is used, and an alarm is shelved only for this first match. Matching alarms MUST appear in the /alarms/shelved-alarms/shelved-alarm list, and non-matching /alarms MUST appear in the /alarms/alarm-list/alarm list. The server does not send any notifications for shelved alarms. The server MUST maintain states (e.g., severity changes) for the shelved alarms. Alarms that match the criteria shall have an operator state ‘shelved’. When the shelf configuration removes an alarm from the shelf, the server shall add the operator state ‘un-shelved’.

Path :/alarms/control/alarm-shelving

Shelf

alarms/control/alarm-shelving/shelf{name} (keys ['name'])

Each entry defines the criteria for shelving alarms. Criteria are ANDed. If no criteria are specified, all alarms will be shelved.

Path :

/alarms/control/alarm-shelving/shelf{name}

Parameters:
  • name

    string

    (mandatory)

    An arbitrary name for the alarm shelf.

  • description

    string

    (optional)

    An optional textual description of the shelf. This description should include the reason for shelving these alarms.

  • resource

    resource-match

    (multi-value) (optional)

    Shelve alarms for matching resources.

Alarm-type
alarms/control/alarm-shelving/shelf{name}/alarm-type{alarm-type-id, alarm-type-qualifier-match} (keys ['alarm-type-id', 'alarm-type-qualifier-match'])

Any alarm matching the combined criteria of ‘alarm-type-id’ and ‘alarm-type-qualifier-match’ MUST be matched.

Path :

/alarms/control/alarm-shelving/shelf{name}/alarm-type{alarm-type-id, alarm-type-qualifier-match}

Parameters:
  • alarm-type-id

    alarm-type-id

    (mandatory)

    Shelve all alarms that have an ‘alarm-type-id’ that is equal to or derived from the given ‘alarm-type-id’.

  • alarm-type-qualifier-match

    string

    (mandatory)

    An XML Schema regular expression that is used to match an alarm type qualifier. Shelve all alarms that match this regular expression for the alarm type qualifier.

Alarm-inventory

alarms/alarm-inventory

The ‘alarm-inventory/alarm-type’ list contains all possible alarm types for the system. If the system knows for which resources a specific alarm type can appear, it is also identified in the inventory. The list also tells if each alarm type has a corresponding clear state. The inventory shall only contain concrete alarm types. The alarm inventory MUST be updated by the system when new alarms can appear. This can be the case when installing new software modules or inserting new card types. A notification ‘alarm-inventory-changed’ is sent when the inventory is changed.

Path :/alarms/alarm-inventory

Alarm-type

alarms/alarm-inventory/alarm-type{alarm-type-id, alarm-type-qualifier} (keys ['alarm-type-id', 'alarm-type-qualifier'])

An entry in this list defines a possible alarm.

Path :

/alarms/alarm-inventory/alarm-type{alarm-type-id, alarm-type-qualifier}

Parameters:
  • alarm-type-id

    alarm-type-id

    (mandatory)

    The statically defined alarm type identifier for this possible alarm.

  • alarm-type-qualifier

    alarm-type-qualifier

    (mandatory)

    The optionally dynamically defined alarm type identifier for this possible alarm.

  • will-clear

    boolean

    (mandatory)

    This leaf tells the operator if the alarm will be cleared when the correct corrective action has been taken. Implementations SHOULD strive for detecting the cleared state for all alarm types. If this leaf is ‘true’, the operator can monitor the alarm until it becomes cleared after the corrective action has been taken. If this leaf is ‘false’, the operator needs to validate that the alarm is no longer active using other mechanisms. Alarms can lack a corresponding clear due to missing instrumentation or no logical corresponding clear state.

  • description

    string

    (mandatory)

    A description of the possible alarm. It SHOULD include information on possible underlying root causes and corrective actions.

  • resource

    resource-match

    (multi-value) (optional)

    Optionally, specifies for which resources the alarm type is valid.

  • severity-level

    severity indeterminate, warning, minor, major, critical

    (multi-value) (optional)

    This leaf-list indicates the possible severity levels of this alarm type. Note well that ‘clear’ is not part of the severity type. In general, the severity level should be defined by the instrumentation based on the dynamic state, rather than being defined statically by the alarm type, in order to provide a relevant severity level based on dynamic state and context. However, most alarm types have a defined set of possible severity levels, and this should be provided here.

Summary

alarms/summary

This container gives a summary of the number of alarms.

Path :/alarms/summary
Parameters:shelves-active

empty

(optional)

This is a hint to the operator that there are active alarm shelves. This leaf MUST exist if the /alarms/shelved-alarms/number-of-shelved-alarms is > 0.

Alarm-summary

alarms/summary/alarm-summary{severity} (keys ['severity'])

A global summary of all alarms in the system. The summary does not include shelved alarms.

Path :

/alarms/summary/alarm-summary{severity}

Parameters:
  • severity

    severity indeterminate, warning, minor, major, critical

    (mandatory)

    Alarm summary for this severity level.

  • total

    gauge32

    (optional)

    Total number of alarms of this severity level.

  • not-cleared

    gauge32

    (optional)

    Total number of alarms of this severity level that are not cleared.

  • cleared

    gauge32

    (optional)

    For this severity level, the number of alarms that are cleared.

  • cleared-not-closed

    gauge32

    (optional)

    For this severity level, the number of alarms that are cleared but not closed.

  • cleared-closed

    gauge32

    (optional)

    For this severity level, the number of alarms that are cleared and closed.

  • not-cleared-closed

    gauge32

    (optional)

    For this severity level, the number of alarms that are not cleared but closed.

  • not-cleared-not-closed

    gauge32

    (optional)

    For this severity level, the number of alarms that are not cleared and not closed.

Alarm-list

alarms/alarm-list

The alarms in the system.

Path :

/alarms/alarm-list

Parameters:
  • number-of-alarms

    gauge32

    (optional)

    This object shows the total number of alarms in the system, i.e., the total number of entries in the alarm list.

  • last-changed

    date-and-time

    (optional)

    A timestamp when the alarm list was last changed. The value can be used by a manager to initiate an alarm resynchronization procedure.

Alarm

alarms/alarm-list/alarm{resource, alarm-type-id, alarm-type-qualifier} (keys ['resource', 'alarm-type-id', 'alarm-type-qualifier'])

The list of alarms. Each entry in the list holds one alarm for a given alarm type and resource. An alarm can be updated from the underlying resource or by the user. The following leafs are maintained by the resource: ‘is-cleared’, ‘last-change’, ‘perceived-severity’, and ‘alarm-text’. An operator can change ‘operator-state’ and ‘operator-text’. Entries appear in the alarm list the first time an alarm becomes active for a given alarm type and resource. Entries do not get deleted when the alarm is cleared. Clear status is represented as a boolean flag. Alarm entries are removed, i.e., purged, from the list by an explicit purge action. For example, purge all alarms that are cleared and in closed operator state that are older than 24 hours. Purged alarms are removed from the alarm list. If the alarm resource state changes after a purge, the alarm will reappear in the alarm list. Systems may also remove alarms based on locally configured policies; this is out of scope for this module.

Path :

/alarms/alarm-list/alarm{resource, alarm-type-id, alarm-type-qualifier}

Parameters:
  • time-created

    date-and-time

    (mandatory)

    The timestamp when this alarm entry was created. This represents the first time the alarm appeared; it can also represent that the alarm reappeared after a purge. Further state changes of the same alarm do not change this leaf; these changes will update the ‘last-changed’ leaf.

  • self-test

    boolean

    (default: false)

    True if this alarm was triggered by a self test operation. Self test alarms do not indicate any issues in the system.

  • impact-tree

    string

    (optional)

  • description

    string

    (optional)

  • resource-type

    string

    (optional)

  • resource

    resource

    (mandatory)

    The alarming resource. See also ‘alt-resource’. This could be, for example, a reference to the alarming interface

  • alarm-type-id

    alarm-type-id

    (mandatory)

    This leaf and the leaf ‘alarm-type-qualifier’ together provide a unique identification of the alarm type.

  • alarm-type-qualifier

    alarm-type-qualifier

    (mandatory)

    This leaf is used when the ‘alarm-type-id’ leaf cannot uniquely identify the alarm type. Normally, this is not the case, and this leaf is the empty string.

  • is-cleared

    boolean

    (mandatory)

    Indicates the current clearance state of the alarm. An alarm might toggle from active alarm to cleared alarm and back to active again.

  • last-raised

    date-and-time

    (mandatory)

    An alarm may change severity level and toggle between active and cleared during its lifetime. This leaf indicates the last time it was raised (‘is-cleared’ = ‘false’).

  • last-changed

    date-and-time

    (mandatory)

    A timestamp when the ‘status-change’ or ‘operator-state-change’ list was last changed.

  • perceived-severity

    severity indeterminate, warning, minor, major, critical

    (mandatory)

    The last severity of the alarm. If an alarm was raised with severity ‘warning’ but later changed to ‘major’, this leaf will show ‘major’.

  • alarm-text

    alarm-text

    (mandatory)

    The last reported alarm text. This text should contain information for an operator to be able to understand the problem and how to resolve it.

Operator-state-change

alarms/alarm-list/alarm{resource, alarm-type-id, alarm-type-qualifier}/operator-state-change{time} (keys ['time'])

This list is used by operators to indicate the state of human intervention on an alarm. For example, if an operator has seen an alarm, the operator can add a new item to this list indicating that the alarm is acknowledged.

Path :

/alarms/alarm-list/alarm{resource, alarm-type-id, alarm-type-qualifier}/operator-state-change{time}

Parameters:
  • time

    date-and-time

    (mandatory)

    Timestamp for operator action on the alarm.

  • operator

    string

    (mandatory)

    The name of the operator that has acted on this alarm.

  • state

    operator-state

    (mandatory)

    The operator’s view of the alarm state.

  • text

    string

    (optional)

    Additional optional textual information provided by the operator.

  • alt-resource

    resource

    (multi-value) (optional)

    Used if the alarming resource is available over other interfaces. This field can contain SNMP OIDs, CIM paths, or 3GPP distinguished names, for example.

Status-change

alarms/alarm-list/alarm{resource, alarm-type-id, alarm-type-qualifier}/status-change{time} (keys ['time'])

A list of status-change events for this alarm. The entry with latest timestamp in this list MUST correspond to the leafs ‘is-cleared’, ‘perceived-severity’, and ‘alarm-text’ for the alarm. This list is ordered according to the timestamps of alarm state changes. The first item corresponds to the latest state change. The following state changes create an entry in this list: - changed severity (warning, minor, major, critical) - clearance status; this also updates the ‘is-cleared’ leaf - alarm-text update

Path :

/alarms/alarm-list/alarm{resource, alarm-type-id, alarm-type-qualifier}/status-change{time}

Parameters:
  • time

    date-and-time

    (mandatory)

    The time the status of the alarm changed. The value represents the time the real alarm-state change appeared in the resource and not when it was added to the alarm list. The /alarm-list/alarm/last-changed MUST be set to the same value.

  • perceived-severity

    severity-with-clear

    (mandatory)

    The severity of the alarm as defined by X.733. Note that this may not be the original severity since the alarm may have changed severity.

  • alarm-text

    alarm-text

    (mandatory)

    A user-friendly text describing the alarm-state change.

Shelved-alarms

alarms/shelved-alarms

The shelved alarms. Alarms appear here if they match the criteria in /alarms/control/alarm-shelving. This list does not generate any notifications. The list represents alarms that are considered not relevant by the operator. Alarms in this list have an ‘operator-state’ of ‘shelved’. This cannot be changed.

Path :

/alarms/shelved-alarms

Parameters:
  • number-of-shelved-alarms

    gauge32

    (optional)

    This object shows the total number of current alarms, i.e., the total number of entries in the alarm list.

  • shelved-alarms-last-changed

    date-and-time

    (optional)

    A timestamp when the shelved-alarm list was last changed. The value can be used by a manager to initiate an alarm resynchronization procedure.

Shelved-alarm

alarms/shelved-alarms/shelved-alarm{resource, alarm-type-id, alarm-type-qualifier} (keys ['resource', 'alarm-type-id', 'alarm-type-qualifier'])

The list of shelved alarms. Shelved alarms can only be updated from the underlying resource; no operator actions are supported.

Path :

/alarms/shelved-alarms/shelved-alarm{resource, alarm-type-id, alarm-type-qualifier}

Parameters:
  • shelf-name

    leafref /alarms/control/alarm-shelving/shelf/name

    (optional)

    The name of the shelf.

  • resource

    resource

    (mandatory)

    The alarming resource. See also ‘alt-resource’. This could be, for example, a reference to the alarming interface

  • alarm-type-id

    alarm-type-id

    (mandatory)

    This leaf and the leaf ‘alarm-type-qualifier’ together provide a unique identification of the alarm type.

  • alarm-type-qualifier

    alarm-type-qualifier

    (mandatory)

    This leaf is used when the ‘alarm-type-id’ leaf cannot uniquely identify the alarm type. Normally, this is not the case, and this leaf is the empty string.

  • is-cleared

    boolean

    (mandatory)

    Indicates the current clearance state of the alarm. An alarm might toggle from active alarm to cleared alarm and back to active again.

  • last-raised

    date-and-time

    (mandatory)

    An alarm may change severity level and toggle between active and cleared during its lifetime. This leaf indicates the last time it was raised (‘is-cleared’ = ‘false’).

  • last-changed

    date-and-time

    (mandatory)

    A timestamp when the ‘status-change’ or ‘operator-state-change’ list was last changed.

  • perceived-severity

    severity indeterminate, warning, minor, major, critical

    (mandatory)

    The last severity of the alarm. If an alarm was raised with severity ‘warning’ but later changed to ‘major’, this leaf will show ‘major’.

  • alarm-text

    alarm-text

    (mandatory)

    The last reported alarm text. This text should contain information for an operator to be able to understand the problem and how to resolve it.

Operator-state-change

alarms/shelved-alarms/shelved-alarm{resource, alarm-type-id, alarm-type-qualifier}/operator-state-change{time} (keys ['time'])

This list is used by operators to indicate the state of human intervention on an alarm. For shelved alarms, the system has set the list item in the list to ‘shelved’.

Path :

/alarms/shelved-alarms/shelved-alarm{resource, alarm-type-id, alarm-type-qualifier}/operator-state-change{time}

Parameters:
  • time

    date-and-time

    (mandatory)

    Timestamp for operator action on the alarm.

  • operator

    string

    (mandatory)

    The name of the operator that has acted on this alarm.

  • state

    operator-state

    (mandatory)

    The operator’s view of the alarm state.

  • text

    string

    (optional)

    Additional optional textual information provided by the operator.

  • alt-resource

    resource

    (multi-value) (optional)

    Used if the alarming resource is available over other interfaces. This field can contain SNMP OIDs, CIM paths, or 3GPP distinguished names, for example.

Status-change

alarms/shelved-alarms/shelved-alarm{resource, alarm-type-id, alarm-type-qualifier}/status-change{time} (keys ['time'])

A list of status-change events for this alarm. The entry with latest timestamp in this list MUST correspond to the leafs ‘is-cleared’, ‘perceived-severity’, and ‘alarm-text’ for the alarm. This list is ordered according to the timestamps of alarm state changes. The first item corresponds to the latest state change. The following state changes create an entry in this list: - changed severity (warning, minor, major, critical) - clearance status; this also updates the ‘is-cleared’ leaf - alarm-text update

Path :

/alarms/shelved-alarms/shelved-alarm{resource, alarm-type-id, alarm-type-qualifier}/status-change{time}

Parameters:
  • time

    date-and-time

    (mandatory)

    The time the status of the alarm changed. The value represents the time the real alarm-state change appeared in the resource and not when it was added to the alarm list. The /alarm-list/alarm/last-changed MUST be set to the same value.

  • perceived-severity

    severity-with-clear

    (mandatory)

    The severity of the alarm as defined by X.733. Note that this may not be the original severity since the alarm may have changed severity.

  • alarm-text

    alarm-text

    (mandatory)

    A user-friendly text describing the alarm-state change.

Alarm-profile

alarms/alarm-profile{alarm-type-id, alarm-type-qualifier-match, resource} (keys ['alarm-type-id', 'alarm-type-qualifier-match', 'resource'])

This list is used to assign further information or configuration for each alarm type. This module supports a mechanism where the client can override the system-default alarm severity levels. The ‘alarm-profile’ is also a useful augmentation point for specific additions to alarm types.

Path :

/alarms/alarm-profile{alarm-type-id, alarm-type-qualifier-match, resource}

Parameters:
  • alarm-type-id

    alarm-type-id

    (mandatory)

    The alarm type identifier to match.

  • alarm-type-qualifier-match

    string

    (mandatory)

    An XML Schema regular expression that is used to match the alarm type qualifier.

  • resource

    resource-match

    (mandatory)

    Specifies which resources to match.

  • description

    string

    (mandatory)

    A description of the alarm profile.

Alarm-severity-assignment-profile

alarms/alarm-profile{alarm-type-id, alarm-type-qualifier-match, resource}/alarm-severity-assignment-profile

The client can override the system-default severity level.

Path :/alarms/alarm-profile{alarm-type-id, alarm-type-qualifier-match, resource}/alarm-severity-assignment-profile
Parameters:severity-level

severity indeterminate, warning, minor, major, critical

(multi-value) (optional)

Specifies the configured severity level(s) for the matching alarm. If the alarm has several severity levels, the leaf-list shall be given in rising severity order. The original M3100/M3160 ASAP function only allows for a one-to-one mapping between alarm type and severity, but since YANG module supports stateful alarms, the mapping must allow for several severity levels. Assume a high-utilization alarm type with two thresholds with the system-default severity levels of threshold1 = warning and threshold2 = minor. Setting this leaf-list to (minor, major) will assign the severity levels as threshold1 = minor and threshold2 = major

Environment

environments/environment

Defines an environment with all services and meta information it needs

Path :

/environments/environment

Parameters:
  • name

    string

    (default: se.curity)

    The name of the organization running the services in an environment (Entity ID)

  • deployment-type

    union

    (optional)

    The type of deployment this system is executing as.

  • base-url

    uri

    (optional)

    The external base URL used to contact this machine

  • static-resource-root-path

    uri

    (default: )

    The root path under the base-url from which static resources should be served

  • available-template-areas

    string

    (multi-value) (optional)

    Reports the template areas that are available as they are found on the file system of the admin node

Localization

environments/environment/localization

The localization settings for this environment

Path :/environments/environment/localization
Parameters:default-locale

string

(default: en)

Default locale if no locale is specified in request

White-listed-proxies

environments/environment/white-listed-proxies

A list of proxies that are allowed to be in the middle of the requestor and this server. If this list is empty, the X-Forwarded-For header will be ignored. If this list is non-empty the X-Forwarded-For header will be used as the remote-ip of the client if the proxies match this list.

Path :/environments/environment/white-listed-proxies
Parameters:proxy

union

(multi-value) (optional)

An IPv4/IPv6 address, hostname or IPv4/IPv6 cidr of the proxy to whitelist.

Cluster

environments/environment/cluster

Settings of a configuration cluster

Path :

/environments/environment/cluster

Parameters:
  • keystore

    string

    (mandatory)

    The keystore for cluster communication. This should only be set with keystores generated by Curity

  • host

    host

    (mandatory)

    The host or IP of the cluster admin node that the run-time nodes will connect to

  • port

    port-number

    (default: 6789)

    The port of the cluster admin node

  • admin-listening-host

    host

    (default: 0.0.0.0)

    The host or IP that the admin node should listen on (e.g., 0.0.0.0 to listen on all network interfaces)

Admin-service

environments/environment/admin-service

Enable the admin service

Path :

/environments/environment/admin-service

Parameters:
  • credential-manager

    leafref /processing/credential-managers/credential-manager/id

    (optional)

    A credential manager that verifies accounts against an external user repository (e.g., LDAP)

  • tenant-id

    string

    (optional)

    ID of the tenant associated with the admin-service credential manager. When not set the default tenant is used

  • authorization-manager

    leafref /processing/authorization-managers/authorization-manager/id

    (optional)

    An authorization manager that authorizes Admin service requests against backend

Http

environments/environment/admin-service/http

Enables the HTTP admin service interface (Web UI and/or RESTCONF)

Path :

/environments/environment/admin-service/http

Parameters:
  • listening-host

    ip-address

    (default: 0.0.0.0)

    IP used for listening host

  • listening-port

    port-number

    (default: 6749)

    The port the admin endpoint listens on

  • ssl-server-keystore

    leafref /facilities/crypto/ssl/server-keystore/id

    (optional)

    A pointer to the key used for the SSL server. When no key is configured, the admin will be served on a http connection instead of an https.

  • base-url

    uri

    (optional)

    The external base URL used to contact the admin web-ui and restconf

  • enable-http-v2

    boolean

    (default: false)

    Enables support for the HTTP/2 protocol. HTTP/2 is usually faster than HTTP/1.x, but may not be as widely supported by clients. HTTP/1.x is always enabled.

Web-ui

environments/environment/admin-service/http/web-ui

Enable the admin Web UI

Path :/environments/environment/admin-service/http/web-ui
Appearance
environments/environment/admin-service/http/web-ui/appearance
Path :/environments/environment/admin-service/http/web-ui/appearance
Parameters:badge-color

string

(optional)

A CSS hex (format #aabbcc) color for the UI environment badge. Default colors are used when not set.

Ui-modes
environments/environment/admin-service/http/web-ui/ui-modes

This section contains settings for the different modes in the Web UI

Path :/environments/environment/admin-service/http/web-ui/ui-modes
Normal-mode
environments/environment/admin-service/http/web-ui/ui-modes/normal-mode

Customizations for the normal mode UI

Path :

/environments/environment/admin-service/http/web-ui/ui-modes/normal-mode

Parameters:
  • authentication-profile

    leafref /profiles/profile/id

    (optional)

    The authentication profile to use in Normal Mode

  • token-profile

    leafref /profiles/profile/id

    (optional)

    The token profile to use in Normal Mode

  • user-management-profile

    leafref /profiles/profile/id

    (optional)

    The user management profile to use in Normal Mode

  • service-role

    leafref /environments/environment/services/service-role/id

    (optional)

    The service role to use in Normal Mode for HTTP runtime settings

  • account-manager

    leafref /processing/account-managers/account-manager/id

    (optional)

    The account manager to use in Normal Mode

  • credential-manager

    leafref /processing/credential-managers/credential-manager/id

    (optional)

    The credential manager to use in Normal Mode

Admin-federated-login
environments/environment/admin-service/http/web-ui/admin-federated-login

Configure the admin UI to enable logging in with a federated account. Use an internal OpenID Connect client or an external OpenID Connect provider

Path :

/environments/environment/admin-service/http/web-ui/admin-federated-login

Parameters:
  • disable-local-accounts

    empty

    (optional)

    Disable local account login

  • logo

    string

    (optional)

    A logo of the client, that can shown in user interface screens.

  • name

    non-empty-string

    (optional)

    Name of OpenID Connect provider

Choice: internal-or-external
Option: external-openid-provider
External-openid-provider
environments/environment/admin-service/http/web-ui/admin-federated-login/external-openid-provider

Use external OpenID Connect provider

Path :

/environments/environment/admin-service/http/web-ui/admin-federated-login/external-openid-provider

Parameters:
  • client-id

    non-empty-string

    (mandatory)

    The client id to use when obtaining an OAuth 2.0 access token

  • client-secret

    non-empty-string

    (mandatory)

    The client secret to use when obtaining an OAuth 2.0 access token

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (optional)

    A reference to the Http Client

  • authorization-endpoint

    uri

    (mandatory)

    The complete url to the authorization endpoint of the OpenID Connect Provider

  • token-endpoint

    uri

    (mandatory)

    The complete url to the token endpoint of the OpenID Connect Provider

  • userinfo-endpoint

    uri

    (optional)

    The complete url to the userinfo endpoint of the OpenID Connect Provider

  • scopes

    scope

    (multi-value) (optional)

    Additional scopes (beyond ‘openid’) that should be requested

  • claims

    non-empty-string

    (multi-value) (optional)

    Additional claims that should be requested

Option: using-oauth-profile
Using-oauth-profile
environments/environment/admin-service/http/web-ui/admin-federated-login/using-oauth-profile

Enable login using Curity OpenID Connect client

Path :

/environments/environment/admin-service/http/web-ui/admin-federated-login/using-oauth-profile

Parameters:
  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (optional)

    A reference to the Http Client

  • oauth-profile

    leafref /base:profiles/base:profile/base:id

    (mandatory)

    The OAuth Profile to which client belongs

  • client

    leafref /base:profiles/base:profile[base:id=current()/../as:oauth-profile]/base:settings/as:authorization-server/as:client-store/as:config-backed/as:client/as:id

    (mandatory)

    OpenID Connect client

Restconf

environments/environment/admin-service/http/restconf

Enable the RESTCONF API

Path :/environments/environment/admin-service/http/restconf
Parameters:basic-authentication

boolean

(default: true)

Allows users to access the RESTCONF API using basic credentials

Oauth
environments/environment/admin-service/http/restconf/oauth

Allow users to access the RESTCONF API using OAuth access tokens

Path :

/environments/environment/admin-service/http/restconf/oauth

Parameters:
  • oauth-profile

    leafref /base:profiles/base:profile/base:id

    (mandatory)

    The OAuth Profile to accept tokens from when accessing the Dashboard

  • client

    leafref /base:profiles/base:profile[base:id=current()/../as:oauth-profile]/base:settings/as:authorization-server/as:client-store/as:config-backed/as:client/as:id

    (multi-value) (optional)

    The clients to use for authenticating users to the RESTCONF API

Devops-dashboard

environments/environment/admin-service/http/devops-dashboard

Enable the DevOps Dashboard UI

Path :

/environments/environment/admin-service/http/devops-dashboard

Parameters:
  • authorization-manager

    leafref /base:processing/base:authorization-managers/base:authorization-manager/base:id

    (optional)

    Authorization Manager that should authorize requests from the DevOps Dashboard client to the GraphQL APIs. If not configured, access to the GraphQL APIs by the dashboard client will be forbidden.

  • client

    leafref /base:profiles/base:profile[base:id=current()/../../base:restconf/as:oauth/as:oauth-profile]/base:settings/as:authorization-server/as:client-store/as:config-backed/as:client/as:id

    (mandatory)

    The client to use for authenticating users to the dashboard

Themes

environments/environment/themes

UI theme configuration

Path :/environments/environment/themes

Default-theme

environments/environment/themes/default-theme

The default theme, not using any template areas.

Path :

/environments/environment/themes/default-theme

Parameters:
  • theme-css-properties

    base64-encoded-string

    (optional)

    A base64 encoded string of theme CSS variables

  • theme-custom-css

    base64-encoded-string

    (optional)

    A base64 encoded string of custom css that will be joined with the css properties

Template-variables

environments/environment/themes/default-theme/template-variables{name} (keys ['name'])

A list of template variables that will be available in the template context

Path :

/environments/environment/themes/default-theme/template-variables{name}

Parameters:
  • name

    string

    (mandatory)

    The name of the template variable as it will appear in the template context. The name must start with an underscore.

  • value

    non-empty-string

    (optional)

    The value of the variable

  • static-resource-cache-duration

    uint32

    (default: 2628000)

    The maximum duration (in seconds) that a static resource should be cached by a client Web browser

Zones

environments/environment/services/zones

List of available zones in the system, these are referenced by subsystems when needed

Path :/environments/environment/services/zones

Default-zone

environments/environment/services/zones/default-zone

The default zone to be used unless another is explicitly necessary

Path :

/environments/environment/services/zones/default-zone

Parameters:
  • email-provider

    leafref /facilities/email-providers/email-provider/id

    (optional)

    The email-provider to use for this zone

  • symmetric-key

    string

    (optional)

    Key used to sign cookies, for example.

  • secondary-symmetric-key

    string

    (optional)

    Secondary key. Used to verify signatures when using the main symmetric-key fails. Allows rotating the symmetric-key.

Mobile-app-association

environments/environment/services/zones/default-zone/mobile-app-association
Path :/environments/environment/services/zones/default-zone/mobile-app-association
Ios-app-configuration
environments/environment/services/zones/default-zone/mobile-app-association/ios-app-configuration{app-id} (keys ['app-id'])
Path :/environments/environment/services/zones/default-zone/mobile-app-association/ios-app-configuration{app-id}
Parameters:app-id

string

(mandatory)

App id for IOS applications

Android-app-configuration
environments/environment/services/zones/default-zone/mobile-app-association/android-app-configuration{namespace package-name} (keys ['namespace package-name'])
Path :

/environments/environment/services/zones/default-zone/mobile-app-association/android-app-configuration{namespace package-name}

Parameters:
  • namespace

    string

    (optional)

  • package-name

    string

    (optional)

Sha256-cert-fingerprints
environments/environment/services/zones/default-zone/mobile-app-association/android-app-configuration{namespace package-name}/sha256-cert-fingerprints{fingerprint} (keys ['fingerprint'])
Path :

/environments/environment/services/zones/default-zone/mobile-app-association/android-app-configuration{namespace package-name}/sha256-cert-fingerprints{fingerprint}

Parameters:
  • fingerprint

    string

    (mandatory)

  • allowed-origins-for-cors

    non-empty-string

    (multi-value) (optional)

    The origins (scheme, host, and optional port) that are allowed to make cross origin requests

Zone

environments/environment/services/zones/zone{id} (keys ['id'])

The zone list may be empty. If so, the default zone is the only one used. If the list is non-empty, the default zone is used by nodes not configured to use aparticular zone.

Path :

/environments/environment/services/zones/zone{id}

Parameters:
  • id

    string

    (mandatory)

    The only meaning of a zone is a name. It’s up to the admin to decide where and what that zone stands for.

  • email-provider

    leafref /facilities/email-providers/email-provider/id

    (optional)

    The email-provider to use for this zone

  • symmetric-key

    string

    (optional)

    Key used to sign cookies, for example. If not set, the key of the default zone is used.

  • secondary-symmetric-key

    string

    (optional)

    Secondary key. Used to verify signatures when using the main symmetric-key fails. Allows rotating the symmetric-key.

Mobile-app-association

environments/environment/services/zones/zone{id}/mobile-app-association
Path :/environments/environment/services/zones/zone{id}/mobile-app-association
Ios-app-configuration
environments/environment/services/zones/zone{id}/mobile-app-association/ios-app-configuration{app-id} (keys ['app-id'])
Path :/environments/environment/services/zones/zone{id}/mobile-app-association/ios-app-configuration{app-id}
Parameters:app-id

string

(mandatory)

App id for IOS applications

Android-app-configuration
environments/environment/services/zones/zone{id}/mobile-app-association/android-app-configuration{namespace package-name} (keys ['namespace package-name'])
Path :

/environments/environment/services/zones/zone{id}/mobile-app-association/android-app-configuration{namespace package-name}

Parameters:
  • namespace

    string

    (optional)

  • package-name

    string

    (optional)

Sha256-cert-fingerprints
environments/environment/services/zones/zone{id}/mobile-app-association/android-app-configuration{namespace package-name}/sha256-cert-fingerprints{fingerprint} (keys ['fingerprint'])
Path :

/environments/environment/services/zones/zone{id}/mobile-app-association/android-app-configuration{namespace package-name}/sha256-cert-fingerprints{fingerprint}

Parameters:
  • fingerprint

    string

    (mandatory)

  • allowed-origins-for-cors

    non-empty-string

    (multi-value) (optional)

    The origins (scheme, host, and optional port) that are allowed to make cross origin requests

Service-role

environments/environment/services/service-role{id} (keys ['id'])
Path :

/environments/environment/services/service-role{id}

Parameters:
  • id

    string

    (mandatory)

    A given name of the service role

  • location

    string

    (optional)

    Where the service is located, physically

  • enabled

    boolean

    (default: true)

    Enable or disable the entire daemon instance

  • zone

    leafref ../../zones/zone/id

    (optional)

    The zone that the service is in (which, if not set, will be the default zone)

  • listening-host

    ip-address

    (default: 0.0.0.0)

    IP used for listening host

  • listening-port

    port-number

    (default: 8443)

    The port the service listens on

  • protocol

    enumeration http, https

    (default: https)

    Which protocol to use, almost always, https should be used

  • ssl-server-keystore

    leafref /facilities/crypto/ssl/server-keystore/id

    (optional)

    A pointer to the key used for the SSL server

  • enable-http-v2

    boolean

    (default: false)

    Enable HTTP 2 (H2)

  • jvm-options

    string

    (default: -XX:+UseG1GC -XX:+UseStringDeduplication)

    The options that should be passed to the Java Virtual Machine (JVM) when the service is started

  • disable-android-assetlinks-generation

    empty

    (optional)

    Disable generation of assetlinks (’…/.well-known/assetlinks.json’) from configured Android App associations

Hsts

environments/environment/services/service-role{id}/hsts

Enable HSTS support for this role

Path :

/environments/environment/services/service-role{id}/hsts

Parameters:
  • max-age

    uint32

    (default: 15465601)

    Maximum number of seconds that HSTS will be used for

  • include-subdomains

    boolean

    (default: false)

    Whether or not subdomains should use HSTS as well

  • preload

    boolean

    (default: false)

    Whether or not any pre-loaded certificates should be used by a browser

Content-security-policy

environments/environment/services/service-role{id}/content-security-policy
Path :/environments/environment/services/service-role{id}/content-security-policy

Reporting-endpoint

environments/environment/services/service-role{id}/content-security-policy/reporting-endpoint

Enables reporting of HTTP Content Security Policy violations: adds the Content-Security-Policy report-to and report-uri directives, as well as the Reporting-Endpoints HTTP header.

Path :

/environments/environment/services/service-role{id}/content-security-policy/reporting-endpoint

Parameters:
  • id

    string

    (default: csp-reporting-endpoint)

    Name of the reporting endpoint

  • url

    uri

    (mandatory)

    URL to report Content Security Policy violations to.

Server-tls

environments/environment/services/service-role{id}/server-tls
Path :

/environments/environment/services/service-role{id}/server-tls

Parameters:
  • enable-tls-v1-0

    boolean

    (default: false)

    Enable TLS 1.0 (should be disabled unless necessary)

  • enable-tls-v1-1

    boolean

    (default: false)

    Enable TLS 1.1 (should be disabled unless necessary)

  • enable-tls-v1-2

    boolean

    (default: true)

    Enable TLS 1.2

  • enable-tls-v1-3

    boolean

    (default: false)

    Enable TLS 1.3

Sni-host-check

environments/environment/services/service-role{id}/server-tls/sni-host-check

Enable SNI host check, such that inbound TLS connections with a Server Name Indicator must match the name of the server’s SSL certificate.

Path :/environments/environment/services/service-role{id}/server-tls/sni-host-check
Parameters:require-sni

boolean

(default: false)

Require the client to use SNI. Can only be set when sni-host-check is enabled.

Mutual-tls

environments/environment/services/service-role{id}/mutual-tls
Path :

/environments/environment/services/service-role{id}/mutual-tls

Parameters:
  • listening-port

    port-number

    (optional)

    The port to use for mutual TLS. Defaults to the same value as configured for listening-port for this service.

  • client-truststores

    leafref /base:facilities/crypto/ssl/client-truststore/client-certificate/id

    (multi-value) (optional)

    The certificates that have signed any client’s certificate used to authenticate such clients. If no truststores are configured, ALL truststores are added to the mutual-tls trust for this service.

Thread-count

environments/environment/services/service-role{id}/thread-count
Path :

/environments/environment/services/service-role{id}/thread-count

Parameters:
  • minimum

    uint16

    (default: 8)

    The minimum number of threads that should be started when the service’s Java Virtual Machine (JVM) starts

  • maximum

    uint16

    (default: 100)

    The maximum number of threads that can be started by the Java Virtual Machine (JVM) of the service

Ciphers

environments/environment/services/service-role{id}/ciphers

White- and black-listing of ciphers used for incoming secure connections. Enabling this feature will disable any white- and black-lists automatically enforced by the server.

Path :

/environments/environment/services/service-role{id}/ciphers

Parameters:
  • included-ciphers

    non-empty-string

    (multi-value) (optional)

    A white-list of ciphers to use for incoming secure connections

  • excluded-ciphers

    non-empty-string

    (multi-value) (optional)

    A black-list of ciphers not to use for incoming secure connections

Webfinger

environments/environment/services/service-role{id}/webfinger

Enable webfinger support for this service

Path :/environments/environment/services/service-role{id}/webfinger
Parameters:endpoints

leafref /profiles/profile/endpoints/endpoint/id

(multi-value) (optional)

A list of endpoints deployed on this service instance, no order implied

Runtime-service

environments/environment/services/runtime-service{id} (keys ['id'])

This list shows the connected and recently connected runtime nodes

Path :

/environments/environment/services/runtime-service{id}

Parameters:
  • id

    string

    (mandatory)

    The unique id of the runtime node

  • name

    string

    (optional)

    The given name of the runtime node

  • role

    string

    (optional)

    The service role the node is using

  • boot-time

    uint32

    (optional)

    The time the node was booted

  • status

    enumeration connected, disconnected

    (default: disconnected)

    The node’s cluster status

  • uptime

    union

    (optional)

    Current uptime for the node

Reporting

environments/environment/reporting

Reporting makes runtime nodes expose Prometheus compatible metrics

Path :

/environments/environment/reporting

Parameters:
  • enable

    boolean

    (default: true)

    Enable reporting

  • include-profile-id

    boolean

    (default: false)

    Include profile_id label in metrics

Alarms

environments/environment/alarms
Path :/environments/environment/alarms

Alarm-handler

alarm-handler (keys: ['id'])

An alarm handler processes alarms that are raised and cleared by the system.

Path :/environments/environment/alarms/alarm-handlers/alarm-handler{id}
Parameters:id

string

(mandatory)

Choice: alarm-handler-type

Option: email-notifier

Email-notifier

email-notifier
Path :/environments/environment/alarms/alarm-handlers/alarm-handler{id}/email-notifier
Email-provider
email-notifier/email-provider
Path :

/environments/environment/alarms/alarm-handlers/alarm-handler{id}/email-notifier/email-provider

Parameters:
  • id

    leafref /base:facilities/base:email-providers/base:email-provider/base:id

    (mandatory)

    A reference to the Email-Provider

  • recipients

    string

    (multi-value) (optional)

    A set of email addresses to send alarm notifications to

Option: pagerduty-notifier

Pagerduty-notifier

pagerduty-notifier
Path :/environments/environment/alarms/alarm-handlers/alarm-handler{id}/pagerduty-notifier
Parameters:integration-key

string

(mandatory)

The Integration Key from Pager Duty to use when calling the Events API

Web-service
pagerduty-notifier/web-service
Path :

/environments/environment/alarms/alarm-handlers/alarm-handler{id}/pagerduty-notifier/web-service

Parameters:
  • hostname

    host

    (mandatory)

    sets the hostname or ip-address of the webservice service, e.g. ‘localhost’ or ‘127.0.0.1’

  • port

    port-number

    (default: 80)

    sets the port of the webservice service, e.g. 80 or 443.

  • context

    string

    (default: /)

    sets the main context of the webservice service, e.g. ‘/scim’.

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

Option: slack-notifier

Slack-notifier

slack-notifier
Path :/environments/environment/alarms/alarm-handlers/alarm-handler{id}/slack-notifier
Web-service
slack-notifier/web-service
Path :

/environments/environment/alarms/alarm-handlers/alarm-handler{id}/slack-notifier/web-service

Parameters:
  • hostname

    host

    (mandatory)

    sets the hostname or ip-address of the webservice service, e.g. ‘localhost’ or ‘127.0.0.1’

  • port

    port-number

    (default: 80)

    sets the port of the webservice service, e.g. 80 or 443.

  • context

    string

    (default: /)

    sets the main context of the webservice service, e.g. ‘/scim’.

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

Option: webhook-notifier

Webhook-notifier

webhook-notifier
Path :/environments/environment/alarms/alarm-handlers/alarm-handler{id}/webhook-notifier
Parameters:message-format

enumeration flat, nested

(default: nested)

The Json format that should be used for the posted message. The ‘flat’ format presents a single level json object and ‘nested’ is a structured json format.

Web-service
webhook-notifier/web-service
Path :

/environments/environment/alarms/alarm-handlers/alarm-handler{id}/webhook-notifier/web-service

Parameters:
  • hostname

    host

    (mandatory)

    sets the hostname or ip-address of the webservice service, e.g. ‘localhost’ or ‘127.0.0.1’

  • port

    port-number

    (default: 80)

    sets the port of the webservice service, e.g. 80 or 443.

  • context

    string

    (default: /)

    sets the main context of the webservice service, e.g. ‘/scim’.

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

Profile

profile (keys: ['id', 'type'])

The section is augmented by each profile added to the system. The profile is the main function in the system, like oauth, openid connect etc

Path :

/profiles/profile{id, type}

Parameters:
  • id

    string

    (mandatory)

    A descriptive id of the profile

  • type

    profile-type

    (mandatory)

    This will result in filtering, so that an endpoint and a profilecan be matched, and only used when compatible

  • expose-detailed-error-messages

    empty

    (optional)

    Expose detailed error messages in the server responses whenever possible. By default, in case of failures due to external services or internal errors, the server returns a generic error message to avoid accidentally exposing sensitive information.

Authentication-service

settings/authentication-service

The Authentication Service is a Profile that enables Authentication on the server. It can be configured with any number of authenticators of any type.

Path :

/profiles/profile{id, type}/settings/authentication-service

Parameters:
  • tenant-id

    string

    (optional)

    ID of the tenant associated with this profile. Token Services and User Management Services linked to this Authentication profile inherit this tenant ID. When this value is set, most facilities and data, like accounts and credentials, will be isolated for each tenant.

  • sso-expiration-time

    uint32

    (default: 3600)

    The number of seconds the SSO session will be valid

  • sso-inactivity-timeout

    uint32

    (optional)

    The number of seconds the SSO session will be valid while not used

  • sso-cookie-is-session-cookie

    boolean

    (default: false)

    Whether the SSO cookie should persist only for the browser session, i.e. expire when browser is closed. Note that when set to true, the SSO cookie will expire when the browser session does regardless of the value set in sso-expiration-time or in sso-inactivity-timeout. The cookie will however never be valid for a longer duration than set by sso-expiration-time and sso-inactivity-timeout or the longest lasting sso-expiration-time and sso-inactivity-timeout set on any specific authenticator.

  • persisted-sso-session

    boolean

    (default: false)

    By default the SSO cookie is not persisted in a database. By setting this to true the cookie is persisted in the session store, and only a reference is used as cookie. This is needed if the SSO cookie contains large amounts of user data.

  • encode-persisted-sso-session-data

    boolean

    (default: false)

    When the sso session is persisted to database, this setting enables encoding of the session data. Useful to mitigate against charset encoding problems with the database

  • username-cookie-name

    string

    (default: username)

    The name of the cookie that stores the user’s preferences, like username and locale settings

  • logout-redirect-url

    uri

    (optional)

    If set, the user will be redirected to this URL after logout

  • enable-preflight

    boolean

    (default: true)

    By default the preflight endpoint will be enabled on the anonymous endpoint. This option allows the endpoint to be disabled.

  • protocol-id

    leafref ../protocols/protocol/id

    (optional)

    The id of the protocol plugin

  • sms-provider

    leafref /base:facilities/base:sms-providers/base:sms-provider/base:id

    (optional)

    The sms-provider to be used for this zone

  • api-driven-ui

    empty

    (optional)

    Enables the API-driven UI to be used on this authentication profile and linked oauth profiles.

  • cross-site-block-enabled

    boolean

    (optional)

    Enables the unsafe (e.g. POST) cross-site requests blocking mechanism. Blocks cross-site requests (those originating from a different or third-party domain) with an unsafe method from being accepted, except for endpoints the explicitly allow it. Disabling this feature can help with interoperability but does pose security risks, and should only be enabled if strictly required.

Base-url

settings/authentication-service/base-url

This setting will let this profile operate under specific URLs. It makes it possible to have many URLs running on the same Curity instance. Each authentication service will redirect using these settings if present. If this is not set, the profile will use the base-url setting from the environment section. The SSO can only occur inside a profile since the SSO cookie is bound to this URL.

Path :

/profiles/profile{id, type}/settings/authentication-service/base-url

Parameters:
  • default-base-url

    uri

    (mandatory)

    This URL is used as default. If the incoming request does not contain an X-Forwarded-Host header with a white-listed URL in the additional-base-url section, this one will be used.

  • additional-base-url

    uri

    (multi-value) (optional)

    This is a multi-value element where additional URLs can be configured. If the X-Forwarded-Host or Host Header contains any of these, it will be selected and used when redirecting internally.

Redirect-url-whitelist

settings/authentication-service/redirect-url-whitelist

This list is the profile wide redirect whitelist, any redirect will be validated against this list of hosts. By default the endpoints the profile interacts with such as the token service’s authorize, assisted-token and device flow endpoints are added to the list. Any external endpoints that the authentication service redirects to needs to be added here.

Path :/profiles/profile{id, type}/settings/authentication-service/redirect-url-whitelist
Parameters:url

uri

(multi-value) (optional)

Account-domain

settings/authentication-service/account-domains/account-domain{id} (keys ['id'])

The domain (i.e., grouping, organizational unit, realm) of accounts

Path :

/profiles/profile{id, type}/settings/authentication-service/account-domains/account-domain{id}

Parameters:
  • id

    string

    (mandatory)

    The given ID of an account domain

  • description

    string

    (optional)

    A description of the domain

Authentication-actions

settings/authentication-service/authentication-actions

Authentication Actions allow you to orchestrate what happens after the credentials are verified but before the session is committed.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions

Authentication-action

settings/authentication-service/authentication-actions/authentication-action{id} (keys ['id'])

An Authentication Action that can be assigned to authenticators

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}

Parameters:
  • id

    string

    (mandatory)

    The given ID of the Authentication Action

  • reference

    string

    (optional)

    Element linked to this authentication action

  • template-area

    non-empty-string

    (optional)

    Optional override for template area

  • cross-site-block-enabled

    boolean

    (optional)

    Enables the unsafe (e.g. POST) cross-site requests blocking mechanism. Blocks cross-site requests (those originating from a different or third-party domain) with an unsafe method from being accepted, except for endpoints the explicitly allow it. Disabling this feature can help with interoperability but does pose security risks, and should only be enabled if strictly required.

Choice: action-type
Option: signup
Signup
settings/authentication-service/authentication-actions/authentication-action{id}/signup
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup
Choice: registration-factor
Password
settings/authentication-service/authentication-actions/authentication-action{id}/signup/password
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/password
Parameters:credential-manager

leafref /base:processing/base:credential-managers/base:credential-manager/base:id

(mandatory)

The Credential Manager is used to verify the credentials

Authenticator
settings/authentication-service/authentication-actions/authentication-action{id}/signup/authenticator
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/authenticator
Signup-authenticator
settings/authentication-service/authentication-actions/authentication-action{id}/signup/authenticator/signup-authenticator
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/authenticator/signup-authenticator
Parameters:id

leafref ../../../../../../auth:authenticators/auth:authenticator/auth:id

(mandatory)

A reference to an authenticator

Bucket
settings/authentication-service/authentication-actions/authentication-action{id}/signup/authenticator/bucket

Reference to the Bucket data source used to store any additional info needed by the authenticator when creating a new account

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/authenticator/bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Signup-fields
settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields
Phone
settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields/phone
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields/phone
Parameters:required

boolean

(default: false)

First-name
settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields/first-name
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields/first-name
Parameters:required

boolean

(default: false)

Last-name
settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields/last-name
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields/last-name
Parameters:required

boolean

(default: false)

Custom-signup-fields
settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields/custom-signup-fields{name} (keys ['name'])

A custom account attribute

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/signup-fields/custom-signup-fields{name}

Parameters:
  • name

    string

    (mandatory)

    Attribute name

  • required

    boolean

    (default: false)

    User must provide value when creating new account

Account-manager
settings/authentication-service/authentication-actions/authentication-action{id}/signup/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/signup/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Option: bundle
Bundle
settings/authentication-service/authentication-actions/authentication-action{id}/bundle
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/bundle

Parameters:
  • description

    string

    (optional)

  • config-spec

    string

    (optional)

  • login-action

    leafref ../../../auth:authentication-action/auth:id

    (multi-value) (optional)

  • sso-action

    leafref ../../../auth:authentication-action/auth:id

    (multi-value) (optional)

Option: opt-in-mfa
Opt-in-mfa
settings/authentication-service/authentication-actions/authentication-action{id}/opt-in-mfa
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/opt-in-mfa

Parameters:
  • disable-recovery-codes

    boolean

    (default: false)

    Disable use of recovery codes

  • allow-authentication-with-recovery-code

    boolean

    (default: false)

    Allow using recovery codes to complete authentication

  • allow-authentication-with-sso-for-second-factor

    boolean

    (default: false)

    Allow using an SSO to complete second factor authentication

  • opt-out-ttl-in-days

    uint32

    (default: 0)

    TTL of the second factor opt-out, in days. If zero (the default), then second factor opt-out is not allowed

Account-manager
settings/authentication-service/authentication-actions/authentication-action{id}/opt-in-mfa/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/opt-in-mfa/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Mfa-state-bucket
settings/authentication-service/authentication-actions/authentication-action{id}/opt-in-mfa/mfa-state-bucket

Bucket to store MfA state in. Required for LDAP account managers.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/opt-in-mfa/mfa-state-bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Allowed-second-factor
settings/authentication-service/authentication-actions/authentication-action{id}/opt-in-mfa/allowed-second-factor{authenticator-id} (keys ['authenticator-id'])

List with the allowed second factors

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/opt-in-mfa/allowed-second-factor{authenticator-id}

Parameters:
  • authenticator-id

    leafref ../../../../../auth:authenticators/auth:authenticator/auth:id

    (mandatory)

    The second factor authenticator ID

  • description

    non-empty-string

    (optional)

    The authentication method description that appears in the user interface. If not defined, the authenticator description will be used

Option: multi-factor-condition
Multi-factor-condition
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition
Parameters:disable-second-factor-subject-check

boolean

(default: false)

Disables the second factor subject check, allowing the second factor subject to be different from the authenticated subject (i.e. first factor). Should only be enabled when different subjects are allowed and there is a check somewhere else verifying that the second factor subject value is adequate for the first subject value.

Choice: condition
The condition for which to use a second factor
Attribute-enable-condition
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/attribute-enable-condition
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/attribute-enable-condition

Parameters:
  • attribute-name

    string

    (default: requireSecondFactor)

    The name of the attribute that will contain the boolean to trigger the secondfactor. If the attribute is not found it is treated same as False

  • attribute-source

    attribute-location subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The location from where the attribute is retrieved.

Second-factor
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/attribute-enable-condition/second-factor

The authenticator to trigger as the second factor when the the condition is met.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/attribute-enable-condition/second-factor
Parameters:id

leafref ../../../../../../auth:authenticators/auth:authenticator/auth:id

(optional)

Attribute-acr-condition
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/attribute-acr-condition
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/attribute-acr-condition

Parameters:
  • attribute-name

    string

    (default: secondFactorAcr)

    The name of the attribute to look for that contains the ACR to use as second factor

  • attribute-source

    attribute-location subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The location from where the attribute is retrieved.

Subject-condition
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/subject-condition
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/subject-condition
Subject-pattern-condition
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/subject-condition/subject-pattern-condition{subject-pattern} (keys ['subject-pattern'])
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/subject-condition/subject-pattern-condition{subject-pattern}
Parameters:subject-pattern

string

(mandatory)

The regex to match the subject attribute against.

Second-factor
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/subject-condition/subject-pattern-condition{subject-pattern}/second-factor

The authenticator to use as second factor when the subject pattern matches

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/subject-condition/subject-pattern-condition{subject-pattern}/second-factor
Parameters:id

leafref ../../../../../../../auth:authenticators/auth:authenticator/auth:id

(optional)

Client-property-condition
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/client-property-condition
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/client-property-condition
Condition
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/client-property-condition/condition{condition-script} (keys ['condition-script'])
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/client-property-condition/condition{condition-script}
Parameters:condition-script

script

(mandatory)

The expression to run against the client attributes. This expression will be evaluated against the properties of the OAuth client that issued the request that started the authentication flow. Example expressions: client.id == ‘my-good-client’ client.properties.mfa-client == ‘true’

Second-factor
settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/client-property-condition/condition{condition-script}/second-factor

The authenticator to use as second factor when the expression returns true

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/multi-factor-condition/client-property-condition/condition{condition-script}/second-factor
Parameters:id

leafref ../../../../../../../auth:authenticators/auth:authenticator/auth:id

(optional)

Option: zone-transfer
Zone-transfer
settings/authentication-service/authentication-actions/authentication-action{id}/zone-transfer
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/zone-transfer

Parameters:
  • attribute

    non-empty-string

    (default: zone)

    Name of the attribute from which to extract the id of the intended zone.

  • attribute-source

    attribute-location subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    Location to search for the zone attribute.

  • cookie

    non-empty-string

    (default: zone)

    Name of the cookie that contains the zone id after a successful execution.

  • zones

    leafref /base:environments/base:environment/base:services/base:zones/base:zone/base:id

    (multi-value) (optional)

    The zones to be considered.

Option: switch
Switch
settings/authentication-service/authentication-actions/authentication-action{id}/switch
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/switch
Parameters:fail-if-no-match

boolean

(default: true)

If true (default value) the action will deny the authentication if no condition is matched. Otherwise it will succeed.

Case
settings/authentication-service/authentication-actions/authentication-action{id}/switch/case{name} (keys ['name'])
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/switch/case{name}

Parameters:
  • name

    string

    (mandatory)

    A mandatory unique name for this switch case

  • condition-script

    script

    (mandatory)

    The JavaScript boolean expression conditioning the execution of this case’s authenticator.

  • action

    leafref ../../../../auth:authentication-action/auth:id

    (mandatory)

    The authentication action to run if the condition is true.

Option: sequence
Sequence
settings/authentication-service/authentication-actions/authentication-action{id}/sequence
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/sequence
Parameters:action

leafref ../../../auth:authentication-action/auth:id

(multi-value) (optional)

Option: selector
Selector
settings/authentication-service/authentication-actions/authentication-action{id}/selector
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/selector

Parameters:
  • attribute-name

    string

    (mandatory)

    Name of the output attribute.

  • attribute-target

    enumeration subject-attributes, context-attributes, action-attributes

    (default: action-attributes)

    Location to add the output attribute.

  • title

    string

    (optional)

    The title to be displayed for the selection. Can be a message key.

Option
settings/authentication-service/authentication-actions/authentication-action{id}/selector/option{title} (keys ['title'])

Options to be presented to the user.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/selector/option{title}
Parameters:title

string

(mandatory)

The text to be displayed for this option. Can be a message key.

Choice: attribute-value
Option: boolean-attribute-value
param boolean-attribute-value:
 

boolean

(optional)

Option: integer-attribute-value
param integer-attribute-value:
 

int64

(optional)

Option: string-attribute-value
param string-attribute-value:
 

string

(optional)

Option: script-transformer
Script-transformer
settings/authentication-service/authentication-actions/authentication-action{id}/script-transformer
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/script-transformer

Parameters:
  • attributes-location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The source and destination of the transformed attributes.

  • transformation-procedure

    leafref /base:processing/base:procedures/base:transformation-procedure/base:id

    (mandatory)

  • excluded-attributes

    string

    (multi-value) (optional)

    This is an optional list where attributes can be listed that should be removed from the original set of parameters. If the name of the attribute matches what the authentication returned, that attribute will be removed. The excluded attributes need to have a fully qualified path. Example: emails.email.value, or to remove all emails: emails

Option: copy-attribute
Copy-attribute
settings/authentication-service/authentication-actions/authentication-action{id}/copy-attribute
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/copy-attribute
Operation
settings/authentication-service/authentication-actions/authentication-action{id}/copy-attribute/operation{name} (keys ['name'])

List of attributes to copy or move from one location to another

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/copy-attribute/operation{name}

Parameters:
  • name

    string

    (mandatory)

    Unique identifier of the operation

  • move

    boolean

    (default: false)

    When true, the attribute is moved, instead of being copied, from the source location to the target one

  • source-is-attribute-name

    boolean

    (default: false)

    The source path is literal, and does not represent a path. Enable this if your attribute names contain a period, which would indicate that it is addressing a nested object.

  • source-location

    enumeration subject-attributes, context-attributes, action-attributes

    (mandatory)

    The source location of the attribute to copy: Subject attributes, Context attributes or Action attributes

  • source-path

    string

    (mandatory)

    The path to the source attribute to copy

  • target-is-attribute-name

    boolean

    (default: false)

    The target path is literal, and does not represent a path. Enable this if the attribute you are creating contains a period, which would indicate that it is addressing a nested object.

  • target-location

    enumeration subject-attributes, context-attributes, action-attributes

    (mandatory)

    The target location to copy the attribute to: Subject attributes, Context attributes or Action attributes

  • target-path

    string

    (mandatory)

    The path to the destination to copy the attribute to

Option: remove-attribute-transformer
Remove-attribute-transformer
settings/authentication-service/authentication-actions/authentication-action{id}/remove-attribute-transformer
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/remove-attribute-transformer

Parameters:
  • attributes-location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The source and destination of the transformed attributes.

  • excluded-attributes

    string

    (multi-value) (optional)

    This is an optional list where attributes can be listed that should be removed from the original set of parameters. If the name of the attribute matches what the authentication returned, that attribute will be removed. The excluded attributes need to have a fully qualified path. Example: emails.email.value, or to remove all emails: emails

Option: changed-country
Changed-country
settings/authentication-service/authentication-actions/authentication-action{id}/changed-country
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/changed-country

Parameters:
  • changed-country-action-attribute-location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The location where the attribute with the action result will be added. The default location are the subject attributes.

  • changed-country-action-attribute-name

    string

    (default: requireSecondFactor)

    The name of the attribute that will be potentially used from a following action.

Bucket
settings/authentication-service/authentication-actions/authentication-action{id}/changed-country/bucket
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/changed-country/bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Option: require-active-account
Require-active-account
settings/authentication-service/authentication-actions/authentication-action{id}/require-active-account
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/require-active-account
Account-manager
settings/authentication-service/authentication-actions/authentication-action{id}/require-active-account/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/require-active-account/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Option: deny
Deny
settings/authentication-service/authentication-actions/authentication-action{id}/deny
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/deny
Parameters:error

string

(optional)

The error string used when the action denies the authentication.

Choice: mode
Option: always
Always
settings/authentication-service/authentication-actions/authentication-action{id}/deny/always

Always deny authentication.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/deny/always
Option: attribute-condition
Attribute-condition
settings/authentication-service/authentication-actions/authentication-action{id}/deny/attribute-condition

Deny authentication depending on the presence of an attribute.

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/deny/attribute-condition

Parameters:
  • expected-value

    boolean

    (default: true)

    The expected attribute’s value that determines whether authentication is denied.

  • name

    string

    (mandatory)

    The name of the attribute that determines whether authentication is denied. If the attribute is present and its value matches the expected boolean value, the authentication is denied; otherwise, it proceeds.

  • source

    enumeration subject-attributes, context-attributes, action-attributes

    (mandatory)

    Location to search for the attribute that determines whether authentication is denied.

Option: data-source-transformer
Data-source-transformer
settings/authentication-service/authentication-actions/authentication-action{id}/data-source-transformer
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/data-source-transformer
Parameters:attributes-location

enumeration subject-attributes, context-attributes, action-attributes

(default: subject-attributes)

The source and destination of the transformed attributes.

Attribute-data-source
settings/authentication-service/authentication-actions/authentication-action{id}/data-source-transformer/attribute-data-source
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/data-source-transformer/attribute-data-source

Parameters:
  • data-source

    leafref /base:facilities/base:data-sources/base:data-source/base:id

    (mandatory)

    A reference to a data source

  • additional-attributes-to-include

    string

    (multi-value) (optional)

    This is a whitelist of attributes that if returned by the data source will be added to thetransformation response

Attributes
settings/authentication-service/authentication-actions/authentication-action{id}/data-source-transformer/attributes{attribute-name} (keys ['attribute-name'])

The list of attributes to perform the transformation on

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/data-source-transformer/attributes{attribute-name}

Parameters:
  • attribute-name

    string

    (mandatory)

    The name of the attribute, that the transformation will be applied on. This attribute will be created if its not returned by the data source, as long as a value can be found.

  • transformed-attribute-name

    string

    (optional)

    The name of the resulting attribute after the transformation is applied, if not set the name will be the same as the original attribute

  • use-value-of-attribute-named

    string

    (mandatory)

    The name of the attribute (eg. column) that contains the replacement value for the attribute

  • excluded-attributes

    string

    (multi-value) (optional)

    This is an optional list where attributes can be listed that should be removed from the original set of parameters. If the name of the attribute matches what the authentication returned, that attribute will be removed. The excluded attributes need to have a fully qualified path. Example: emails.email.value, or to remove all emails: emails

Option: reset-password
Reset-password
settings/authentication-service/authentication-actions/authentication-action{id}/reset-password
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/reset-password

Parameters:
  • allow-skip

    boolean

    (default: false)

    When this is set to true, the users will be able to skip the password reset.

  • attribute

    string

    (default: resetPassword)

    When this attribute is found in the subject attributes and set to ‘true’, the user will be prompted with an option to perform a password update.

  • attribute-source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    Source location for the attribute controlling the password update.

  • regular-expression

    string

    (optional)

    Regular expression which checks the strength of the submitted password

Account-manager
settings/authentication-service/authentication-actions/authentication-action{id}/reset-password/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/reset-password/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Credential-manager
settings/authentication-service/authentication-actions/authentication-action{id}/reset-password/credential-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/reset-password/credential-manager
Parameters:id

leafref /base:processing/base:credential-managers/base:credential-manager/base:id

(mandatory)

A reference to a Credential Manager

Option: set-attribute
Set-attribute
settings/authentication-service/authentication-actions/authentication-action{id}/set-attribute
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/set-attribute
Attribute
settings/authentication-service/authentication-actions/authentication-action{id}/set-attribute/attribute{name} (keys ['name'])

List of additional attributes, their values and location.

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/set-attribute/attribute{name}

Parameters:
  • name

    string

    (mandatory)

    Name of an attribute. By default this will be treated as an attribute path, meaning this action may be used to create nested attributes.

  • is-attribute-name

    boolean

    (default: false)

    The name is literal, and does not represent a path. Enable this if your attribute names contain a period, which would indicate that it is addressing a nested object.

  • target

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The destination of the additional attribute.

Choice: value
Option: boolean-value
param boolean-value:
 

boolean

(optional)

Boolean value of an additional attribute

Option: integer-value
param integer-value:
 

int32

(optional)

Integer value of an additional attribute

Option: string-value
param string-value:
 

string

(optional)

String value of an additional attribute

Option: restart
Restart
settings/authentication-service/authentication-actions/authentication-action{id}/restart
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/restart
Parameters:re-run-authenticator

boolean

(default: false)

The flag indicating whether authenticator should run after the pipeline restart.

Choice: mode
Option: always
Always
settings/authentication-service/authentication-actions/authentication-action{id}/restart/always

Always restart authentication pipeline.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/restart/always
Option: attribute-condition
Attribute-condition
settings/authentication-service/authentication-actions/authentication-action{id}/restart/attribute-condition

Restart authentication pipeline depending on the presence of an attribute.

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/restart/attribute-condition

Parameters:
  • expected-value

    boolean

    (default: true)

    The expected attribute’s value that determines whether the pipeline is restarted.

  • name

    string

    (mandatory)

    The attribute name.

  • source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: action-attributes)

    The attribute location.

Option: allow-deny-country
Allow-deny-country
settings/authentication-service/authentication-actions/authentication-action{id}/allow-deny-country
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/allow-deny-country

Parameters:
  • allow-listed-countries

    boolean

    (default: true)

    Enable to allow the countries in the list, disable to deny them.

  • country-list-to-allow-or-deny

    string

    (multi-value) (optional)

    The list of countries to allow or deny.

Option: attribute-prompt
Attribute-prompt
settings/authentication-service/authentication-actions/authentication-action{id}/attribute-prompt
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/attribute-prompt
Required-attribute
settings/authentication-service/authentication-actions/authentication-action{id}/attribute-prompt/required-attribute{name} (keys ['name'])
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/attribute-prompt/required-attribute{name}

Parameters:
  • name

    string

    (mandatory)

  • attribute-source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

  • regular-expression

    string

    (optional)

    A regular expression to validate the value of this field.

  • required

    boolean

    (default: false)

  • type

    enumeration text, email, url, password, checkbox, number, tel, color

    (default: text)

Option: request-acknowledgement
Request-acknowledgement
settings/authentication-service/authentication-actions/authentication-action{id}/request-acknowledgement
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/request-acknowledgement

Parameters:
  • accept-button-label

    string

    (optional)

    The label displayed on the button to accept the acknowledgement. This message can be configured and localized using message keys.

  • cancel-button-label

    string

    (optional)

    The label displayed on the button to cancel or decline the acknowledgement. This message can be configured and localized using message keys.

  • cancellable

    boolean

    (default: true)

    When true the user can cancel or decline the acknowledgement request. When false the user can only accept it.

  • message

    string

    (mandatory)

    The acknowledgement request message displayed to the user so that he can accept or decline it. This message can be configured and localized using message keys.

Choice: mode
Option: always
Always
settings/authentication-service/authentication-actions/authentication-action{id}/request-acknowledgement/always

The acknowledgement is always requested

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/request-acknowledgement/always
Option: attribute-condition
Attribute-condition
settings/authentication-service/authentication-actions/authentication-action{id}/request-acknowledgement/attribute-condition

The acknowledgement is requested only if an attribute is present in one of the attributes location. If the attribute is present, the user already responded to the acknowledgement and it is not requested anymore. Otherwise the user response is requested.

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/request-acknowledgement/attribute-condition

Parameters:
  • location

    enumeration subject-attributes, context-attributes, action-attributes

    (mandatory)

    Location to search or store the attribute.

  • name

    string

    (mandatory)

    The name under which to search or store the attribute.

User-response-attribute
settings/authentication-service/authentication-actions/authentication-action{id}/request-acknowledgement/user-response-attribute

The attribute’s name storing the user response as a boolean value

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/request-acknowledgement/user-response-attribute

Parameters:
  • location

    enumeration subject-attributes, context-attributes, action-attributes

    (mandatory)

    Location to search or store the attribute.

  • name

    string

    (mandatory)

    The name under which to search or store the attribute.

Option: lookup-linked-accounts-transformer
Lookup-linked-accounts-transformer
settings/authentication-service/authentication-actions/authentication-action{id}/lookup-linked-accounts-transformer
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/lookup-linked-accounts-transformer

Parameters:
  • attribute-name

    string

    (default: linked_accounts)

    The attribute name to store the list of linked accounts in

  • attribute-target

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The target location for the attribute with the list of linked accounts.

Linking-account-manager
settings/authentication-service/authentication-actions/authentication-action{id}/lookup-linked-accounts-transformer/linking-account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/lookup-linked-accounts-transformer/linking-account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Linking-account-domain
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/auto-link-account/linking-account-domain
Parameters:id

leafref ../../../../../auth:account-domains/auth:account-domain/auth:id

(mandatory)

A reference to an Account Domain

Advanced

This option allows you to store the links using some arbitrary attribute from the Authenticated Session, instead of the account id. Use with caution!

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/auto-link-account/advanced

Parameters:
  • account-id-in-attribute

    union

    (mandatory)

    The name of the attribute containing the account ID. This is used as the local account in the link. If use-linked-account-as-main-account is enabled, then this attribute is picked from the Authenticated Sessions, otherwise it is taken from the incoming attributes from the authenticator this action runs on. No check is made to verify that the account corresponding to the given ID exists. It is strongly recommended to NOT use an attribute that might change such as subject (username) or email. Doing this might cause several problems as there is no guarantee that the value of this attribute is globally unique and immutable. It is strongly suggested to use a auto-create-account action before this one, instead, to avoid any future issues.

  • account-id-in-attribute-source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The source location for the attribute containing the account ID. Defaults to subject-attributes

User-confirmation

Require the user to confirm the links. By default the link establishment is automatic. Use this setting to enable and configure user confirmation.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/auto-link-account/user-confirmation
Parameters:linking-account-domain-name

string

(optional)

Override the domain name shown on the confirmation user interface

Attribute-for-foreign-identifier

The attribute with the foreign identifier to use on the user confirmation. By default, the subject attribute will be used

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/auto-link-account/user-confirmation/attribute-for-foreign-identifier

Parameters:
  • location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The attribute location

  • name

    string

    (mandatory)

    The attribute name

Attribute-for-local-identifier

The attribute with the local identifier to use on the user confirmation. By default, the subject attribute will be used

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/auto-link-account/user-confirmation/attribute-for-local-identifier

Parameters:
  • location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The attribute location

  • name

    string

    (mandatory)

    The attribute name

Option: resolve-linked-account-transformer
Resolve-linked-account-transformer
settings/authentication-service/authentication-actions/authentication-action{id}/resolve-linked-account-transformer
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/resolve-linked-account-transformer

Parameters:
  • fail-on-no-link

    boolean

    (default: false)

    Set to true if this action should fail if no link could be resolved

  • linked-domain-attribute-name

    string

    (optional)

    The name of the authentication-attribute to put the linked domain in

  • linked-domain-attribute-target

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The target location where to put the attribute with the linked domain in.

  • original-subject-attribute-name

    string

    (optional)

    The name of the authentication-attribute to put the original subject in

  • original-subject-attribute-target

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The target location where to put the attribute with the original subject in.

Linking-account-domain
settings/authentication-service/authentication-actions/authentication-action{id}/resolve-linked-account-transformer/linking-account-domain
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/resolve-linked-account-transformer/linking-account-domain
Parameters:id

leafref ../../../../../auth:account-domains/auth:account-domain/auth:id

(mandatory)

A reference to an Account Domain

Linking-account-manager
settings/authentication-service/authentication-actions/authentication-action{id}/resolve-linked-account-transformer/linking-account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/resolve-linked-account-transformer/linking-account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Option: send-email
Send-email
settings/authentication-service/authentication-actions/authentication-action{id}/send-email
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/send-email

Parameters:
  • recipient-attribute-name

    string

    (mandatory)

    The name of the attribute containing the email recipient.

  • recipient-attribute-source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    Location to search for the attribute containing the email recipient.

Email-provider
settings/authentication-service/authentication-actions/authentication-action{id}/send-email/email-provider
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/send-email/email-provider
Parameters:id

leafref /base:facilities/base:email-providers/base:email-provider/base:id

(mandatory)

A reference to the Email-Provider

Choice: mode
Option: content
Content
settings/authentication-service/authentication-actions/authentication-action{id}/send-email/content

Configuration of the email content.

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/send-email/content

Parameters:
  • body

    string

    (mandatory)

    The email body.

  • subject

    string

    (mandatory)

    The email subject.

  • title

    string

    (mandatory)

    The email title.

Option: template
param template:

string

(optional)

Name of the template to use for the email content.

Option: auto-create-account
Auto-create-account
settings/authentication-service/authentication-actions/authentication-action{id}/auto-create-account
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/auto-create-account

Parameters:
  • add-extra-attributes

    boolean

    (default: false)

    Add all other attributes from the configured location to the account (subject attributes are used by default)

  • auto-create-link

    boolean

    (default: false)

    When this is set to ‘true’ and the authenticator belongs to a domain, a link will be created on the authenticator’s domain with foreignAccount the ‘subject’, using the same account manager used to create the account.

  • email-attribute

    string

    (optional)

    The attribute containing the email for the new account. If not configured, a unique email will be generated for the account. If configured but no attribute is found, a server error will occur.

  • email-attribute-source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    Source location for the attribute containing the email.

  • extra-attributes-source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    Source location for the additional attributes to add to the account.

  • fail-on-conflicts

    boolean

    (default: false)

    When this is set to ‘true’, the action will fail authentication if the account cannot be created, for example if the email is used by some other account.

  • phone-number-attribute

    string

    (optional)

    The attribute containing the phone number for the new account. If configured but no attribute is found, a server error will occur.

  • phone-number-attribute-source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    Source location for the attribute containing the phone number.

  • username-attribute

    string

    (default: subject)

    The attribute containing the username for the new account. If this attribute is not found, a server error will occur.

  • username-attribute-source

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    Source location for the attribute containing the username.

Account-manager
settings/authentication-service/authentication-actions/authentication-action{id}/auto-create-account/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/auto-create-account/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Option: regex-transformer
Regex-transformer
settings/authentication-service/authentication-actions/authentication-action{id}/regex-transformer
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/regex-transformer
Parameters:attributes-location

enumeration subject-attributes, context-attributes, action-attributes

(default: subject-attributes)

The source and destination of the transformed attributes.

Attributes
settings/authentication-service/authentication-actions/authentication-action{id}/regex-transformer/attributes{attribute-base-path, attribute-name} (keys ['attribute-base-path', 'attribute-name'])

This transformer applies the defined regex on the matching key. The username key is called ‘subject’ and if omitted will be passed through without change. If a matching-regex is omitted, the attribute will be passed through without change of value, but might be given a new name.If an attribute value doesn’t match any key, the transformer will ignore that value and it will be passed through.

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/regex-transformer/attributes{attribute-base-path, attribute-name}

Parameters:
  • attribute-base-path

    string

    (mandatory)

    The location of the attribute in the Attributes tree structure. This contains the path without the attribute name. Example: emails.email or name It’s also possible to address root elements by using the $root keyword: $root.subject. If the element is directly under the top level simply set the path to $root, if it’s nested either use the example above or explicitly state root via $root.emails.email

  • attribute-name

    string

    (mandatory)

    The name of the attribute, that the regex will be applied on. The attribute is looked for in the path given in attribute-base-path To address the value of an email, simply set the attribute-base-path to $root.emails.email and the attribute-name to value

  • matching-regex

    string

    (optional)

    The regular expression to apply on the attribute value, in the form of a regex patternIf the value is a multivalued attribute (list elements) the regex will be applied on all values individually.All values will be included in the result, if the regex didn’t match, the original value is included.

  • replacement-value

    string

    (optional)

    The string or expression to replace the matching portion of the attribute value with. Must be set of the matching-regex is set.

  • transformed-attribute-name

    string

    (optional)

    The name of the resulting attribute after the transformation is applied, if not set the name will be thesame as the original attribute name. Note: This is placed in the attribute-base-path same as the attribute-name that it is replacing. It is not possible to move elements around in the structure, replacement and renaming is done on the same path

  • excluded-attributes

    string

    (multi-value) (optional)

    This is an optional list where attributes can be listed that should be removed from the original set of parameters. If the name of the attribute matches what the authentication returned, that attribute will be removed. The excluded attributes need to have a fully qualified path. Example: emails.email.value, or to remove all emails: emails

Option: impossible-journey
Impossible-journey
settings/authentication-service/authentication-actions/authentication-action{id}/impossible-journey
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/impossible-journey

Parameters:
  • impossible-journey-action-attribute-location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The location where the attribute with the action result will be added. The default location are the subject attributes.

  • impossible-journey-action-attribute-name

    string

    (default: requireSecondFactor)

    The name of the attribute that will be potentially used from a following action.

  • speed-in-kmh-for-impossible-journey-calculations

    int32

    (default: 250)

    The speed that can dictate if a journey is impossible (km/h). Default is 250 km/h.

Bucket
settings/authentication-service/authentication-actions/authentication-action{id}/impossible-journey/bucket
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/impossible-journey/bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Option: new-country
New-country
settings/authentication-service/authentication-actions/authentication-action{id}/new-country
Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/new-country

Parameters:
  • new-country-action-attribute-location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: subject-attributes)

    The location where the attribute with the action result will be added. The default location are the subject attributes.

  • new-country-action-attribute-name

    string

    (default: requireSecondFactor)

    The name of the attribute that will be potentially used from a following action.

Bucket
settings/authentication-service/authentication-actions/authentication-action{id}/new-country/bucket
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/new-country/bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Option: update-account
Update-account
settings/authentication-service/authentication-actions/authentication-action{id}/update-account
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/update-account
Account-manager
settings/authentication-service/authentication-actions/authentication-action{id}/update-account/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/update-account/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Operation
settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name} (keys ['name'])

The list of operations to be performed on the account.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}
Parameters:name

string

(mandatory)

The operation name.

Choice: operation
Option: add-attribute
Add-attribute
settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/add-attribute

Adds an attribute.

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/add-attribute

Parameters:
  • source-attribute-is-required

    boolean

    (default: false)

    If enabled, the action will return failure if the source attribute is not found. The default behavior is to ignore the operation.

  • source-attribute-location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: action-attributes)

    The location on which the source attribute is searched.

  • source-attribute-path

    string

    (mandatory)

    The path to the source attribute, i.e., the attribute containing the value used on the addition.

  • target-attribute-path

    string

    (mandatory)

    The path to the the account attribute to be added.

Convert-to-multi-valued
settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/add-attribute/convert-to-multi-valued

Convert the value into a multi-valued attribute value

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/add-attribute/convert-to-multi-valued
Parameters:primary

boolean

(default: false)

Is the primary value?

Option: delete-attribute
Delete-attribute
settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/delete-attribute

Deletes an attribute.

Path :/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/delete-attribute
Parameters:target-attribute-path

string

(mandatory)

The path to the the account attribute to be deleted.

Option: replace-attribute
Replace-attribute
settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/replace-attribute

Replaces an attribute.

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/replace-attribute

Parameters:
  • source-attribute-is-required

    boolean

    (default: false)

    If enabled, the action will return failure if the source attribute is not found. The default behavior is to ignore the operation.

  • source-attribute-location

    enumeration subject-attributes, context-attributes, action-attributes

    (default: action-attributes)

    The location on which the source attribute is searched.

  • source-attribute-path

    string

    (mandatory)

    The path to the source attribute, i.e., the attribute containing the value used on replace.

  • target-attribute-path

    string

    (mandatory)

    The path to the the account attribute to be replaced.

Convert-to-multi-valued
settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/replace-attribute/convert-to-multi-valued

Convert the value into a multi-valued attribute value

Path :

/profiles/profile{id, type}/settings/authentication-service/authentication-actions/authentication-action{id}/update-account/operation{name}/replace-attribute/convert-to-multi-valued

Parameters:
  • primary

    boolean

    (default: false)

    Is the primary value?

  • include-attributes-of-all-authenticators

    empty

    (optional)

    When present, the attributes issued by the additional authentication factors will be included, alongside with the attributes issued by the main authenticator. The attributes from the additional authenticators will have authority equal to the authenticator’s ACR. The attributes from the main authenticator don’t have any authority.

Authenticator

authenticator (keys: ['id'])
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}

Parameters:
  • id

    string

    (mandatory)

  • authentication-context-class-reference

    string

    (optional)

    The Authentication Context Class Reference (ACR) that this authenticator supports

  • account-domain

    leafref ../../../account-domains/account-domain/id

    (optional)

    Optional domain in which accounts are stored

  • description

    string

    (optional)

    A readable description of the Authenticator, for User presentation, can be a locale key

  • sso-expiration-time

    uint32

    (optional)

    This controls the expiration time for this specific authenticator. If this is not set, the value set on the profile will be used instead.A common scenario is to allow some factors to have longer lifetimes than others, which is accomplished by setting this value on the authenticator in question

  • sso-inactivity-timeout

    uint32

    (optional)

    The maximum time an SSO session created by this authenticator will be valid without being used. If this value is not set, then the profile value will be used (if set there).

  • previous-authenticator

    leafref ../../../authenticators/authenticator/id

    (optional)

    Optional authenticator (or any from a group) that the user must authenticate with prior to this one

  • purpose

    union

    (optional)

    A category of usage that this authenticator instance is intended for.

  • template-area

    non-empty-string

    (optional)

    Optional override for template area

  • cross-site-block-enabled

    boolean

    (optional)

    Enables the unsafe (e.g. POST) cross-site requests blocking mechanism. Blocks cross-site requests (those originating from a different or third-party domain) with an unsafe method from being accepted, except for endpoints the explicitly allow it. Disabling this feature can help with interoperability but does pose security risks, and should only be enabled if strictly required.

Geo-filtering

geo-filtering
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/geo-filtering

Parameters:
  • allow-authenticator

    boolean

    (default: false)

    If enabled then allow the countries in the list to use the authenticator. Deny otherwise.

  • filter-countries

    non-empty-string

    (multi-value) (optional)

    The list of countries (ISO-3166 code) that are allowed or denied to use the authenticators.

Authentication-actions

authentication-actions
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/authentication-actions

Parameters:
  • login

    leafref ../../../../authentication-actions/authentication-action/id

    (multi-value) (optional)

    An ordered list of actions that will run after authentication is complete. They can work on the attributes (including subject) that the authenticator has returned, and shape these to match the desired pattern/format, and can reject the authentication if necessary

  • sso

    leafref ../../../../authentication-actions/authentication-action/id

    (multi-value) (optional)

    An ordered list of actions that will run when single sign-on with the current acr is complete. They will work on the attributes that was returned at the original authentication. They can reject the sso if necessary

Choice: registration-requirement

param required-authentication-action-for-registration:
 

leafref ../../../authentication-actions/authentication-action/id

(multi-value) (optional)

Optional authentication action that must explicitly allow for this registration to occur

param required-authenticator-for-registration:
 

leafref ../../../authenticators/authenticator/id

(optional)

Optional authenticator (or any from a group) that the user must authenticate with prior to this registering with this.

Request-validations

request-validations
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/request-validations
Request-validation
request-validations/request-validation{request-subpath, endpoint, http-method} (keys ['request-subpath', 'endpoint', 'http-method'])

Procedures that will execute to validate the request data

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/request-validations/request-validation{request-subpath, endpoint, http-method}

Parameters:
  • request-subpath

    string

    (mandatory)

  • endpoint

    leafref /base:profiles/base:profile[base:type=current()/../../../../../../../base:type][base:id=current()/../../../../../../../base:id]/base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint that this subpath exists on

  • http-method

    enumeration get, post

    (mandatory)

  • validation-procedure

    leafref /base:processing/base:procedures/base:validation-procedure/base:id

    (mandatory)

Choice: authenticator-type

Group

group

A group of authenticators, any one can be picked and will represent the group. (Logical OR)

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/group

Parameters:
  • skip-selection-when-single-authenticator

    boolean

    (default: false)

    Controls whether the authenticator selection should be skipped when a single authenticator is available in the group

  • authenticators

    leafref ../../../../authenticators/authenticator/id

    (multi-value) (optional)

    The authenticators that belong to the group

Sms

sms

An SMS authenticator. Sends a challange over SMS

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/sms

Parameters:
  • send-otp-as-code

    boolean

    (default: false)

    The OTP in the SMS will be a regular OTP and not a hyperlink

  • otp-length

    uint16

    (default: 6)

    The length of the OTP

  • otp-or-hyperlink-time-to-live

    uint32

    (default: 60)

    The time the OTP or the hyperlink is valid

  • allow-registration-during-login

    boolean

    (default: true)

    Whether or not users should be able to add a new device during the login process

  • show-info-before-registration

    boolean

    (default: true)

    Whether or not the information page should be shown before the registration page

  • max-allowed-attempts

    uint16

    (default: 3)

    The maximum number times a user is allowed to try to validate a OTP. When this value is set to 0, there is no maximum attempts enforced.

  • max-challenges-sent

    uint16

    (default: 3)

    The maximum number of OTP or hyperlinks that is allowed to be sent during one session. When this value is set to 0, there is no maximum attempts enforced.

  • auto-login-enabled

    boolean

    (default: false)

    When active a login will be automatically performed after a successful registration

Choice: account-manager-or-intermediate-attribute
param account-manager:
 

leafref /base:processing/base:account-managers/base:account-manager/base:id

(optional)

The Account Manager is used to fetch the account

param intermediate-attribute-name:
 

string

(optional)

The intermediate subject attribute that contains the identifier to use when this authenticator is used as a second factor, if configured, the account manager must not be configured

Email

email

An email authenticator. Sends a challenge over email

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/email

Parameters:
  • max-challenges-sent

    uint16

    (default: 3)

    The maximum number of Email-challenges that is allowed to be sent during one session. When this value is set to 0, there is no maximum attempts enforced.

  • max-allowed-attempts

    uint16

    (default: 3)

    The maximum number times a user can try to validate the nonce sent with a hyperlink. When this value is set to 0, there is no maximum attempts enforced.

  • allow-inactive-accounts

    boolean

    (default: false)

    If set to true, the authenticator will not check if the account is active before sending the hyperlink.

  • activate-inactive-accounts

    boolean

    (default: false)

    If set to true, the authenticator will change the account status to active once the hyperlink sent was consumed by the user.

Send-otp-as-code
email/send-otp-as-code
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/email/send-otp-as-code

Parameters:
  • otp-time-to-live

    uint32

    (default: 120)

    The time the OTP is valid

  • otp-length

    uint16

    (default: 6)

    The length of the OTP

Choice: account-manager-or-intermediate-attribute
param account-manager:
 

leafref /base:processing/base:account-managers/base:account-manager/base:id

(optional)

The Account Manager is used to fetch the account

param intermediate-attribute-name:
 

string

(optional)

The intermediate subject attribute that contains the identifier to use when this authenticator is used as a second factor, if configured, the account manager must not be configured

Encap

encap

The settings for an Encap authentication provider

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/encap

Parameters:
  • account-manager

    leafref /base:processing/base:account-managers/base:account-manager/base:id

    (mandatory)

    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

    (mandatory)

    The ID of the authentication service Encap client

  • application-id

    string

    (default: 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

    (mandatory)

    The URL to where the Encap webservice is located (e.g., https://demo.encapsecurity.com/pt)

  • allow-registration-during-login

    boolean

    (default: true)

    Whether or not users should be able to add a new device during the login process

  • show-info-before-registration

    boolean

    (default: true)

    Whether or not the information page should be shown before the registration page

  • client-key-id

    leafref /base:facilities/base:crypto/base:signing-keys/base:signing-key/base:id

    (mandatory)

    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

    (default: text/plain)

    The content type of the context-content

  • max-allowed-attempts

    uint16

    (default: 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

    (default: false)

    When active a login will be automatically performed after a successful registration

Non-interactive-registration
encap/non-interactive-registration

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.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/encap/non-interactive-registration
Parameters:app-url

uri

(mandatory)

The custom scheme url to redirect to with the activation code (myapp://some-redirect)

Option: google

Google

google

Google OpenID Connect methods

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/google

Parameters:
  • configuration-url

    uri

    (default: https://accounts.google.com/.well-known/openid-configuration)

    The url to the openid-configuration document at Google

  • client-id

    string

    (mandatory)

    The client-id, registered at Google

  • client-secret

    non-empty-string

    (optional)

    The client-secret, registered at Google

  • scope

    string

    (default: openid profile email)

    Scope to ask Google for, space separated, note that if using google apps with custom domains the openid, profile and email scopes need to be present.

  • clock-skew

    uint32

    (default: 60)

    The allowed clock-skew in seconds when validating the JWT from the OpenID Server

  • authentication-context-class-reference

    non-empty-string

    (optional)

    The Authentication Context Class Reference (ACR) or authentication method that the OpenID Server should require

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (optional)

    A reference to the Http Client to use. If not defined, the default HTTP client is used

  • map-to-subject

    string

    (optional)

    The claim to use as subject

  • hosted-domain

    string

    (optional)

    This can be set to a google apps domain, such as your-company.com it will then only accept authentications done with an account in that domain

  • prompt-select-account

    enumeration always, if-reauthentication-requested

    (optional)

    Force google to show the select account screen.

Option: html-form

Html-form

html-form

The settings for an HTML form authentication provider

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/html-form

Parameters:
  • email-provider

    leafref /base:facilities/base:email-providers/base:email-provider/base:id

    (optional)

    Optional email-provider to use for ‘forgot password’ and ‘forgot username’ procedures. This overrides the default email provider that is configured for the zone.

  • max-allowed-attempts

    uint16

    (default: 3)

    DEPRECATED: The maximum number times a user is allowed to try to validate credentials. When this value is set to 0, there is no maximum attempts enforced. This setting is deprecated in favor of configuring a credential policy, with temporary lockout, on the credential manager associated to this authenticator.

  • password-only

    boolean

    (default: false)

    When active, this authenticator will only be usable as a second factor. The username is picked up by the authenticated state and the user is asked to enter only a password.

  • auto-login-enabled

    boolean

    (default: false)

    When active a login will be automatically performed after a successful activation or password change.

  • show-remember-me-option

    boolean

    (default: false)

    When true, a checkbox with ‘remember me’ is shown to the user. This allows the user to have it’s session forgotten when the browser is closed.

  • account-manager

    leafref /base:processing/base:account-managers/base:account-manager/base:id

    (optional)

    The Account Manager is used to fetch the account

  • credential-manager

    leafref /base:processing/base:credential-managers/base:credential-manager/base:id

    (mandatory)

    The Credential Manager is used to verify the credentials

Option: windows

Windows

windows

The settings for a Windows authentication provider

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/windows

Parameters:
  • symmetric-key

    base64-encoded-string

    (mandatory)

    The shared secret used to decrypt identity data sent from the Windows Connector

  • windows-connector-url

    uri

    (mandatory)

    The URL, including the scheme, host, port, and URI, of the Windows Connector

  • fail-over-authenticator

    leafref ../../../auth:authenticator/auth:id

    (optional)

    The authenticator that a user should login with if Integrated Windows Authentication (IWA) fails

Option: pingfederate

Pingfederate

pingfederate
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/pingfederate

Parameters:
  • sso-endpoint

    string

    (mandatory)

  • pickup-url

    string

    (mandatory)

  • pickup-username

    string

    (optional)

  • pickup-password

    string

    (optional)

  • sp-adapter-id

    string

    (mandatory)

  • use-template-redirect

    boolean

    (default: false)

    Use a template form to redirect to the PingFederate service. Useful when postMessage notifications are needed

  • date-time-format

    non-empty-string

    (default: uuuu-MM-dd HH:mm:ssZZ)

    The format of date time strings used by PingFederate

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

Option: passkeys

Passkeys

passkeys

The settings for a Passkeys authentication provider

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/passkeys
Parameters:allow-registration-during-login

boolean

(default: true)

Whether or not users should be able to register a device during the login process

Account-manager
passkeys/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/passkeys/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Bankid

bankid

The settings for a BankID authentication provider

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/bankid

Parameters:
  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

  • bankid-issuer-cn

    union

    (optional)

    The Common Name (CN) of the certificate used by the BankID provider

  • type-of-card-reader

    enumeration any, with-keypad

    (optional)

    The type of smartcard reader that must be used when authenticating with a form of BankID that supports smartcards

  • mode

    enumeration test, production

    (default: production)

    The method by which to connect to the BankID – either test or production

  • use-new-api-endpoint

    boolean

    (default: true)

    Use the new BankID API endpoint (appapi2.bankid.com). The old API endpoint (appapi.bankid.com) will be discontinued in June 2019. This option is obsolete and will be removed in a subsequent release.

  • api-version

    enumeration version-5, version-6

    (default: version-5)

    The version of the BankID API to use.

  • max-allowed-attempts

    uint16

    (default: 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. This option is obsolete and will be removed in a subsequent release (the BankID API itself handles this).

  • generate-autostart-qr-code

    boolean

    (default: false)

    Generate a QR code for the autostart token, to be able to perform the ‘other device’-flow without asking the user for a personal number.

  • add-extended-bankid-attributes

    boolean

    (default: false)

    Parse the returned BankID signature to obtain issuers and the device info. This will make the contextAttributes large, storing the SSO sessions in a database is advised.

  • user-message

    non-empty-string

    (optional)

    A message to show to the user in the app. The value may be a message-key, or the actual message. The message may be overridden by the client sending a binding message in the authentication request.

  • mrtd

    boolean

    (default: false)

    Require the user to authenticate using a MRTD (machine readable travel document), like a Swedish Passport

  • allowed-bankid-types

    enumeration bankid-on-file, bankid-on-smartcard, mobile-bankid, nordea-e-id-on-file-and-on-smartcard, any

    (multi-value) (default: any)

    The allowed forms of BankID that may be used for authentication

Option: webauthn

Webauthn

webauthn

The settings for a WebAuthN authentication provider

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/webauthn

Parameters:
  • allow-registration-during-login

    boolean

    (default: true)

    Whether or not users should be able to register a device during the login process

  • ask-to-register-additional-platform-device

    boolean

    (default: true)

    If enabled, when a user authenticates with a security key and has no built-in device registered for the active browser, they will immediately be asked to register an additional built-in device.

  • platform-device-cookie-name

    non-empty-string

    (default: webauthn-platform-device)

    The name of the cookie that keeps track of whether a built-in device has been registered for a particular browser.

Account-manager
webauthn/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/webauthn/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Choice: mode
Passkeys-or-user-verifying-devices
webauthn/passkeys-or-user-verifying-devices

Users must register and authenticate using devices that perform user verification, i.e. devices that authorize their usage via gestures such as biometric recognition or PIN entry. In most cases this means the device is a passkey, but it could be an equally strong device that verifies the user.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/webauthn/passkeys-or-user-verifying-devices
Any-device
webauthn/any-device

Users can register and authenticate using any devices, regardless of user verification

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/webauthn/any-device
Parameters:allow-platform-devices

boolean

(default: true)

If enabled, users can register built-in devices, a.k.a. platform devices, in addition to security-keys, a.k.a. cross-platform devices.

Openid-wallet

openid-wallet

The settings for the OpenID Wallet authentication provider

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet

Parameters:
  • wallet-invocation-url-prefix

    string

    (default: haip)

    The prefix that will be used for building the wallet invocation URLs. Can be just a URI scheme (such as ‘haip’) or a URL (such as ‘https://wallet.example.com’).

  • signature-algorithm

    enumeration RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, EdDSA

    (mandatory)

    Signature algorithm for the signed request object.

  • authorization-request-time-to-live

    uint16

    (default: 60)

    Validity period of an authorization request in seconds. This setting controls the maximum amount of time a user can take from opening this authenticator to obtaining a request object (via a provided link or via a provided QR code).

  • request-object-time-to-live

    uint16

    (default: 300)

    Validity period of a request object in seconds. This setting controls the ‘exp’ claim of the generated request object.

Signing-key
openid-wallet/signing-key

A reference to a signing key. This key will be used to sign request objects created by this authenticator.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/signing-key
Parameters:id

leafref /base:facilities/base:crypto/base:signing-keys/base:signing-key/base:id

(mandatory)

A reference to a Signing Keystore with an asymmetric key

Client
openid-wallet/client
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/client
Parameters:client-id

non-empty-string

(mandatory)

The client_id to be used in authorization requests.

Choice: client-id-scheme
The configuration of client id scheme.
Option: did
Did
openid-wallet/client/did
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/client/did
Option: pre-registered
Pre-registered
openid-wallet/client/pre-registered
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/client/pre-registered
Option: x509-san-dns
X509-san-dns
openid-wallet/client/x509-san-dns
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/client/x509-san-dns
Option: x509-san-uri
X509-san-uri
openid-wallet/client/x509-san-uri
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/client/x509-san-uri
Presentation-definition
openid-wallet/presentation-definition

Presentation definition articulates what proofs this Verifier requires.

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/presentation-definition

Parameters:
  • name

    string

    (optional)

    Distinctive designation of presentation definition. May be displayed by wallets to users.

  • purpose

    string

    (optional)

    Describes the purpose for which the presentation definition’s inputs are being used for. May be displayed by wallets to users.

Input-descriptor
openid-wallet/presentation-definition/input-descriptor

Input descriptor is populated with properties describing what type of input data are required for submission to the Verifier.

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/presentation-definition/input-descriptor

Parameters:
  • name

    string

    (optional)

    Describes what is being requested. May be displayed by wallets to users.

  • purpose

    string

    (optional)

    Describes the purpose for which the data is being requested. May be displayed by wallets to users.

Constraints
openid-wallet/presentation-definition/input-descriptor/constraints
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/openid-wallet/presentation-definition/input-descriptor/constraints

Parameters:
  • credential-type

    string

    (optional)

    The credential type accepted by this Verifier.

  • credential-issuer

    string

    (optional)

    The credential issuer accepted by this Verifier.

Option: siths

Siths

siths

The settings for a SITHS authentication provider

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/siths

Parameters:
  • symmetric-key

    base64-encoded-string

    (mandatory)

    The shared secret used to decrypt identity data sent from the Windows Connector

  • windows-connector-url

    uri

    (mandatory)

    The URL, including the scheme, host, port, and URI, of the Windows Connector

  • mode

    enumeration test, production, test-or-production

    (default: production)

    The type of SITHS cards that should be allowed – either test, production, or both

Option: facebook

Facebook

facebook

Facebook login method

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/facebook

Parameters:
  • client-id

    string

    (mandatory)

    The client-id registered with Facebook

  • client-secret

    string

    (mandatory)

    The client-secret registered with Facebook

  • scope

    string

    (default: public_profile email)

    A space-separated list of scopes to request from Facebook

  • authorization-endpoint

    string

    (default: https://www.facebook.com/dialog/oauth)

    URL to the Facebook authorization endpoint

  • token-endpoint

    string

    (default: https://graph.facebook.com/v3.2/oauth/access_token)

    URL to the Facebook token endpoint

  • userinfo-endpoint

    string

    (default: https://graph.facebook.com/v3.2/me)

    URL to the Facebook userinfo endpoint

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (optional)

    A reference to the Http Client to use. If not defined, the default HTTP client is used

  • account-manager

    leafref /base:processing/base:account-managers/base:account-manager/base:id

    (optional)

    The Account Manager is used to fetch the account

Option: oidc

Oidc

oidc

OpenID Connect methods

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/oidc

Parameters:
  • configuration-url

    uri

    (mandatory)

    The url to the openid-configuration document at theOpenID server (must end in ‘/.well-known/openid-configuration’)

  • client-id

    string

    (mandatory)

    The client-id, registered at the OpenID server

  • use-http-basic-authentication

    boolean

    (default: false)

    Send the client credentials using HTTP Basic authentication. When false, the credentials are sent in the request-body

  • scope

    string

    (default: openid)

    Scope to ask the OpenID server for, space separated

  • clock-skew

    uint32

    (default: 60)

    The allowed clock-skew in seconds when validating the JWT from the OpenID Server

  • authentication-context-class-reference

    non-empty-string

    (optional)

    The Authentication Context Class Reference (ACR) or authentication method that should be sent in the request to the OpenID Server

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (optional)

    A reference to the Http Client to use. If not defined, the default HTTP client is used

  • use-subject-for-login-hint

    boolean

    (default: false)

    If there is a previously authenticated subject, pass the subject as login_hint to the OpenID Server.

  • prompt-login

    enumeration always, if-requested-by-client

    (optional)

    Setting controlling sending of prompt=login parameter. By default, it is not sent.

Choice: client-authentication-method
param client-secret:
 

non-empty-string

(optional)

The client-secret (client-secret-post), registered at the OpenID server

Asymmetrically-signed-jwt
oidc/asymmetrically-signed-jwt

Settings for the asymmetrically signed JWT (private_key_jwt)

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/oidc/asymmetrically-signed-jwt

Parameters:
  • signing-key

    leafref /base:facilities/base:crypto/base:signing-keys/base:signing-key/base:id

    (mandatory)

    Signing key for the asymmetrically signed JWT (private_key_jwt)

  • signature-algorithm

    enumeration RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512

    (mandatory)

    Signature algorithm for the asymmetrically signed JWT (private_key_jwt)

Symmetrically-signed-jwt
oidc/symmetrically-signed-jwt

Allowed symmetrically signing algorithms for JWT (client_secret_jwt)

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/oidc/symmetrically-signed-jwt

Parameters:
  • signing-key

    leafref /base:facilities/base:crypto/base:signing-keys/base:signing-key/base:id

    (mandatory)

    Signing key for the symmetrically signed JWT (client_secret_jwt)

  • signature-algorithm

    enumeration HS256, HS384, HS512

    (mandatory)

    The signature algorithms to allow for JWT (client_secret_jwt)

Encrypted-id-token
oidc/encrypted-id-token

ID Token is expected to be encrypted

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/oidc/encrypted-id-token

Parameters:
  • decryption-key

    leafref /base:facilities/base:crypto/base:decryption-keys/base:decryption-key/base:id

    (mandatory)

    A reference to a Decryption Keystore with a key

  • allowed-algorithms

    allowed-key-management-algorithms RSA1_5, RSA-OAEP, RSA-OAEP-256, ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW, A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW

    (multi-value) (optional)

    Key Management Algorithm - the algorithm used to obtain the Content Encryption Key, and present in the ‘alg’ JWE header. If empty, any supported algorithm is allowed.

  • allowed-content-encryption-algorithms

    allowed-content-encryption-algorithms A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM

    (multi-value) (optional)

    Content Encryption Algorithm - the algorithm used to obtain the content, and present in the ‘enc’ JWE header If empty, any supported algorithm is allowed

Fetch-userinfo
oidc/fetch-userinfo

Fetch claims from the userinfo endpoint

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/oidc/fetch-userinfo
Choice: signed-or-encrypted-userinfo
param plain:

empty

(optional)

Expect user info response to be plain JSON

param signed:

empty

(optional)

Expect user info response to be a signed JWT

Encrypted
oidc/fetch-userinfo/encrypted

Settings for decrypting an encrypted userinfo response

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/oidc/fetch-userinfo/encrypted
Parameters:decryption-key

leafref /base:facilities/base:crypto/base:decryption-keys/base:decryption-key/base:id

(mandatory)

A reference to a Decryption Keystore with a key

Choice: signed-or-unsigned-payload
param unsigned-payload:
 

empty

(optional)

Expect the encrypted userinfo payload to be plain JSON

param signed-payload:
 

empty

(optional)

Expect the encrypted userinfo payload to be a signed JWT

param allowed-algorithms:
 

allowed-key-management-algorithms RSA1_5, RSA-OAEP, RSA-OAEP-256, ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW, A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW

(multi-value) (optional)

Key Management Algorithm - the algorithm used to obtain the Content Encryption Key, and present in the ‘alg’ JWE header. If empty, any supported algorithm is allowed.

param allowed-content-encryption-algorithms:
 

allowed-content-encryption-algorithms A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM

(multi-value) (optional)

Content Encryption Algorithm - the algorithm used to obtain the content, and present in the ‘enc’ JWE header If empty, any supported algorithm is allowed

Option: sign-in-with-apple

Sign-in-with-apple

sign-in-with-apple

Sign in with Apple methods

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/sign-in-with-apple

Parameters:
  • issuer

    uri

    (default: https://appleid.apple.com)

    The issuer of the Sign in with Apple service. Will be used to get the configuration document

  • team-id

    non-empty-string

    (mandatory)

    The Team ID of your Apple Developer team.

  • client-id

    non-empty-string

    (mandatory)

    The Service identifier registered with your Apple Developer team

  • jwt-signing-key

    leafref /base:facilities/base:crypto/base:signing-keys/base:signing-key/base:id

    (mandatory)

    The key to sign the client secret with. This key is issued from your Apple Developer account.

  • jwt-signing-key-id

    string

    (mandatory)

    The Key ID of the signing key downloaded from the apple developer portal. A 10 character string listed in ‘Certificates, Identifiers & Profiles > Keys’

  • scope

    non-empty-string

    (default: openid email name)

    Scope to ask for, space separated

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (optional)

    A reference to the Http Client to use. If not defined, the default HTTP client is used

Option: saml2

Saml2

saml2
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/saml2

Parameters:
  • issuer-entity-id

    string

    (mandatory)

    The SAML Entity Id that the authenticator uses when communicating with the remote SAML IDP.

  • clock-skew

    uint32

    (default: 60)

    The allowed clock-skew in seconds when validating the inbound response message

  • include-subject-with-requested-authn-context

    boolean

    (default: false)

    If there is a previously authenticated subject, pass the subject in the AuthnRequest to the SAML Identity Provider.

  • force-authn

    enumeration always, if-requested-by-client

    (optional)

    Setting controlling sending of ForceAuthn=true parameter. By default, it is not sent.

  • idp-entity-id

    string

    (mandatory)

    The SAML Entity Id of the remote SAML IDP

  • idp-url

    string

    (mandatory)

    The target IDP URL where SAML Authentication Requests are delivered to.

  • signature-verification-key

    leafref /base:facilities/base:crypto/base:signature-verification-keys/base:signature-verification-key/base:id

    (optional)

    The key to verify the signature of received SAML Response messages. When no key is configured and signed SAML messages are received, then the messages will be rejected.

  • wants-response-signed

    boolean

    (default: false)

    Indicate whether the received SAML Response message must be signed.

  • wants-assertion-signed

    boolean

    (default: true)

    Indicate whether the received Assertion must be signed.

  • request-signing-key

    leafref /base:facilities/base:crypto/base:signing-keys/base:signing-key/base:id

    (optional)

    Optional reference to the signing key that is used to sign outbound SAML AuthnRequest messages. If not configured, signing AuthnRequests is disabled.

Authentication-context-class-reference
saml2/authentication-context-class-reference

The Authentication Context Class Reference (ACR) values to be included in the SAML Authentication Request.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/saml2/authentication-context-class-reference
Choice: authentication-context-class-reference
param none:

empty

(optional)

Do not use ACR values

param pass-through:
 

empty

(optional)

Use the ACR values from the request to the Authentication Service.

param explicit:

non-empty-string

(optional)

Use a specific ACR value.

Request-options
saml2/request-options

Optional settings to finetune how a SAML Authentication Request message is constructed.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/saml2/request-options
Parameters:nameid-format

string

(optional)

The optional NameIdFormat that is requested in a SAML Authentication Request. When not configured, no NameIdFormat is requested.

Duo

duo

The settings for a Duo authentication provider

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/duo

Parameters:
  • allow-registration-during-login

    boolean

    (default: true)

    Allow registration during login

  • show-info-before-registration

    boolean

    (default: true)

    Show information page with instructions about installing the Duo app before registration.

  • auto-login-enabled

    boolean

    (default: false)

    When active a login will be automatically performed after a successful registration.

  • api-hostname

    string

    (mandatory)

    The API hostname of the Duo account.

  • auth-api-integration-key

    string

    (mandatory)

    The auth API integration key of the Duo account.

  • auth-api-secret-key

    string

    (mandatory)

    The auth API secret key of the Duo account.

  • admin-api-integration-key

    string

    (mandatory)

    The admin API integration key of the Duo account.

  • admin-api-secret-key

    string

    (mandatory)

    The admin API secret key of the Duo account.

  • valid-seconds

    uint32

    (default: 1500)

    The seconds for which the created activation code is going to be valid.

Account-manager
duo/account-manager
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/duo/account-manager

Parameters:
  • id

    leafref /base:processing/base:account-managers/base:account-manager/base:id

    (mandatory)

    A reference to an Account Manager

  • factors

    enumeration auto, push, passcode, sms, phone

    (multi-value) (optional)

    The allowed factors of Duo that may be used for authentication

Option: totp

Totp

totp
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/totp

Parameters:
  • algorithm

    enumeration sha1, sha256, sha512

    (default: sha1)

    The algorithm used to produce the TOTP. This parameter is ignored by some implementations and defaults to SHA1.

  • allow-registration-during-login

    boolean

    (default: true)

  • auto-login-enabled

    boolean

    (default: false)

    When active a login will be automatically performed after a successful registration.

  • clock-skew

    int32

    (default: 0)

    Clock skew in seconds

  • delay-window

    int32

    (default: 1)

    The Delay window of the algorithm. Greater number means that a TOTP can be used for a period of time so many times longer than the interval (delay window * interval).

  • device-expiration

    int32

    (optional)

    Set a device expiration in seconds from the time the device is activated, if not set devices never expires. If this is set, it is not possible to override in the template. Only one device can be active per account, registering a new device expires any previous ones.

  • device-type

    string

    (default: idsvr-totp)

    The device type (or vendor) that will be stored in the device store. This is used in registration as well as on the lookup of the devices the user has associated. If you only use one device type, it is suggested to leave this setting as is. Otherwise refer to the documentation on how this is used exactly.

  • digits

    int32

    (default: 6)

    Determines how long of a one-time passcode to display to the user. This parameter is ignored by some implementations and defaults to 6.

  • interval

    int32

    (default: 30)

    The interval of the TOTP device. This parameter is ignored by some implementations and defaults to 30 seconds.

Account-manager
totp/account-manager
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/totp/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Bucket
totp/bucket
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/totp/bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Choice: key-distribution-settings
Option: generated-key-config
Generated-key-config
totp/generated-key-config
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/totp/generated-key-config

Parameters:
  • allow-user-to-set-device-alias

    boolean

    (default: false)

    Allow the users to set a device alias. This can be useful if a user has more than one device of this type. If it is set to false, the alias will be the username of the user.

  • issuer

    string

    (default: Identity server)

    The issuer is embedded in the QR code and will show up in TOTP apps (i.e. Google Authenticator)

Bucket
totp/generated-key-config/bucket
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/totp/generated-key-config/bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Option: pre-shared-key-config
Pre-shared-key-config
totp/pre-shared-key-config
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/totp/pre-shared-key-config
Key-repository
totp/pre-shared-key-config/key-repository
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/totp/pre-shared-key-config/key-repository
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Option: ping-idp-adapter

Ping-idp-adapter

ping-idp-adapter
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/ping-idp-adapter

Parameters:
  • idp-application-url

    uri

    (mandatory)

    The URL to the IdP Adapter

  • password

    string

    (mandatory)

    The password to use for basic authentication against the dropoff endpoint

  • username

    string

    (mandatory)

    The username to use for basic authentication against the dropoff endpoint

Option: dynamic

Dynamic

dynamic
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/dynamic
Parameters:delegate-implementation-type

union

(mandatory)

Implementation type of target delegate authenticator plugin.

Choice: configuration-source
Option: configuration-bucket
Configuration-bucket
dynamic/configuration-bucket
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/dynamic/configuration-bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Option: configuration-web-service
Configuration-web-service
dynamic/configuration-web-service
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/dynamic/configuration-web-service

Parameters:
  • hostname

    host

    (mandatory)

    sets the hostname or ip-address of the webservice service, e.g. ‘localhost’ or ‘127.0.0.1’

  • port

    port-number

    (default: 80)

    sets the port of the webservice service, e.g. 80 or 443.

  • context

    string

    (default: /)

    sets the main context of the webservice service, e.g. ‘/scim’.

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

Backchannel-authenticator

backchannel-authenticator (keys: ['id'])
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/backchannel-authenticator{id}

Parameters:
  • id

    non-empty-string

    (mandatory)

  • description

    string

    (optional)

    A readable description of the Authenticator, for User presentation, can be a locale key

  • authentication-context-class-reference

    non-empty-string

    (optional)

    The Authentication Context Class Reference (ACR) that for this authenticator. If not set, the value of the referenced front-channel authenticator is used, or one is derived from the authenticator’s type and id.

Authentication-actions

authentication-actions
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/backchannel-authenticator{id}/authentication-actions
Parameters:authentication-action

leafref ../../../../authentication-actions/authentication-action/id

(multi-value) (optional)

An ordered list of actions that will run after authentication is complete. They can work on the attributes (including subject) that the authenticator has returned, and shape these to match the desired pattern/format, and can reject the authentication if necessary

Choice: backchannel-authenticator-type

Option: bankid-backchannel

Bankid-backchannel

bankid-backchannel
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/backchannel-authenticator{id}/bankid-backchannel
Parameters:frontchannel-authenticator

leafref ../../../auth:authenticator/auth:id

(mandatory)

The ID of the frontchannel authenticator linked to this backchannel authenticator

Option: email-backchannel

Email-backchannel

email-backchannel
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/backchannel-authenticator{id}/email-backchannel
Parameters:frontchannel-authenticator

leafref ../../../auth:authenticator/auth:id

(mandatory)

The ID of the frontchannel authenticator linked to this backchannel authenticator

Option: sms-backchannel

Sms-backchannel

sms-backchannel
Path :/profiles/profile{id, type}/settings/authentication-service/authenticators/backchannel-authenticator{id}/sms-backchannel
Parameters:frontchannel-authenticator

leafref ../../../auth:authenticator/auth:id

(mandatory)

The ID of the frontchannel authenticator linked to this backchannel authenticator

Option: bankid-phone

Bankid-phone

bankid-phone
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/backchannel-authenticator{id}/bankid-phone

Parameters:
  • add-extended-bankid-attributes

    boolean

    (default: false)

  • call-initiator

    enumeration user, rp

    (default: user)

    A value that describes who initiated the call. This is used by the BankID app to show information for how the user should proceed.

  • mode

    enumeration test, production

    (default: test)

  • type-of-card-reader

    enumeration with-keypad, any

    (optional)

  • user-message

    string

    (optional)

    A message to show to the user in the app. The value may be a message-key, or the actual message. The message may be overridden by the client sending a binding message in the authentication request.

Http-client
bankid-phone/http-client
Path :

/profiles/profile{id, type}/settings/authentication-service/authenticators/backchannel-authenticator{id}/bankid-phone/http-client

Parameters:
  • id

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

  • allowed-bankid-types

    enumeration bankid-on-file, bankid-on-smartcard, mobile-bankid, nordea-e-id-on-file-and-on-smartcard, any

    (multi-value) (optional)

Service-provider

service-provider (keys: ['id'])

Service providers are usually applications or relying parties. They depend on the identity server for authentication

Path :

/profiles/profile{id, type}/settings/authentication-service/service-providers/service-provider{id}

Parameters:
  • id

    string

    (mandatory)

  • template-area

    non-empty-string

    (optional)

    Optional override for template area, this is used when listing multiple authenticators if many are possible to use it’s sometimes needed to brand the selection page per application.

  • default-authenticator

    leafref ../../../authenticators/authenticator/id

    (optional)

    When a list needs to be shown, this is marked as default

  • context-info

    string

    (optional)

  • application-url

    uri

    (optional)

    This URL is used if a request is made to the authentication service without the parameters necessary to initiate an authentication transaction. In such a case, the user is redirected to this URL, so that a new, properly formed, request can be made to bootstrap a new authentication transaction.

  • target-url

    uri

    (mandatory)

    This URL is used to redirect the user to the application after a successful login has taken place

  • allowed-authenticators

    leafref ../../../authenticators/authenticator/id

    (multi-value) (optional)

    This is a list that marks which authenticators should be used for the particular service

  • authenticator-filters

    leafref ../../../authenticator-filters/authenticator-filter/id

    (multi-value) (optional)

  • required-claim

    string

    (multi-value) (optional)

  • allowed-origins

    non-empty-string

    (multi-value) (optional)

    The optional list of URIs or URI-patterns that is allowed to embed the rendered pages inside an iframe or be a trusted source.

Protocol

protocol (keys: ['id'])

Configuration details of the protocols that can be used to connect the authentication service to other services.

Path :/profiles/profile{id, type}/settings/authentication-service/protocols/protocol{id}
Parameters:id

string

(mandatory)

Choice: protocol-type

Simple-api

simple-api

A Protocol plugin using the Simple API Protocol. Required if this authentication profile is used by a token service profile

Path :/profiles/profile{id, type}/settings/authentication-service/protocols/protocol{id}/simple-api

Ping-federate

ping-federate

A Protocol plugin using Pingfederate’s agentless adapter integration method

Path :

/profiles/profile{id, type}/settings/authentication-service/protocols/protocol{id}/ping-federate

Parameters:
  • dropoff-url

    uri

    (mandatory)

  • dropoff-username

    string

    (mandatory)

  • dropoff-password

    string

    (mandatory)

  • idp-adapter-id

    string

    (mandatory)

  • server-base-url

    uri

    (mandatory)

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

  • application-url

    uri

    (optional)

    This URL is used if a request is made to the authentication service without the parameters necessary to initiate an authentication transaction. In such a case, the user is redirected to this URL, so that a new, properly formed, request can be made to bootstrap a new authentication transaction. When integrating to PingFederate, this could happen, for example, if the user arrives at the authentication service via PingFederate, book marks the page, and later follows their new bookmark. In this case, the user would not see an error page, but instead be redirected to this URL.

  • allowed-origins

    non-empty-string

    (multi-value) (optional)

    When PingFederate is requesting authentication directly, this optional list of URI’s or URI-patterns define which origins are allowed to frame pages in, i.e. this list decides how and which allowed frame response headers are sent. If none are configured, framing is not allowed for this protocol. Note that when PingFederate includes a client_id, the ServiceProvider’s framing settings are used!

Saml

saml

A SAML Protocol plugin for integration with services like ADFS and other SAML providers

Path :

/profiles/profile{id, type}/settings/authentication-service/protocols/protocol{id}/saml

Parameters:
  • signing-key

    leafref /base:facilities/base:crypto/base:signing-keys/base:signing-key/base:id

    (mandatory)

    Reference to the key that is used to sign the login token

  • recipient-entity-id

    string

    (mandatory)

    The recipient or audience of the SAML response messages and assertions

  • acs-url

    uri

    (mandatory)

    The Assertion Consumer Service (ACS) URL where SAML Response messages are posted to

  • saml-federation-service-type

    enumeration generic, adfs

    (default: generic)

    The type of Federation Service that will receive the login token

  • saml-clock-skew

    uint32

    (default: 60)

    The number of seconds allowed for clock skew (subtracted from or added to the issuance timestamp, considering saml-message-time-to-live) that is used to compute the time before or after which a token must not be used

  • saml-assertion-time-to-live

    uint32

    (default: 300)

    The number of seconds that SAML assertions are valid.

  • include-session-index-in-response

    boolean

    (default: false)

    Include SessionIndex in AuthnStatement of the SAML response.

  • logout-service-url

    uri

    (optional)

    The URL to send logout responses to. If empty, the ACS URL will be used.

  • sign-assertions

    boolean

    (default: false)

    Sign the assertion in addition to the response.

  • saml-message-time-to-live

    uint32

    (default: 300)

    The number of seconds after issuance that a SAML message is considered to be valid.

Authenticator-filter

authenticator-filter (keys: ['id'])

Authenticator filter configuration. Authenticator filters are used to filter out authenticators depending on runtime information such as the request’s user-agent, for example.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticator-filters/authenticator-filter{id}
Parameters:id

string

(mandatory)

Choice: filter-type

Option: user-agent

User-agent

user-agent

User-Agent Authenticator Filter

Path :/profiles/profile{id, type}/settings/authentication-service/authenticator-filters/authenticator-filter{id}/user-agent
Parameters:user-agent-regex

non-empty-string

(mandatory)

This filter is applied only if the request’s User-Agent matches this regex.

Exclusions
user-agent/exclusions

List of authenticators to exclude.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticator-filters/authenticator-filter{id}/user-agent/exclusions
Parameters:authenticator

leafref ../../../../../auth:authenticators/auth:authenticator/auth:id

(multi-value) (optional)

Option: cidr

Cidr

cidr

CIDR Authenticator Filter

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticator-filters/authenticator-filter{id}/cidr

Parameters:
  • filter-cidr

    non-empty-string

    (mandatory)

    The CIDR specifying the IP addresses and routing prefixes for which this filter should be applied.

  • apply-filter-when-match

    boolean

    (default: true)

    Apply the exclusions when the cidr matches the IP. If this is set to false, then the exclusions are applied when the cidr fails to match. A common use-case for setting this to false would be to remove certain authenticators when the client is not on the internal network

Exclusions
cidr/exclusions

List of authenticators to exclude.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticator-filters/authenticator-filter{id}/cidr/exclusions
Parameters:authenticator

leafref ../../../../../auth:authenticators/auth:authenticator/auth:id

(multi-value) (optional)

Option: script-filter

Script-filter

script-filter

Script Authenticator Filter

Path :/profiles/profile{id, type}/settings/authentication-service/authenticator-filters/authenticator-filter{id}/script-filter
Parameters:authenticator-filter-procedure

leafref /base:processing/base:procedures/base:filter-procedure/base:id

(mandatory)

A reference to an existing authenticator-filter-procedure.

Option: geo-country

Geo-country

geo-country

Geolocation Country Authenticator Filter

Path :

/profiles/profile{id, type}/settings/authentication-service/authenticator-filters/authenticator-filter{id}/geo-country

Parameters:
  • apply-filter-when-match

    boolean

    (default: true)

    Apply the exclusions when the country request comes matches any in the list. If this is set to false, then the exclusions are applied when the country fails to match. A common use-case for setting this to false would be to remove certain authenticators when the request comes from a country that is not in the list.

  • filter-countries

    non-empty-string

    (multi-value) (optional)

    The list of countries (ISO-3166 code) that are allowed or denied to use the authenticators.

Exclusions
geo-country/exclusions

List of authenticators to exclude.

Path :/profiles/profile{id, type}/settings/authentication-service/authenticator-filters/authenticator-filter{id}/geo-country/exclusions
Parameters:authenticator

leafref ../../../../../auth:authenticators/auth:authenticator/auth:id

(multi-value) (optional)

Authorization-server

authorization-server

The Authorization Server is a full OAuth 2.0 server with OpenID Connect support. It can issue tokens using the token issuer subsystem together with Token Procedures

Path :

/profiles/profile{id, type}/settings/authorization-server

Parameters:
  • reuse-refresh-tokens

    boolean

    (default: false)

    Defines if refresh tokens are created on every refresh or if they are kept

  • revoke-delegation-for-public-clients-reusing-refresh-token

    boolean

    (default: true)

    Revoke delegation when public client attempts to reuse refresh token

  • issuer-override

    string

    (optional)

    Override the issuer for tokens issued by this authorization server. Setting this value instead of using the derived value for issuer, can break the standard discovery specification and should therefore only be used in exceptional circumstances, i.e. backwards compatibility or to integrate with existing environments where the derived issuer can not be used.

  • authorization-manager

    leafref /base:processing/base:authorization-managers/base:authorization-manager/base:id

    (optional)

  • account-manager

    leafref /base:processing/base:account-managers/base:account-manager/base:id

    (optional)

    The (default) account manager to use for user attribute lookups

  • privacy-policy-url

    uri

    (optional)

    An absolute URL that refers to the privacy policy of the Authorization Server

  • terms-of-service-url

    uri

    (optional)

    An absolute URL that refers to the terms of service that users must accept when using any client configured in the profile

  • developer-documentation-url

    uri

    (optional)

    The published URL of the documentation that describes to developers how to use the service

  • require-secured-authorization-response

    empty

    (optional)

    If set, then all authorization responses need to be protected according to the ‘JWT Secured Authorization Response Mode for OAuth 2.0’ (JARM) specification

Database-client

database-client

Enables the Database Clients feature.

Path :/profiles/profile{id, type}/settings/authorization-server/database-client
Parameters:client-data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

Reference to data source that can store OAuth clients.

Client-authentication

client-authentication

The methods by which an OAuth client may be authenticated

Path :

/profiles/profile{id, type}/settings/authorization-server/client-authentication

Parameters:
  • basic-and-form-post

    boolean

    (default: true)

    Basic authentication and form post. This is enabled by default.

  • no-authentication

    boolean

    (default: false)

    Allow a client to not authenticate to the token endpoint. Selecting this authentication method for a client makes it a public client, as defined by OAuth.

Asymmetrically-signed-jwt

client-authentication/asymmetrically-signed-jwt

Allowed asymmetric signing algorithms for JWT’s

Path :/profiles/profile{id, type}/settings/authorization-server/client-authentication/asymmetrically-signed-jwt
Parameters:signature-algorithm

enumeration RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, EdDSA

(multi-value) (optional)

The signature algorithms to allow

Symmetrically-signed-jwt

client-authentication/symmetrically-signed-jwt

Allowed symmetric signing algorithms for JWT’s

Path :/profiles/profile{id, type}/settings/authorization-server/client-authentication/symmetrically-signed-jwt
Parameters:signature-algorithm

enumeration HS256, HS384, HS512

(multi-value) (optional)

The signature algorithms to allow

Using-jwt

client-authentication/using-jwt

Settings for introspection of client signed JWT’s. Should not normally need to be changed from the defaults

Path :

/profiles/profile{id, type}/settings/authorization-server/client-authentication/using-jwt

Parameters:
  • enforce-unique-jti-values

    empty

    (optional)

    Whether the ‘jti’ (JWT ID) claim should be checked for uniqueness in provided client assertion JWT’s

  • clock-skew

    uint32

    (default: 10)

    The number of seconds that token lifetimes and issue times should be skewed to accommodate for clocks that may be out of sync

Mutual-tls

client-authentication/mutual-tls

Configure settings to allow client authentication through using mutual-tls

Path :/profiles/profile{id, type}/settings/authorization-server/client-authentication/mutual-tls
By-proxy
client-authentication/mutual-tls/by-proxy

Allow mutual TLS to be terminated in a proxy instead of directly within the identity server

Path :

/profiles/profile{id, type}/settings/authorization-server/client-authentication/mutual-tls/by-proxy

Parameters:
  • userid

    string

    (optional)

    User ID credential that the proxy uses to authenticate using HTTP Basic authentication through a Proxy-Authorization header.

  • password

    non-empty-string

    (optional)

    Password credential that the proxy uses to authenticate using HTTP Basic authentication through a Proxy-Authorization header.

  • client-certificate-http-header

    non-empty-string

    (mandatory)

    Name of the HTTP header that the proxy uses to include the PEM- or base64-encoded DER representation of the client certificate in the forwarded request. Must be set for mutual-tls by-proxy to work.

Request-object

request-object

The settings for allowing a request to be provided through a by-value or by-reference request object. By-value request objects are passed using the ‘request’ parameter whereas by-reference ones are provided in the ‘request-uri’ parameter. When enabled, a client can be required to provide a request object JWT. Additional restrictions per the relevant specifications are applied when used at the CIBA and PAR endpoints.

Path :

/profiles/profile{id, type}/settings/authorization-server/request-object

Parameters:
  • maximum-lifetime

    int16

    (optional)

    The maximum number of minutes (from the ‘nbf’ claims to the ‘exp’ claim) that a request object should be valid for

  • require-parameters-as-claims

    boolean

    (optional)

    DEPRECATED: If enabled, all authorization request parameters must be inside the request object, as claims, with the exception of request and request_uri. If a parameter is also present in the query string or form then it needs to have the same value as the claim inside the request object.

  • request-object-parameter-handling

    enumeration merge-outside-parameters-preferring-inside, ignore-outside-parameters, error-if-outside-parameters, must-be-inside-and-match-if-outside

    (optional)

    How claims in request objects and (form or query string) parameters are combined

Encrypted-jwt

request-object/encrypted-jwt

The request object JWT must be encrypted and signed

Path :

/profiles/profile{id, type}/settings/authorization-server/request-object/encrypted-jwt

Parameters:
  • front-channel-only

    boolean

    (default: false)

    Whether or not encrypted request objects should only be required for front-channel requests to the authorization endpoint

  • decryption-key

    leafref /base:facilities/base:crypto/base:decryption-keys/base:decryption-key/base:id

    (mandatory)

    A reference to a Decryption Keystore with a key

  • include-x5t-in-jwks

    boolean

    (default: true)

    Indicate whether to include the certificate thumbprint (‘x5t’) in the JWKS endpoint

  • include-x5c-in-jwks

    boolean

    (default: false)

    Indicate whether to include the certificate (‘x5c’) in the JWKS endpoint

  • allowed-algorithms

    allowed-key-management-algorithms RSA1_5, RSA-OAEP, RSA-OAEP-256, ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW, A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW

    (multi-value) (optional)

    Key Management Algorithm - the algorithm used to obtain the Content Encryption Key, and present in the ‘alg’ JWE header. If empty, any supported algorithm is allowed.

  • allowed-content-encryption-algorithms

    allowed-content-encryption-algorithms A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM

    (multi-value) (optional)

    Content Encryption Algorithm - the algorithm used to obtain the content, and present in the ‘enc’ JWE header If empty, any supported algorithm is allowed

Asymmetrically-signed-jwt

request-object/asymmetrically-signed-jwt

Allowed asymmetric signing algorithms for request object JWTs

Path :

/profiles/profile{id, type}/settings/authorization-server/request-object/asymmetrically-signed-jwt

Parameters:
  • signature-algorithm

    enumeration RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, EdDSA, none

    (multi-value) (optional)

    The signature algorithms to allow

  • required-claim

    non-empty-string

    (multi-value) (optional)

    The list of claims that must be inside the request object.

Authentication-service

authentication-service
Path :

/profiles/profile{id, type}/settings/authorization-server/authentication-service

Parameters:
  • authentication-profile

    leafref /base:profiles/base:profile/base:id

    (optional)

  • clock-skew

    uint32

    (default: 3)

    The number of seconds that token lifetimes and issue times should be skewed to accommodate for clocks that may be out of sync

Client-capabilities

client-capabilities

This section defines what a client may do when communicating with the OAuth server

Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities

Code

client-capabilities/code
Path :

/profiles/profile{id, type}/settings/authorization-server/client-capabilities/code

Parameters:
  • authorization-code-ttl

    token-time-to-live

    (default: 30)

    The number of seconds an authorization code will be valid

  • allow-per-request-redirect-uris

    empty

    (optional)

    When enabled, all clients can enable per-request redirect-uri’s when using pushed authorization requests. This option can not be used together with redirect-uri-validation-policies. In order to use redirect-uri-validation-policies, this option to allow-per-request-redirect-uris must be disabled. This setting is deprecated in favour of redirect-uri-validation-policies.

  • disallowed-proof-key-challenge-methods

    enumeration plain, S256

    (multi-value) (optional)

    A list of proof key challenge methods the clients aren’t allowed to use. Useful when one of the methods provided by the server is deemed insecure. This setting affects all the clients. Clients can have additional methods disallowed in their settings.

Require-pushed-authorization-requests
client-capabilities/code/require-pushed-authorization-requests

Require all clients in this profile to use pushed authorization requests to initiate the code flow.

Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/code/require-pushed-authorization-requests

Implicit

client-capabilities/implicit
Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/implicit

Resource-owner-password-credentials

client-capabilities/resource-owner-password-credentials
Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/resource-owner-password-credentials
Parameters:credential-manager

leafref /base:processing/base:credential-managers/base:credential-manager/base:id

(optional)

The credential manager to use when authenticating the user using Resource Owner Password Credentials

Client-credentials

client-capabilities/client-credentials
Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/client-credentials

Introspection

client-capabilities/introspection
Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/introspection

Token-exchange

client-capabilities/token-exchange
Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/token-exchange

Assisted-token

client-capabilities/assisted-token
Path :

/profiles/profile{id, type}/settings/authorization-server/client-capabilities/assisted-token

Parameters:
  • store-token-in-cookie

    boolean

    (default: true)

    When set, the issued token is stored in a secure cookie in the user-agent; and is thereafter re-issued on subsequent requests

  • token-cookie-name

    non-empty-string

    (optional)

    When set, the token storage cookie name is prefixed with the defined value. The cookie name will always be collision free over profiles and clients.This value will get URL-encoded, to enforce a valid cookie name.

Backchannel-authentication

client-capabilities/backchannel-authentication
Path :

/profiles/profile{id, type}/settings/authorization-server/client-capabilities/backchannel-authentication

Parameters:
  • request-ttl

    uint32

    (default: 900)

    The number of seconds the backchannel authentication requests will be valid

  • must-sign-request-object

    empty

    (optional)

    Enables mandatory signed request object in backchannel authentication request

  • binding-message-max-length

    uint32

    (default: 10000)

    The maximum length allowed for binding_message.

Device-authorization

client-capabilities/device-authorization
Path :

/profiles/profile{id, type}/settings/authorization-server/client-capabilities/device-authorization

Parameters:
  • polling-interval

    uint32

    (default: 30)

    The number of seconds interval between polling attempts for clients

  • user-device-code-ttl

    uint32

    (default: 300)

    The number of seconds an issued user and device code will be valid

  • generate-qr-code

    boolean

    (default: false)

    When enabled, a QR-code is generated and returned with a user and device code

  • alias

    uri

    (optional)

    When set, the alias will be used as verification-url where the user should go to verify its user code. If not set, the verification-url is derived from the profile’s base-url settings.

Assertion

client-capabilities/assertion

Allow client to use the assertion grant on the token endpoint.

Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/assertion
Parameters:clock-skew

uint32

(default: 10)

The number of seconds that token lifetimes and issue times should be skewed to accommodate for clocks that may be out of sync

Asymmetrically-signed-jwt
client-capabilities/assertion/asymmetrically-signed-jwt

Allowed asymmetric signing algorithms for JWT assertions

Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/assertion/asymmetrically-signed-jwt
Parameters:signature-algorithm

enumeration RS256, RS384, RS512, PS256, PS384, PS512

(multi-value) (optional)

The signature algorithms to allow

Symmetrically-signed-jwt
client-capabilities/assertion/symmetrically-signed-jwt

Allowed symmetric signing algorithms for JWT assertions

Path :/profiles/profile{id, type}/settings/authorization-server/client-capabilities/assertion/symmetrically-signed-jwt
Parameters:signature-algorithm

enumeration HS256, HS384, HS512

(multi-value) (optional)

The signature algorithms to allow

Scopes

scopes
Path :

/profiles/profile{id, type}/settings/authorization-server/scopes

Parameters:
  • min-access-token-lifetime

    uint32

    (default: 60)

    The shortest time an access token will be valid for

  • default-scope-description

    string

    (optional)

    The default scope (the empty scope) is described with this description

Scope

scopes/scope{id} (keys ['id'])
Path :

/profiles/profile{id, type}/settings/authorization-server/scopes/scope{id}

Parameters:
  • id

    scope

    (mandatory)

  • is-prefix

    boolean

    (default: false)

    Whether this is a prefix scope. Prefix scopes allow clients to use dynamic scopes that start with a prefix, but may have any value after that.

  • description

    string

    (optional)

  • time-to-live

    uint32

    (optional)

    The number of seconds a scope will be valid

  • required

    boolean

    (default: false)

    Whether the scope is required in the request (but not necessarily granted) when configured for any client in the profile or during registration of a non-templatized dynamic clients when all scopes or this scope in particular is allowed to be registered by dynamic clients.

  • expose-in-metadata

    boolean

    (default: true)

    Expose this scope as part of the published metadata.

  • claims

    leafref ../../../claims/claim/name

    (multi-value) (optional)

    The claims that are issued when the client is granted this scope of access

Properties
scopes/scope{id}/properties
Path :/profiles/profile{id, type}/settings/authorization-server/scopes/scope{id}/properties
Property
scopes/scope{id}/properties/property{key} (keys ['key'])
Path :

/profiles/profile{id, type}/settings/authorization-server/scopes/scope{id}/properties/property{key}

Parameters:
  • key

    string

    (mandatory)

  • value

    string

    (optional)

  • default-scope-claim

    leafref ../../claims/claim/name

    (multi-value) (optional)

    The claims that are issued for the default scope (empty scope)

Claims

claims
Path :

/profiles/profile{id, type}/settings/authorization-server/claims

Parameters:
  • expose-system-claims-in-metadata

    boolean

    (default: true)

    When this is set to true, all the system claims will be exposed in the metadata.

  • claims-value-provider-timeout

    uint8

    (default: 5)

    Maximum total time allowed for all claims providers to return claims. Depending on the claims provider used and their implementation, it may not be possible to cancel their operation in order to fulfill this timeout.

Claim

claims/claim{name} (keys ['name'])

The list of claims available in the profile

Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claim{name}

Parameters:
  • name

    non-empty-string

    (mandatory)

    The name of the claim

  • description

    string

    (optional)

    A user-friendly description. Can be presented to the user during consent

  • required

    boolean

    (default: false)

    Whether the claim is required in the request (but not necessarily granted) when configured for any client in the profile or during registration of a non-templatized dynamic client.

  • expose-in-metadata

    boolean

    (default: true)

    If this claim should be exposed in the metadata

Choice: value-source
param no-source:
 

empty

(optional)

The no-source provides no attributes. If selected, a transformation procedure (generator) must be used to establish the claim’s value.

param value-provided-by:
 

leafref ../../claims-value-provider/id

(optional)

The claims-value-provider that provides the attribute or attributes that estabilish the value for the claim.

param reference-claim:
 

leafref ../../claim/name

(optional)

Name of another claim that is the source for the value of this claim.

Composite-claim
claims/claim{name}/composite-claim

Defines one or more other claims that are issued in a container, or can be transformed into a new scalar, list or object value.

Path :/profiles/profile{id, type}/settings/authorization-server/claims/claim{name}/composite-claim
Parameters:reference-claim

leafref ../../../claim/name

(multi-value) (optional)

Name of another claim that is to be included in the composite claim.

Transformation
claims/claim{name}/transformation

A transformation from the raw data to the claim name and value

Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claim{name}/transformation

Parameters:
  • value-transformation-procedure

    script

    (optional)

    A value mapping procedure for this claim.

  • input-attribute-names

    string

    (multi-value) (optional)

    The input attributes to map. In case the claim’s value is provided by a referenced claim, input-attribute-names are implicitly set to be the one name of that referenced claim.

Claims-value-provider

claims/claims-value-provider{id} (keys ['id'])

The claim value sources. These lookup attributes based on the given claims

Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}
Parameters:id

non-empty-string

(mandatory)

The name of the claim value provider

Choice: provider-type
Option: data-source-claims-provider
Data-source-claims-provider
claims/claims-value-provider{id}/data-source-claims-provider
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/data-source-claims-provider
Data-source
claims/claims-value-provider{id}/data-source-claims-provider/data-source
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/data-source-claims-provider/data-source
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Option: script-claims-provider
Script-claims-provider
claims/claims-value-provider{id}/script-claims-provider
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/script-claims-provider
Parameters:procedure

string

(mandatory)

The id used to identify a procedure

Account-manager
claims/claims-value-provider{id}/script-claims-provider/account-manager
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/script-claims-provider/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Bucket
claims/claims-value-provider{id}/script-claims-provider/bucket
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/script-claims-provider/bucket
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Data-source
claims/claims-value-provider{id}/script-claims-provider/data-source
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/script-claims-provider/data-source
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Webservice
claims/claims-value-provider{id}/script-claims-provider/webservice
Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/script-claims-provider/webservice

Parameters:
  • hostname

    host

    (mandatory)

    sets the hostname or ip-address of the webservice service, e.g. ‘localhost’ or ‘127.0.0.1’

  • port

    port-number

    (default: 80)

    sets the port of the webservice service, e.g. 80 or 443.

  • context

    string

    (default: /)

    sets the main context of the webservice service, e.g. ‘/scim’.

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

Option: authentication-context-claims-provider
Authentication-context-claims-provider
claims/claims-value-provider{id}/authentication-context-claims-provider
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/authentication-context-claims-provider
Option: admin-groups-claims-provider
Admin-groups-claims-provider
claims/claims-value-provider{id}/admin-groups-claims-provider
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/admin-groups-claims-provider
Option: client-certificate-claims-provider
Client-certificate-claims-provider
claims/claims-value-provider{id}/client-certificate-claims-provider
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/client-certificate-claims-provider
Option: account-manager-claims-provider
Account-manager-claims-provider
claims/claims-value-provider{id}/account-manager-claims-provider
Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/account-manager-claims-provider

Parameters:
  • map-account-to-openid-connect-claims

    boolean

    (default: true)

    Whether an account’s attributes should be mapped to OpenID Connect claims

  • resolve-claims-for-inactive-account

    boolean

    (default: false)

    While this is turned off, the claims provider will not resolve any claims if the account is inactive.

Account-manager
claims/claims-value-provider{id}/account-manager-claims-provider/account-manager
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/account-manager-claims-provider/account-manager
Parameters:id

leafref /base:processing/base:account-managers/base:account-manager/base:id

(mandatory)

A reference to an Account Manager

Option: authentication-subject-claims-provider
Authentication-subject-claims-provider
claims/claims-value-provider{id}/authentication-subject-claims-provider
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/authentication-subject-claims-provider
Option: system-information-claims-provider
System-information-claims-provider
claims/claims-value-provider{id}/system-information-claims-provider
Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-value-provider{id}/system-information-claims-provider

Claims-mappers

claims/claims-mappers

The mapping to what token or response the claim is used. A claim that is not mapped will not be issued.

Path :/profiles/profile{id, type}/settings/authorization-server/claims/claims-mappers
Parameters:default-claims-mapper

leafref ../claims-mapper/id

(optional)

The default claims mapper to use when adding claims to tokens if not defined otherwise in the client.

Claims-mapper
claims/claims-mappers/claims-mapper{id} (keys ['id'])
Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claims-mappers/claims-mapper{id}

Parameters:
  • id

    non-empty-string

    (mandatory)

    The name of the mapper

  • description

    string

    (optional)

    A description for the administrator

Access_token
claims/claims-mappers/claims-mapper{id}/access_token

The claims that go into the default access tokens. This will be the result of the getDefaultAccessTokenData() function.

Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claims-mappers/claims-mapper{id}/access_token

Parameters:
  • claim

    leafref ../../../../claim/name

    (multi-value) (optional)

  • system-claim

    system-access-token-claim-name aud, client_id, delegationId, exp, iat, iss, nbf, scope, sub, purpose, cnf, jti, dcrm_client, authorization_details

    (multi-value) (default: aud)

    The claims that always will exist on an access token. Not editable

Id_token
claims/claims-mappers/claims-mapper{id}/id_token

The claims that go into the default id tokens. This will be the result of the getDefaultIdTokenData() function.

Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claims-mappers/claims-mapper{id}/id_token

Parameters:
  • claim

    leafref ../../../../claim/name

    (multi-value) (optional)

  • system-claim

    system-id-token-claim-name iss, sub, aud, exp, iat, auth_time, nonce, acr, amr, azp, nbf, client_id, delegationId, purpose

    (multi-value) (default: iss)

    The claims that always will exist on an ID token. Not editable

Userinfo
claims/claims-mappers/claims-mapper{id}/userinfo

The claims that go into the default user info response. This will be the result of the getDefaultResponseData() function.

Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claims-mappers/claims-mapper{id}/userinfo

Parameters:
  • claim

    leafref ../../../../claim/name

    (multi-value) (optional)

  • system-claim

    system-id-token-claim-name iss, sub, aud, exp, iat, auth_time, nonce, acr, amr, azp, nbf, client_id, delegationId, purpose

    (multi-value) (default: sub)

    The claims that always will exist on an ID token. Not editable

Wrapper-token
claims/claims-mappers/claims-mapper{id}/wrapper-token

The claims that go into JWT tokens that wrap opaque tokens.This is used by opaque token issuers that are configured to return a wrapper JWT instead of an opaque reference as the token artifact.Adding a claim here does not include it in the wrapped token’s data available via introspection.

Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claims-mappers/claims-mapper{id}/wrapper-token

Parameters:
  • claim

    leafref ../../../../claim/name

    (multi-value) (optional)

  • system-claim

    system-wrapper-token-claim-name iss, iat, exp, azp, jti, aud

    (multi-value) (default: iss)

    The claims that always will exist on a wrapper JWT token. Not editable

Custom
claims/claims-mappers/claims-mapper{id}/custom{id} (keys ['id'])

The claims that go into custom tokens. This will be the result of the get default data functions such as getDefaultData(‘idOfCustomTokenMapping’) function.

Path :

/profiles/profile{id, type}/settings/authorization-server/claims/claims-mappers/claims-mapper{id}/custom{id}

Parameters:
  • id

    string

    (mandatory)

    The id of the mapping. Used as key to the getDefaultData functions

  • claims-mapper-type

    enumeration access_token, access-token, id_token, id-token, userinfo, user-info, verifiable-credential

    (default: access_token)

  • claim

    leafref ../../../../claim/name

    (multi-value) (optional)

    The list of claims for this mapping

Expose-metadata

expose-metadata

OAuth metadata endpoint configuration

Path :

/profiles/profile{id, type}/settings/authorization-server/expose-metadata

Parameters:
  • jwks-uri-override

    uri

    (optional)

    An optional value that must contain the full URL to the JWKS endpoint. If this is not set, the URL is established by deriving it from the first anonymous endpoint

  • cache-duration

    uint32

    (default: 600)

    The number of seconds that the metadata can be cached as network resource, as used in HTTP response headers.

Authorize-endpoint

expose-metadata/authorize-endpoint

The authorize-endpoint to include in the published OAuth configuration metadata. This is required when more than one authorize-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/expose-metadata/authorize-endpoint

Parameters:
  • endpoint

    leafref ../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Token-endpoint

expose-metadata/token-endpoint

The token-endpoint to include in the published OAuth configuration metadata. This is required when more than one token-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/expose-metadata/token-endpoint

Parameters:
  • endpoint

    leafref ../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Revocation-endpoint

expose-metadata/revocation-endpoint

The revocation-endpoint to include in the published OAuth configuration metadata. This is required when more than one revocation-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/expose-metadata/revocation-endpoint

Parameters:
  • endpoint

    leafref ../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Introspection-endpoint

expose-metadata/introspection-endpoint

The introspection-endpoint to include in the published OAuth configuration metadata. This is required when more than one introspection-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/expose-metadata/introspection-endpoint

Parameters:
  • endpoint

    leafref ../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Assisted-token-endpoint

expose-metadata/assisted-token-endpoint

The assisted-token-endpoint to include in the published OpenID Connect configuration metadata. This is required when more than one assisted-token-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/expose-metadata/assisted-token-endpoint

Parameters:
  • endpoint

    leafref ../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Dynamic-client-registration-endpoint

expose-metadata/dynamic-client-registration-endpoint

The dynamic client registration endpoint to include in the published OpenID Connect configuration metadata.This is required when more than one dynamic-client-registration endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/expose-metadata/dynamic-client-registration-endpoint

Parameters:
  • endpoint

    leafref ../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Device-authorization-endpoint

expose-metadata/device-authorization-endpoint

The device authorization endpoint to include in the published OpenID Connect configuration metadata.This is required when more than one device authorization endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/expose-metadata/device-authorization-endpoint

Parameters:
  • endpoint

    leafref ../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Signed-metadata

expose-metadata/signed-metadata

When present, a signed version of the metadata will be included in the response. The metadata will be included as a JWT, as issued by the default token-issuer of the current profile.

Path :/profiles/profile{id, type}/settings/authorization-server/expose-metadata/signed-metadata
Parameters:valid-for

uint32

(default: 40320)

The number of minutes that the signed metadata JWT can be used before it expires, as used in the JWT’s ‘exp’ claim

Openid-connect

openid-connect
Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect

Parameters:
  • id-token-ttl

    token-time-to-live

    (default: 3600)

    The number of seconds an id token will be valid. Can be overruled by individual client configuration.

  • passthrough-unscoped-claims

    boolean

    (default: false)

    When set, any claim that is not defined by the OpenID Connect specification, but is added by a procedure, is not removed by scope filtering.

Expose-metadata

openid-connect/expose-metadata

This section specifies what metadata is exposed on the OpenID Connect discovery endpoint for this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata

Parameters:
  • jwks-uri-override

    uri

    (optional)

    An optional value that must contain the full URL to the JWKS endpoint. If this is not set, the URL is established by deriving it from the first anonymous endpoint.

  • cache-duration

    uint32

    (default: 600)

    The number of seconds that the metadata can be cached as network resource, as used in HTTP response headers.

Authorize-endpoint
openid-connect/expose-metadata/authorize-endpoint

The authorize-endpoint to include in the published OpenID Connect configuration metadata. This is required when more than one authorize-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/authorize-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Token-endpoint
openid-connect/expose-metadata/token-endpoint

The token-endpoint to include in the published OpenID Connect configuration metadata. This is required when more than one token-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/token-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Userinfo-endpoint
openid-connect/expose-metadata/userinfo-endpoint

The userinfo-endpoint to include in the published OpenID Connect configuration metadata. This is required when more than one userinfo-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/userinfo-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Revocation-endpoint
openid-connect/expose-metadata/revocation-endpoint

The revocation-endpoint to include in the published OpenID Connect configuration metadata. This is required when more than one revocation-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/revocation-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Introspection-endpoint
openid-connect/expose-metadata/introspection-endpoint

The introspection-endpoint to include in the published OpenID Connect configuration metadata. This is required when more than one introspection-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/introspection-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Assisted-token-endpoint
openid-connect/expose-metadata/assisted-token-endpoint

The assisted-token-endpoint to include in the published OpenID Connect configuration metadata. This is required when more than one assisted-token-endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/assisted-token-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Dynamic-client-registration-endpoint
openid-connect/expose-metadata/dynamic-client-registration-endpoint

The dynamic client registration endpoint to include in the published OpenID Connect configuration metadata.This is required when more than one dynamic-client-registration endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/dynamic-client-registration-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Device-authorization-endpoint
openid-connect/expose-metadata/device-authorization-endpoint

The device authorization endpoint to include in the published OpenID Connect configuration metadata.This is required when more than one device authorization endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/device-authorization-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Backchannel-authentication-endpoint
openid-connect/expose-metadata/backchannel-authentication-endpoint

The backchannel authentication endpoint to include in the published OpenID Connect configuration metadata.This is required when more than one backchannel authentication endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/backchannel-authentication-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Session-endpoint
openid-connect/expose-metadata/session-endpoint

The session endpoint to include in the published OpenID Connect configuration metadata.This is required when more than one session endpoint is deployed on this profile.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/session-endpoint

Parameters:
  • endpoint

    leafref ../../../../../../base:endpoints/base:endpoint/base:id

    (mandatory)

    The endpoint ID

  • base-url

    uri

    (optional)

    The external base URL to report for this endpoint

Signed-metadata
openid-connect/expose-metadata/signed-metadata

When present, a signed version of the metadata will be included in the response. The metadata will be included as a JWT, as issued by the default token-issuer of the current profile.

Path :/profiles/profile{id, type}/settings/authorization-server/openid-connect/expose-metadata/signed-metadata
Parameters:valid-for

uint32

(default: 40320)

The number of minutes that the signed metadata JWT can be used before it expires, as used in the JWT’s ‘exp’ claim

Require-pairwise-subject-identifiers

openid-connect/require-pairwise-subject-identifiers

Set when clients on this profile must always be issued pairwise pseudonyms for authenticated subjects

Path :/profiles/profile{id, type}/settings/authorization-server/openid-connect/require-pairwise-subject-identifiers

Id-token-encryption

openid-connect/id-token-encryption

Enables the use of issuing encrypted ID tokens.

Path :

/profiles/profile{id, type}/settings/authorization-server/openid-connect/id-token-encryption

Parameters:
  • key-management-algorithm

    allowed-asymmetric-key-management-algorithms RSA1_5, RSA-OAEP, RSA-OAEP-256, ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW

    (multi-value) (optional)

    The whitelist of allowed key-management encryption algorithms. If nothing is selected, all are allowed.

  • content-encryption-algorithm

    allowed-content-encryption-algorithms A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM

    (multi-value) (optional)

    The whitelist of allowed content encryption algorithms. If nothing is selected, all are allowed.

Token-procedure-plugins

token-procedure-plugins
Path :/profiles/profile{id, type}/settings/authorization-server/token-procedure-plugins

Token-procedure-plugin

token-procedure-plugins/token-procedure-plugin{id} (keys ['id'])

Token procedure plugins that issue tokens

Path :/profiles/profile{id, type}/settings/authorization-server/token-procedure-plugins/token-procedure-plugin{id}
Parameters:id

string

(mandatory)

Choice: plugin

Consentors

consentors
Path :/profiles/profile{id, type}/settings/authorization-server/consentors

Consentor

consentors/consentor{id} (keys ['id'])

The list of available consentors for the profile

Path :

/profiles/profile{id, type}/settings/authorization-server/consentors/consentor{id}

Parameters:
  • id

    non-empty-string

    (mandatory)

    The consentor name

  • description

    string

    (optional)

    A readable consentor description, for user presentation. Can be a locale key.

Choice: consentor-type
Signing-consentor
consentors/consentor{id}/signing-consentor

A signing token consentor

Path :

/profiles/profile{id, type}/settings/authorization-server/consentors/consentor{id}/signing-consentor

Parameters:
  • token-issuer

    leafref /base:profiles/base:profile[base:id=current()/../../../../../../base:id][base:type=current()/../../../../../../base:type]/base:token-issuers/base:custom-token-issuer/base:id

    (optional)

    The token issuer used to sign the JWT that is signed by the consentor

  • text-to-display-procedure

    script

    (mandatory)

    The JavaScript procedure to compute the text to display.

Webservice
consentors/consentor{id}/signing-consentor/webservice

Enable and configure this if the procedure needs access to a web service in its context.

Path :

/profiles/profile{id, type}/settings/authorization-server/consentors/consentor{id}/signing-consentor/webservice

Parameters:
  • hostname

    host

    (mandatory)

    sets the hostname or ip-address of the webservice service, e.g. ‘localhost’ or ‘127.0.0.1’

  • port

    port-number

    (default: 80)

    sets the port of the webservice service, e.g. 80 or 443.

  • context

    string

    (default: /)

    sets the main context of the webservice service, e.g. ‘/scim’.

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (mandatory)

    A reference to the Http Client

Attribute-data-source
consentors/consentor{id}/signing-consentor/attribute-data-source

Enable and configure this if the procedure needs access an attribute data source in its context.

Path :/profiles/profile{id, type}/settings/authorization-server/consentors/consentor{id}/signing-consentor/attribute-data-source
Parameters:data-source

leafref /base:facilities/base:data-sources/base:data-source/base:id

(mandatory)

A reference to a data source

Choice: signing-consentor-type

Redirect-uri-validation-policies

redirect-uri-validation-policies

Configuration settings for allowing different validation methods for redirect uri’s.

Path :/profiles/profile{id, type}/settings/authorization-server/redirect-uri-validation-policies
Parameters:default-redirect-uri-validation-policy

leafref ../redirect-uri-validation-policy/id

(mandatory)

The default redirect-uri validation policy to use for the profile. If not set, redirect-uri’s are validated as exact match.

Redirect-uri-validation-policy

redirect-uri-validation-policies/redirect-uri-validation-policy{id} (keys ['id'])
Path :

/profiles/profile{id, type}/settings/authorization-server/redirect-uri-validation-policies/redirect-uri-validation-policy{id}

Parameters:
  • id

    string

    (mandatory)

    The name of the redirect-uri-validation-policy

  • description

    string

    (optional)

    A human readable name of the redirect uri validation policy.

Request-validation
redirect-uri-validation-policies/redirect-uri-validation-policy{id}/request-validation

Configure how a redirect_uri is validated when it is being used in a request.

Path :

/profiles/profile{id, type}/settings/authorization-server/redirect-uri-validation-policies/redirect-uri-validation-policy{id}/request-validation

Parameters:
  • allow-localhost-variations

    boolean

    (default: false)

    Disable all validations when the URI is localhost, such as port, path etc

  • allow-query-string-variations

    boolean

    (default: true)

    Allow the query string of the redirect_uri to be different per request

Authenticated-authorization-requests
redirect-uri-validation-policies/redirect-uri-validation-policy{id}/request-validation/authenticated-authorization-requests

Configure how a redirect_uri is validated when it is received as part of a request where the client was authenticated, e.g. when it is a PAR or CIBA request.

Path :

/profiles/profile{id, type}/settings/authorization-server/redirect-uri-validation-policies/redirect-uri-validation-policy{id}/request-validation/authenticated-authorization-requests

Parameters:
  • validate-port

    boolean

    (default: true)

    Consider the port in the URL when comparing the registered URI with the requested redirect_uri

  • validate-path

    boolean

    (default: true)

    Validate the path part of the URI to match exactly the registered path

  • allow-suffix-path

    boolean

    (default: false)

    Allow the registered path to be appended with suffix path parts per request

  • validate-querystring

    boolean

    (default: true)

    Validate the querystring to match (dynamic clients) or start with the configured querystring (static clients). If disabled, any querystring value is acceptable.

  • domain-validation

    enumeration exact, tld-plus-one, tld-plus-two, no-validation

    (default: exact)

    Validation on the domain parts of the URI

Registration-validation
redirect-uri-validation-policies/redirect-uri-validation-policy{id}/registration-validation

Configure how a redirect_uri is validated when it is being used in a registration request.

Path :/profiles/profile{id, type}/settings/authorization-server/redirect-uri-validation-policies/redirect-uri-validation-policy{id}/registration-validation
Parameters:allow-http

boolean

(default: false)

Allow a client to register a non-TLS http redirect_uri

Client-store

client-store
Path :/profiles/profile{id, type}/settings/authorization-server/client-store

Config-backed

client-store/config-backed
Path :/profiles/profile{id, type}/settings/authorization-server/client-store/config-backed
Client
client-store/config-backed/client{id} (keys ['id'])
Path :

/profiles/profile{id, type}/settings/authorization-server/client-store/config-backed/client{id}

Parameters:
  • id

    non-empty-string

    (mandatory)

    The client ID corresponding to the spec

  • client-name

    non-empty-string

    (optional)

    A human readable name of the client

  • description

    string

    (optional)

    A human readable description of the client

  • logo

    string

    (optional)

    A logo of the client, that can shown in user interface templates.

  • application-url

    uri

    (optional)

    This URL is used if a request is made to the OAuth server without the parameters necessary to initiate authentication. In such a case, the user is redirected to this URL, so that a new, properly formed, request can be made to bootstrap a new authentication transaction.

  • enabled

    boolean

    (default: true)

    A settable state of the client, to be able to host disabled clients

  • created-at

    date-and-time

    (optional)

    An operational state, for history purpose

  • created-by

    string

    (optional)

    Describes who was the user that created the client.

  • access-token-ttl

    token-time-to-live

    (default: 300)

    The number of seconds an access token will be valid

  • refresh-token-ttl

    disablable-token-time-to-live

    (default: 3600)

    The number of seconds a refresh token will be valid. If set to ‘disabled’, no refresh tokens will be issued

  • refresh-token-max-rolling-lifetime

    disablable-token-time-to-live

    (optional)

    When set, the refresh-token-ttl is used to set the expiration of new refresh tokens, until this max value is reached.

  • id-token-ttl

    token-time-to-live

    (optional)

    The number of seconds an id token will be valid. If not set, the profile-setting is used.

  • claims-mapper

    leafref ../../../../claims/claims-mappers/claims-mapper/id

    (optional)

    The mapper to use when adding claims to tokens. The mapper decides what claims end up in which token or response. The claims themselves are defined in the scope. If not set, the default-mapper is used

  • require-secured-authorization-response

    empty

    (optional)

    If set, then all authorization responses need to be protected according to the ‘JWT Secured Authorization Response Mode for OAuth 2.0’ (JARM) specification

  • privacy-policy-url

    uri

    (optional)

    An absolute URL that refers to the privacy policy for the client

  • terms-of-service-url

    uri

    (optional)

    An absolute URL that refers to the terms of service of the client

  • validate-port-on-loopback-interfaces

    boolean

    (default: true)

    Whether the port should be validated when a client is configured to redirect to the loopback interface. Defaults to true for backwards compatibility. Future versions may default to false because RFC-8252 (sec. 3) says the port should not be validated and this does not generally reduces the security of local redirects. This option can not be set when the profile enables redirect-uri validation policies. This setting is deprecated in favour of redirect-uri-validation-policies.

  • redirect-uri-validation-policy

    leafref ../../../../redirect-uri-validation-policies/redirect-uri-validation-policy/id

    (optional)

    The redirect uri validation policy to use for this client. This value overrides the profile’s setting for the default redirect uri validation policy.

  • reuse-refresh-tokens

    boolean

    (optional)

    Defines if refresh tokens are created on every refresh or if they are kept, when set this takes precedence over profile setting (reuse-refresh-tokens), when not set profile setting applies

Choice: verifier

Describes how the client is authenticated

param secret:

sha-256-digest-string

(optional)

A password used by the client

param asymmetric-key:
 

leafref /base:facilities/base:crypto/base:signature-verification-keys/base:signature-verification-key/base:id

(optional)

A public key that corresponds to the private key the client will use to sign a token with to authenticate itself

param jwks:

non-empty-string

(optional)

A JWKS providing keys that can be used to verify JWT assertions. The JSON String should be base64-encoded.

Option: jwks-uri
Jwks-uri
client-store/config-backed/client{id}/jwks-uri

A key present in a JWKS referenced by an URI, accessed via an optional HTTP client ID

Path :

/profiles/profile{id, type}/settings/authorization-server/client-store/config-backed/client{id}/jwks-uri

Parameters:
  • uri

    uri

    (mandatory)

    The JWKS URI

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (optional)

    The optional HTTP client used to retrieve the JWKS

  • symmetric-key

    non-empty-string

    (optional)

    A secret key that the client will use to sign or integrity protect a token with to authenticate itself

Mutual-tls-by-proxy
client-store/config-backed/client{id}/mutual-tls-by-proxy

Enable client authentication through mutual-tls by-proxy.

Path :/profiles/profile{id, type}/settings/authorization-server/client-store/config-backed/client{id}/mutual-tls-by-proxy
Choice: trust
Option: name-and-ca
Choice: name
param client-dn:
 

non-empty-string

(optional)

The DN of the client certificate that the client must identify with.

param client-dns-name:
 

non-empty-string

(optional)

The expected dNSName SAN entry in the certificate that the client must identify with.

param client-uri:
 

uri

(optional)

The expected uniformResourceIdentifier SAN entry in the certificate that the client must identify with.

param client-ip:
 

ip-address

(optional)

The expected IP address in either dotted decimal notation (for IPv4) or colon-delimited hexadecimal (for IPv6) that is expected to be present as an iPAddress SAN entry in the certificate that the client must identify with.

param client-email:
 

non-empty-string

(optional)

The expected rfc822Name SAN entry in the certificate that the client must identify with.

param trusted-ca:
 

leafref /base:facilities/base:crypto/base:ssl/base:client-truststore/base:client-certificate/base:id

(multi-value) (optional)

The CAs that must be the issuer of the client certificate that can be accepted to authenticate this client. At least one must be set.

Option: pinned-certificate-and-no-ca
param client-certificate:
 

leafref /base:facilities/base:crypto/base:ssl/base:client-truststore/base:client-certificate/base:id

(optional)

The client certificate that must be used to authenticate the client.

Mutual-tls
client-store/config-backed/client{id}/mutual-tls

Enable client authentication through direct mutual-tls

Path :/profiles/profile{id, type}/settings/authorization-server/client-store/config-backed/client{id}/mutual-tls
Choice: trust
Option: name-and-ca
Choice: name
param client-dn:
 

non-empty-string

(optional)

The DN of the client certificate that the client must identify with.

param client-dns-name:
 

non-empty-string

(optional)

The expected dNSName SAN entry in the certificate that the client must identify with.

param client-uri:
 

uri

(optional)

The expected uniformResourceIdentifier SAN entry in the certificate that the client must identify with.

param client-ip:
 

ip-address

(optional)

The expected IP address in either dotted decimal notation (for IPv4) or colon-delimited hexadecimal (for IPv6) that is expected to be present as an iPAddress SAN entry in the certificate that the client must identify with.

param client-email:
 

non-empty-string

(optional)

The expected rfc822Name SAN entry in the certificate that the client must identify with.

param trusted-ca:
 

leafref /base:facilities/base:crypto/base:ssl/base:client-truststore/base:client-certificate/base:id

(multi-value) (optional)

The CAs that must be the issuer of the client certificate that can be accepted to authenticate this client. At least one must be set.

Option: pinned-certificate-and-no-ca
param client-certificate:
 

leafref /base:facilities/base:crypto/base:ssl/base:client-truststore/base:client-certificate/base:id

(optional)

The client certificate that must be used to authenticate the client.

param no-authentication:
 

boolean

(default: false)

When no-authentication is selected, the client is a public client. Can only be used for clients that requests tokens, and only makes sense if they use the token endpoint (i.e. use the code flow).

param credential-manager:
 

leafref /base:processing/base:credential-managers/base:credential-manager/base:id

(optional)

The Credential Manager to use to transform the client secret. For configured clients, this credential manager is also used to retrieve the client secret from the configured data source on the credential manager

Secondary-authentication-method
client-store/config-backed/client{id}/secondary-authentication-method
Path :/profiles/profile{id, type}/settings/authorization-server/client-store/config-backed/client{id}/secondary-authentication-method
Parameters:expires-on

date-and-time

(optional)

The instant after which the secondary verifier should not be used

Choice: verifier

Describes how the client is authenticated

param secret:

sha-256-digest-string

(optional)

A password used by the client

param asymmetric-key:
 

leafref /base:facilities/base:crypto/base:signature-verification-keys/base:signature-verification-key/base:id

(optional)

A public key that corresponds to the private key the client will use to sign a token with to authenticate itself

param jwks:

non-empty-string

(optional)

A JWKS providing keys that can be used to verify JWT assertions. The JSON String should be base64-encoded.

Option: jwks-uri
Jwks-uri
client-store/config-backed/client{id}/secondary-authentication-method/jwks-uri

A key present in a JWKS referenced by an URI, accessed via an optional HTTP client ID

Path :

/profiles/profile{id, type}/settings/authorization-server/client-store/config-backed/client{id}/secondary-authentication-method/jwks-uri

Parameters:
  • uri

    uri

    (mandatory)

    The JWKS URI

  • http-client

    leafref /base:facilities/base:http/base:client/base:id

    (optional)

    The optional HTTP client used to retrieve the JWKS

  • symmetric-key

    non-empty-string

    (optional)

    A secret key that the client will use to sign or integrity protect a token with to authenticate itself

Mutual-tls-by-proxy
client-store/config-backed/client{id}/secondary-authentication-method/mutual-tls-by-proxy

Enable client authentication through mutual-tls by-proxy.

Path :/profiles/profile{id, type}/settings/authorization-server/client-store/config-backed/client{id}/secondary-authentication-method/mutual-tls-by-proxy
Choice: trust
Option: name-and-ca
Choice: name
param client-dn:
 

non-empty-string

(optional)

The DN of the client certificate that the client must identify with.

param client-dns-name:
 

non-empty-string

(optional)

The expected dNSName SAN entry in the certificate that the client must identify with.

param client-uri:
 

uri

(optional)

The expected uniformResourceIdentifier SAN entry in the certificate that the client must identify with.

param client-ip:
 

ip-address