Security Settings
| Info |
|---|
Security settings allow a user to configure policies governing security-related system features, ranging from creating API keys for client applications, to setting-up user roles and inviting users. The configurable security settings vary depending on the logged-in user’s organisation level (i.e. a user logged-in at Service Owner level will not see the same configuration options as someone logged-in at Business level). |
Security features are configured and managed via the Settings option. This manual covers all available security settings from Cloud Operator level to Merchant/Service Provider level for all organisations, with an indication of which options are available per organisation.
To configure your Security settings click on your logged-in user name in the top right-hand - corner of the screen > Settings > Security.
User Roles and Users
| Status | ||
|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
Users are the people who perform the day-to-day tasks (e.g. process service requests/orders, monitor performance, setup configuration), either through the User Interface or Web APIs, subject to business network and security restrictions.
User Roles are a group of permissions assigned to users and define the access that users have throughout the system (e.g. to manage Contacts, to configure Reward Offers).
Admin User Role
Upon creation of an Organisation (e.g. Service Owner, Business, Merchant/Service Provider), an Admin (owner) user role with full access permissions granted is automatically created. Such a User Role is assigned to each user who registers an Organisation, or explicitly to users who are invited to join an organisation.
User Roles
Create new User Roles and assign the relevant permissions, prior to inviting users to join the Organisation.
Navigate to Settings > Security > User Roles > Create User Role
Provide a unique name for the User Role
Enable the respective toggle to allow access to a particular area of the system
Access can be restricted to specific actions too
Save your User Role
Ensure that you have considered all available options and enabled/disabled access accordingly.
Users
Inviting a User to join your Organisation, in effect creates a User with permissions to navigate the system based on the User Role assigned to them.
Settings > Security > Users > Invite User
Complete the user details
Select the User Role
Save to submit the invitation
The new user will receive an email informing them that they have been invited to join an Organisation, they must follow the email verification procedure in order to create a password and be able to access the system. The user's credentials for signing-in to the system is the email they have been invited with, and the password they have chosen.
Users have the ability to access their ‘owned by’ Organisation’s data, and any other child Organisations data ‘owned by’ their Organisation (using masquerade). Refer to the Business Network manual for further details on masquerading.
API Keys
Status
View Pending Invites
Select this option to see users who have not yet accepted the invitation to sign-in to the system.
| Info |
|---|
|
API Keys
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
API Keys
API Keys are unique identifiers that allow a client application (e.g. mobile app, external system) to consume CRM.COM’s Web APIs (back-office/self-service).
Navigate to Settings > Security > API Keys
Public Keyis used solely as an organisation identification allowing users to consume self-service APIs, e.g. you’ll need such a key if your customers will be using a consumer app
Secret Key should be kept confidential and is used for performing business actions in CRM.COM, such keys fall under security restrictions and permissions
Multiple public and private keys are supported.
| Anchor | ||||
|---|---|---|---|---|
|
A webhook is an automated call to a server providing real-time information for a CRM.COM entity, without requiring additional integration. These calls are triggered when a specific event happens.
Each webhook request can be protected with additional authentication security, such as username/password or API Key.
A webhook request can have one of the following states:
Pending - The webhook request has been created and awaiting waiting to be sent (queued)
Success - The webhook request was successfully sent and received by the external application
Failed - The webhook request was not sent to the external application successfully (an error description is logged for investigation purposes)
Refer to the Automations manual for more information on Events and Webhooks.
Advanced
Password Expiration Policy
| Status | ||||
|---|---|---|---|---|
|
Password Policy
Service Owner users
| Status | ||||
|---|---|---|---|---|
|
Service Owners have the option to enable a password expiration policy whereby system users must reset their passwords prior to, or upon expiration. The user can reset their password on the day of expiration during sign-in, or prior to the expiration day by navigating to My Profile and enabling the Change Password toggle.
The password expiration policy can be set by the Service Owner and/or Business organisations. If it’s set by the Service Owner, then this setting will apply to all of its business network (including child Businesses and Merchants). However, if the Business organisation decides to set their own password expiration policy too, then this setting will overwrite the Service Owner’s configuration. In the event that the Business configuration will overwrite the Service Owner’s configuration, then the maximum number of days for password expiration and notification must be equal to, or less than the number of days set by the Service Owner configuration. e.g. if the Service Owner sets 60 days for password expiration, then the Business can set up to or less than 60 days for the same setting.
Password expiration number of days
Valid range is between 14 to 730 days
If not set, then the default is 90 days
Password expiration notification
Valid range is between 1 and less than the number of expiration days set
If not set specified, then defaults to 15 days
Concurrent Session Policy
| Status | ||||
|---|---|---|---|---|
|
Service Owner users have the option to enable a concurrent session policy whereby users are enforced limited to have having a maximum number of active sessions.
Core Behaviour
The following security features are not configurable by the users, but are implemented as part of CRM.COM core behaviour of the system.
Strong Password Policy
| Status | ||
|---|---|---|
|
|
This setting provides the ability to support only strong passwords for contacts and users alike.
Contact Strong Password Policy Rules
Must be at least 8-characters in length
Supports alphanumeric characters
Supports special characters
Not permitted
A sequence of characters or numbers (e.g. “abcdefg” or “123456”)
The previously used previous password
(System) User Strong Password Policy Rules
Must be at least 8-characters in length
Supports alphanumeric characters
Supports special characters
Must contain at least
One upper and lower case character
A number
Note Not permitted
A sequence of characters or numbers (e.g. “abcdefg” or “123456”)
The previously used password
If the user belongs to multiple organisations with different strong password policies, then the most strict policy is applied to ensure the highest level of password security
Two-Factor Authentication (2FA)
| Status | ||||
|---|---|---|---|---|
|
2FA is an extra layer of security whereby two distinct forms of identification are required in order to provide a user access to the back-end system, e.g. aside from a username and password, users will be required to provide another piece of information that can be retrieved either by an external authentication application (e.g. Google Authenticator), or in the form of an OTP (via phone or email) to gain access to a system.
Eligible users have the ability to configure one or multiple 2FA methods.
| Info |
|---|
2FA is implemented as system core behaviour for Service Owner users |
OpenID Connect
| Status | ||||
|---|---|---|---|---|
|
OIDC (OpenID Connect) is an authentication protocol implemented by CRM.COM during user login, whereby users can authenticate and access CRM.COM using a single set of credentials from another platform.
Configuration Document URL
The URL endpoint to be used to retrieve specific configuration attributes that are required during the OIDC authentication flow, this URL is provided by the OIDC provider.
Application ID
This is the business’s OIDC application identifier and is used to request and gain access to the OIDC provider. Such an ID is also provided by the OIDC provider.
Core Behaviour
The following security feature is not configurable but is implemented as part of CRM.COM’s core system behaviour.
Password Lockout
This is a mechanism that provides the ability to lockout lock out a system user after a number of invalid login attempts. When a user is locked out they are not able to login log in for a pre-defined period of time.
User Password Lockout Policy Rules
Lockout is enforced after 5 failed attempts to authenticate using an invalid password, within a 15-minute time span (given that the username is valid). A locked-out user will not be able to authenticate even using the correct username/password until the lockout has been lifted.
The lockout period is lifted automatically after 30 minutes, or manually by an another authorised user.
Two-Factor Authentication (2FA)
2FA is an extra layer of security whereby two distinct forms of identification are required in order to provide a user access to a system, e.g. aside from a username and password, users will be required to provide another piece of information that can be retrieved either by an external authentication application (e.g. Google Authenticator), or in the form of an OTP (via phone or email) to gain access to a system.
2FA can be configured at the Service Owner level or the Business level. Eligible users have the ability to configure one or multiple 2FA methods.
Reference Material
You may also find it useful to refer to the following manuals for further reading in relation to Security.
Business Network
Automations
TABLE OF CONTENTS
| Table of Contents |
|---|