Page Comparison

domainName ^required

string

Enter the name of the required domain. You

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{resellerName}

roleName ^required

string

Enter the name of the required role.

Note that this parameter is case sensitive. For Devo default roles, you must type:

• Administrator

• No privileges

full

boolean

Set this to trueif you want to get additional details about the role (assigned policies, resources, applications…). The default value is false.

domainName ^required

string

Enter the name of the required domain. You

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required multitenant domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required multitenant domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required multitenant domain. You must enter the full domain name using the format {domainName}@{resellerName}

key ^required

string

API key you want to retrieve.

You can get this using the GET/domain/{domainName}/keys endpoint. Find the required API key in the apiKey parameter of the response.

name ^required

string

Enter the name of the required domain.

The domain name might include the @{multitenantName} tail or not, but take into account that the full name will actually be used (for example, for name length validation).

The name value will always contain the full domain name in the response, even if you have provided only the domain name without the multitenant name tail.

plan ^required

string

Enter the name of the price plan. Assigning a domain to an existing, valid multitenant price plan is mandatory.

time

number

Indicate the retention time in months. The maximum value is 100.

volume

number

Enter the storage volume in GB. The maximum value is 100.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

name ^required

string

Enter the name of the new role.

description

string

An optional description for the role.

policies

list

The role policies (or permissions) of the new role.

If this parameter is not included, all the available policies will be added to the role. Using the value [*] or * will also add all the available policies. For an empty policy list, use [].

Example: ["policy_1", "policy_2"]

applications

list

Specify the applications available for the new role.

Using the value [*] or * will add all the available applications. For an empty application list, use [].

Example: ["application_1", "application_2"]

defaultApplicationName

string

The required application to use as the default one. The default application name must be among the role applications specified.

A default application name is not required when the policies list is empty (a missing registry key is interpreted as an empty list)

resources

object

A JSON object where you indicate the resources to be added to the role. You mast add an array for each resource, including its ID and access level:

• id - (integer) ID of the resource to be added to the role

• editable - (integer) Set the required access level for the resource. Note that you must have the required permissions to give access to a resource; otherwise, an error will be returned. Allowed values are 0 (view access) or 1 (manage access).

Example:

  "resources": [
    {
      "id": 501,
      "editable": 1
    }
  ]

resourceIds

object

A JSON object with the resource type and a list of resources IDs. Each resource ID instance takes a name plus an integer array. The name is not really important and only exists to provide a clearer way to describe the role. Each entry resource ID list can be empty.

Using the key pair "*": [] will add all the available domain resources. For an empty resource list, use [].

Examples

Assign specific resources:

  "resourceIds": {
    "activeboard": [501]
    "lookup": [1000, 2000]
  }

No resources assigned:

  "resourceIds": {
    "activeboard": []
    "lookup": []
  }

Add all the available domain resources (lookups and activeboards):

  "resourceIds": {
    "*": []
  }

finderName

string

Optionally, enter the name of the default finder to be assigned to the role.

alertPermission

string

Level of permission over alerts that you want to grant to the new role. There are 3 options available:

• Null value - Permissions over alerts will not be updated over any existing ones while updating a role, or will be created empty when creating a role.

• Empty value - No permissions are given over alerts. Several policies might produce and error when the role has no permissions over any alert.

• Specific value - The role will have permissions only over the provided alerts. This is the format to follow:

  • level - The access level to be granted. Options are: all, category (can be abbreviated as cat), subcategory (can be abbreviated as sub), and context (can be abbreviated as ctx).

  • granted - The alert ID over which the access is granted. Use all to include all alerts. For the permission to work, the level and grant value must match, meaning that
    the granted ID must belong to the specified category.

  • editable - Defines if the alert can be edited or not. Use values 1 (editable) and 0 (not editable).

 ...
  "alertPermission": [
    { "level" : "all", 
      "granted": "all", 
      "editable": 0 }
  ],
  ...

Note that several policies require certain alert permissions to be assigned. For example, to include any policy related with alerts, permissions over at least one alert is required. Similarly, any alert management policy requires the same but for an alert with management permissions.

When the * value is used for policies, the policies assigned will depend on the alert permissions granted. In the following example, we are granting view permissions over all alerts, so the policies assigned by the wildcard will include values like policy.alerts.view but not policy.alerts.manage

