Security settings

This is where we set how we will enable the access to each client for the projectFlow created for the login process.

How it works

This part of the body refers to the security system that will be used to allow or deny access to certain users in your project flow. Here, we will list each element and how it should be used:

• strategy: Specifies whether users will be allowed entry or denied access. Use "whitelist" if you want the users you send to be able to access the project flow or "blacklist" if you want to deny them access.

• source: Defines how we will send the list of users for our security system. We have two options:

CSV

In case we use the CSV source, we should provide the list of users in the following way in an array of objects called whitelist. We need to send the following data in each of the objects:

• name: User's name

• email: Email associated with this user.

• countryCode: Country code prefix of the phone.

• phone: Phone to be associated with this user.

`
{
	"security": {
		"apiTestType": "email",
		"source": "CSV",
		"strategy": "whitelist"
	},
	"whiteList": [
	   {
		"name": "Miguel",
		"email": "[e-mail]",
		"countryCode": "+507",
		"phone": "62647737"
	   },
	   {
		"name": "Felipe",
		"email": "[e-mail]",
		"countryCode": "+1",
		"phone": "5454849484"
	   }
	]
}

API

If we use the API source, we must provide the following fields in the security object:

• apiUrl: This field is an API that should be able to return information about your users. Here, you should have data such as email, phone, country code, and name.

• apiTestType: Here, you determine the test value that will be used, whether it's an email or a phone.

• apiTestValue: This is an example; it is a real data point that, when used to query the API, will return the appropriate information to add people to the whitelist.

{
    "security": {
        "strategy": "whitelist",
        "source": "API",
        "apiUrl": "https://faas-nyc1-2ef2e6cc.doserverless.co/api/v1/web/fn-b88d2a3d-137b-4d8c-95af-9c4f33f69af4/passwordless-validation-url/demo-passwordless-validation-url",
        "apiTestType": "email",
        "apiTestValue": "[e-mail]"
    }
}