FrejaEIDAuthRequestValve
Creates a authentication request to the Freja e-ID backend. Typically used with the authentication API module. Because of this, the data used is expected to come from the request. Not an item.
The valve will create an item if none is present.
For more detailed information see https://frejaeid.com/rest-api/Authentication%20Service.html
Example Configuration
{
"name" : "FrejaEIDAuthRequestValve",
"config" : {
"keystoreID" : "93f5e7e1-c3f4-436b-9bbc-0b94d454a352",
"mode" : "production_personal_auth"
}
}
Requirements
- The server trusts the Freja e-ID backend TLS certificate.
- A client certificate & private key (keystore) thsat is issued by Freja e-ID is present in the configuration.
Request parameters
The incoming request must contain the following parameters:
- attributesToGet, indicates what data the backend will release after a successful signature. Valid values are: BASIC_USER_INFO,EMAIL_ADDRESS,ALL_EMAIL_ADDRESSES,DATE_OF_BIRTH,ADDRESSES,ORGANISATION_ID_IDENTIFIER,SSN.
- reqiredRegistrationLevel valid value is one of: BASIC, EXTENDED, PLUS
- userInfoType, valid value is one of: PHONE, EMAIL, SSN, ORG_ID
- userIdentifier, must contain a matching value of the Freja e-ID profile. An email address for instance
Example request
{
"attributesToGet":"SSN,BASIC_USER_INFO",
"reqiredRegistrationLevel":"EXTENDED",
"userInfoType":"email",
"userIdentifier":"[email protected]"
}