{
  "name": "test-role",
  "alertPermission": [
    { "level" : "all", "granted": "all", "editable": 0 }
  ],
  "policies": "*"
}

defVaultId

integer

The default vault (querying priority level) defined for the role.

maxVaultId

integer

The maximum vault defined to be used in the role.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

pricePlan ^required

string

Name of the new plan to be set.

keepRole

string

Decide what to do with users that have a custom role, that is to say, roles other than Admin and No privileges. Possible values are:

• true - roles in the current plan will be searched in the new one and used where available. If the role of a user is not found in the new plan, they will be set to No provileges.

• false (or null) - all custom roles will be updated to No privileges. This is the default behavior.

• Finally, providing a specific role name will work the same as with true, but using the provided role when a matching custom role is not found. This fallback role must exist, or a bad request error will be returned.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

volume

number

Enter the maximum ingestion volume.

retentionUnit

string

Specify the required unit of the retention value.. Allowed values are DAYS, MONTHS, WEEKS and YEARS.

retentionValue

integer

Required retention value.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

name ^required

string

Enter the name of the role to be updated.

description

string

An optional description for the role.

policies

list

The role policies (or permissions) of the role.

If this parameter is not included, all the available policies will be added to the role. Using the value [*] or * will also add all the available policies. For an empty policy list, use [].

Example: ["policy_1", "policy_2"]

applications

list

Specify the applications available for the role.

Using the value [*] or * will add all the available applications. For an empty application list, use [].

Example: ["application_1", "application_2"]

defaultApplicationName

string

The required application to use as the default one. The default application name must be among the role applications specified.

A default application name is not required when the policies list is empty (a missing registry key is interpreted as an empty list.)

resourceIds

object

A JSON object with the resource type and a list of resources IDs. Each resource ID instance takes a name plus an integer array. The name is not really important and only exists to provide a clearer way to describe the role. Each entry resource ID list can be empty.

Using the key pair "*": [] will add all the available domain resources. For an empty resource list, use [].

Examples

Assign specific resources:

  "resourceIds": {
    "activeboard": [501]
    "lookup": [1000, 2000]
  }

No resources assigned:

  "resourceIds": {
    "activeboard": []
    "lookup": []
  }

Add all the available domain resources (lookups and activeboards):

  "resourceIds": {
    "*": []
  }

finderName

string

Optionally, enter the name of the default finder to be assigned to the role.

alertPermission

string

Level of permission over alerts that you want to grant to the role. There are 3 options available:

• Null value - Permissions over alerts will not be updated over any existing ones while updating a role, or will be created empty when creating a role.

• Empty value - No permissions are given over alerts. Several policies might produce and error when the role has no permissions over any alert.

• Specific value - The role will have permissions only over the provided alerts. This is the format to follow:

  • level - The access level to be granted. Options are: all, category (can be abbreviated as cat), subcategory (can be abbreviated as sub), and context (can be abbreviated as ctx).

  • granted - The alert ID over which the access is granted. Use all to include all alerts. For the permission to work, the level and grant value must match, meaning that
    the granted ID must belong to the specified category.

  • editable - Defines if the alert can be edited or not. Use values 1 (editable) and 0 (not editable).

 ...
  "alertPermission": [
    { "level" : "all", 
      "granted": "all", 
      "editable": 0 }
  ],
  ...

Note that several policies require certain alert permissions to be assigned. For example, to include any policy related with alerts, permissions over at least one alert is required. Similarly, any alert management policy requires the same but for an alert with management permissions.

When the * value is used for policies, the policies assigned will depend on the alert permissions granted. In the following example, we are granting view permissions over all alerts, so the policies assigned by the wildcard will include values like policy.alerts.view but not policy.alerts.manage

{
  "name": "test-role",
  "alertPermission": [
    { "level" : "all", "granted": "all", "editable": 0 }
  ],
  "policies": "*"
}

defVaultId

integer

The default vault (querying priority level) defined for the role.

maxVaultId

integer

The maximum vault defined to be used in the role.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

roleName ^required

string

Enter the name of the role to be updated.

name ^required

string

Enter the name of the role to be updated.

description

string

An optional description for the role.

policies

list

The role policies (or permissions) of the role.

If this parameter is not included, all the available policies will be added to the role. Using the value [*] or * will also add all the available policies. For an empty policy list, use [].

Example: ["policy_1", "policy_2"]

applications

list

Specify the applications available for the role.

