Registration & Login policy
With the registration and login policy, you can manage who can register and access your system. Here you can review the Whitelist & Blacklist of emails and domains
Method: list policy emails
Authorization is required.
Request
HTTP request
GET https://<YOUR_DOMAIN>/api/v1/en_US/registration-login-policy/email/list?offset={offset}&pageSize={pageSize}&filter={filter}&isWhiteList={isWhiteList}
Parameters
| property | value | description |
|---|---|---|
| offset | integer | Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response. |
| pageSize | integer | How many records to be returned by the system. Usually 15 |
| filter | string | Query string to be looked for when filtering the records |
| isWhiteList | boolean | Whether you need the list of whitelisted or blacklisted emails |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"success": true,
"message": "Laborum nulla nulla reprehenderit proident sunt officia labore consectetur elit.",
"timestamp": "2014-03-03T23:20:23Z",
"errors": [],
"object": {
"offset": 0,
"emails": [
{
"id": 111,
"type": "email",
"address": "langlynn@intrawear.com",
"whiteListed": true
}
]
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
Method: create policy email
Authorization is required.
Request
HTTP request
POST https://<YOUR_DOMAIN>/api/v1/en_US/registration-login-policy/email
Parameters
Do not supply a request parameters with this method.
Request body
| property | value | description |
|---|---|---|
| string | The email address that you need to add to the policy | |
| whiteListed | boolean | In which list to add the email - Whitelist (true) or Blacklist (false) |
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": false,
"message": "Aliqua anim consequat amet cupidatat proident amet amet.",
"errors":[
{
"key":"email",
"value":"",
"message": "Email cannot be blank"
}],
"object": {
"id": "1",
"type": "email",
"address": "wolfegood@pathways.com",
"whiteListed": true
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | List of validation errors, if any. The "key" property value is matched to one of the record's fields |
| object | object | The object that caused the validation errors or that was created. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differ from the posted one. |
Method: update policy email
Authorization is required.
Request
HTTP request
PUT https://<YOUR_DOMAIN>/api/v1/en_US/registration-login-policy/email/{emailId}
Parameters
| property | value | description |
|---|---|---|
| emailId | integer | In id of the updated record |
Request body
| property | value | description |
|---|---|---|
| string | The email address that you need to add to the policy | |
| whiteListed | boolean | In which list to add the email - Whitelist (true) or Blacklist (false) |
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": false,
"message": "Aliqua anim consequat amet cupidatat proident amet amet.",
"errors":[
{
"key":"email",
"value":"",
"message": "Email cannot be blank"
}],
"object": {
"id": "1",
"type": "email",
"address": "wolfegood@pathways.com",
"whiteListed": true
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | List of validation errors, if any. The "key" property value is matched to one of the record's fields |
| object | object | The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one. |
Method: delete policy email
Authorization is required.
Request
HTTP request
DELETE https://<YOUR_DOMAIN>/api/v1/en_US/registration-login-policy/email/{emailId}
Parameters
| property | value | description |
|---|---|---|
| emailId | integer | In id of the deleted record |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": false,
"message": "Aliqua anim consequat amet cupidatat proident amet amet.",
"errors":[],
"object": {
"id": "1",
"type": "email",
"address": "wolfegood@pathways.com",
"whiteListed": true
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | This list very rarely contains records during delete method processing |
| object | object | The object that was deleted |
Method: list policy domains
Authorization is required.
Request
HTTP request
GET https://<YOUR_DOMAIN>/api/v1/en_US/registration-login-policy/domain/list?offset={offset}&pageSize={pageSize}&filter={filter}&isWhiteList={isWhiteList}
Parameters
| property | value | description |
|---|---|---|
| offset | integer | Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response. |
| pageSize | integer | How many records to be returned by the system. Usually 15 |
| filter | string | Query string to be looked for when filtering the records |
| isWhiteList | boolean | Whether you need the list of whitelisted or blacklisted domains |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"success": true,
"message": "Laborum nulla nulla reprehenderit proident sunt officia labore consectetur elit.",
"timestamp": "2014-03-03T23:20:23Z",
"errors": [],
"object": {
"offset": 0,
"emails": [
{
"id": 111,
"type": "domain",
"name": "duis.com",
"whiteListed": true
}
]
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
Method: create policy domain
Authorization is required.
Request
HTTP request
POST https://<YOUR_DOMAIN>/api/v1/en_US/registration-login-policy/domain
Parameters
Do not supply a request parameters with this method.
Request body
| property | value | description |
|---|---|---|
| name | string | The domain name that you need to add to the policy |
| whiteListed | boolean | In which list to add the domain name - Whitelist (true) or Blacklist (false) |
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": false,
"message": "Aliqua anim consequat amet cupidatat proident amet amet.",
"errors":[
{
"key":"name",
"value":"",
"message": "Name cannot be blank"
}],
"object": {
"id": "1",
"type": "domain",
"name": "duis.com",
"whiteListed": true
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | List of validation errors, if any. The "key" property value is matched to one of the record's fields |
| object | object | The object that caused the validation errors or that was created. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differ from the posted one. |
Method: update policy domain
Authorization is required.
Request
HTTP request
PUT https://<YOUR_DOMAIN>/api/v1/en_US/registration-login-policy/domain/{domainId}
Parameters
| property | value | description |
|---|---|---|
| domainId | integer | In id of the updated record |
Request body
| property | value | description |
|---|---|---|
| name | string | The domain name that you need to add to the policy |
| whiteListed | boolean | In which list to add the domain name - Whitelist (true) or Blacklist (false) |
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": false,
"message": "Aliqua anim consequat amet cupidatat proident amet amet.",
"errors":[
{
"key":"name",
"value":"",
"message": "Name cannot be blank"
}],
"object": {
"id": "1",
"type": "domain",
"name": "duis.com",
"whiteListed": true
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | List of validation errors, if any. The "key" property value is matched to one of the record's fields |
| object | object | The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one. |
Method: delete policy domain
Authorization is required.
Request
HTTP request
DELETE https://<YOUR_DOMAIN>/api/v1/en_US/registration-login-policy/domain/{domainId}
Parameters
| property | value | description |
|---|---|---|
| domainId | integer | In id of the deleted record |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": false,
"message": "Aliqua anim consequat amet cupidatat proident amet amet.",
"errors":[],
"object": {
"id": "1",
"type": "domain",
"name": "duis.com",
"whiteListed": true
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | This list very rarely contains records during delete method processing |
| object | object | The object that was deleted |