The Access Role Object
An Access Role represents a permission/grant, which may be required to access protected web pages, or offer users preferential
Product Prices.
Properties
adminApprovalEmail
Optional email address. When a user registers for access an email will be sent to your default email address
requesting approval. The recipient of approval requests may be changed to an alternative email address. Defaults
to null to use system defaults. Only applicable when approvalMethod is
set to admin.
|
adminApprovedUrl
Optional URL path starting with /. An email is sent to the user confirming
approval of their account access. A link is provided within the email, which by default takes the user to
their account dashboard, but may be changed to a custom URL. Defaults to null to
use system defaults. Only applicable when approvalMethod is set to
admin.
|
adminPendingUrl
Optional URL path starting with /. Users who are logged in to their account,
but whose Access Role is pending approval may be redirected to a custom URL. Defaults to null to
use system defaults. Only applicable when approvalMethod is set to
admin.
|
adminRejectedUrl
Optional URL path starting with /. An email is sent to the user informing them
that the application was not approved. The email may contain additional information and an additional URL
may be provided. This may be to a policy document for approval, for example. The same URL is utilised if
the user attempts to login. Defaults to null to use system defaults. Only applicable
when approvalMethod is set to admin.
|
approvalMethod
May be one of the following values:
-
none (default)
No approval method is required. When applying the Access Role to a user the role is instantly active.
-
email
Requires that the user verify their email address. If the user has not already verified their email
address, an email will be sent to the user containing a verification link.
-
admin
Requires manual approval by an administrator before the Access Role is activated for a user.
|
createdOn
read-only
The date and time the Geozone was created.
|
deniedUrl
Optional URL path starting with /. Users who are logged in to their account,
but do not have access to pages protected by this access role may be redirected to a custom URL. Defaults
to null to use system defaults.
|
emailValidationUrl
Optional URL path starting with /. Users who are logged in to their account,
but have not verified their email address may be redirected to a custom URL. Defaults to null to
use system defaults. Only applicable when approvalMethod is set to
email.
|
id
read-only
An unsigned 64-bit integer, which is unique across all Access Roles and all Evance Accounts.
|
isRequired
read-only
A boolean indicating whether the Access Role is a protected/built-in role.
Protected roles with a value of true cannot be modified.
Currently, the only built-in Access Role is the customer role.
All custom Access Roles will have a value of false.
|
title
A title up to 50 characters long.
|
modifiedOn
read-only
The date and time the Geozone was last modified.
|
reference
An alpha-numeric string containing lowercase characters a-z, numbers 0-9,
underscores _, dashes -, and dots .
up to 50 characters in length. The reference for an Access Role is unique for the account.
|
title
A title up to 50 characters long.
|
Example
{
"data": {
"id": 53245,
"reference": "trade-account",
"title": "Trade Account",
"deniedUrl": null,
"approvalMethod": "admin",
"emailValidationUrl": null,
"adminPendingUrl": null,
"adminApprovedUrl": null,
"adminRejectedUrl": null,
"adminApprovalEmail": "administrator@example.com",
"createdOn": "2022-05-21T15:54:05+00:00",
"modifiedOn": "2022-05-21T15:54:05+00:00"
}
}