Using the value [*] or * will add all the available applications. For an empty application list, use [].

Example: ["application_1", "application_2"]

defaultApplicationName

string

The required application to use as the default one. The default application name must be among the role applications specified.

A default application name is not required when the policies list is empty (a missing registry key is interpreted as an empty list.)

resourceIds

object

A JSON object with the resource type and a list of resources IDs. Each resource ID instance takes a name plus an integer array. The name is not really important and only exists to provide a clearer way to describe the role. Each entry resource ID list can be empty.

Using the key pair "*": [] will add all the available domain resources. For an empty resource list, use [].

Examples

Assign specific resources:

  "resourceIds": {
    "activeboard": [501]
    "lookup": [1000, 2000]
  }

No resources assigned:

  "resourceIds": {
    "activeboard": []
    "lookup": []
  }

Add all the available domain resources (lookups and activeboards):

  "resourceIds": {
    "*": []
  }

finderName

string

Optionally, enter the name of the default finder to be assigned to the role.

alertPermission

string

Level of permission over alerts that you want to grant to the role. There are 3 options available:

• Null value - Permissions over alerts will not be updated over any existing ones while updating a role, or will be created empty when creating a role.

• Empty value - No permissions are given over alerts. Several policies might produce and error when the role has no permissions over any alert.

• Specific value - The role will have permissions only over the provided alerts. This is the format to follow:

  • level - The access level to be granted. Options are: all, category (can be abbreviated as cat), subcategory (can be abbreviated as sub), and context (can be abbreviated as ctx).

  • granted - The alert ID over which the access is granted. Use all to include all alerts. For the permission to work, the level and grant value must match, meaning that
    the granted ID must belong to the specified category.

  • editable - Defines if the alert can be edited or not. Use values 1 (editable) and 0 (not editable).

 ...
  "alertPermission": [
    { "level" : "all", 
      "granted": "all", 
      "editable": 0 }
  ],
  ...

Note that several policies require certain alert permissions to be assigned. For example, to include any policy related with alerts, permissions over at least one alert is required. Similarly, any alert management policy requires the same but for an alert with management permissions.

When the * value is used for policies, the policies assigned will depend on the alert permissions granted. In the following example, we are granting view permissions over all alerts, so the policies assigned by the wildcard will include values like policy.alerts.view but not policy.alerts.manage

{
  "name": "test-role",
  "alertPermission": [
    { "level" : "all", "granted": "all", "editable": 0 }
  ],
  "policies": "*"
}

defVaultId

integer

The default vault (querying priority level) defined for the role.

maxVaultId

integer

The maximum vault defined to be used in the role.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

inactivityPeriod ^required

number

Specify the period of time during which a user can be inactive (that is, not interact with the system in any way) without any impact on their session. After the inactivity period expires, the user is locked out of the session and must log back in to continue working with Devo.

This is valid only when the expiresSession parameter is set to true.

expiresSession

boolean

Select if you want to set an inactivity timeout for domain session. Otherwise, user sessions remain open until manually closed.

getLocaleFromBrowser

boolean

Set this parameter to true to use the language configured in your web browser.

If your browser language is not supported by Devo, English is the language automatically applied.

You can only use this parameter if you don’t include the parameter locale, or set it to false.

locale

string

Specify the language of the application. This can be overridden in a user's individual preferences.

hideDemoTablesChecked

booleang

Check this box to hide the demo* tables in the finder.

loxcopeCaseSensitivity

string

Some query operations have a case-sensitive and a case insensitive version. You can choose which one is used by default when both options exist. There are two options available:

• case sensitive - Set case sensitive operations as default for operations that have both options.

• case insensitive - Set case insensitive operations as default for operations that have both options.

defaultRange

string

Specify the time range that determines which events to load by default. The maximum is 24 hours. This applies to all users and all data tables in the domain.

queryForever

string

Select to activate real-time data flow by default when opening a data table or query. Otherwise, data tables open with a time range whose end date corresponds to the moment they were opened.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

userLimit

number

Specify the limit of users in the domain.

certificateLimit

number

Specify the number of certificates that can be created in a domain.

keyLimit

number

Specify the number of access keys that can be created in a domain

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

roleName ^required

string

Enter the name of the role to be deleted.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

key ^required

string

API key you want to delete.

You can get this using the GET/domain/{domainName}/keys endpoint. Find the required API key in the apiKey parameter of the response.