Reference: JSON Schema for Access Control Statements

Overview

Activity access control statements for Uptempo Plan are built on a JSON-based schema, so the underlying structure of these statements is defined in JSON.

While you can configure most access control statements using the Statement Editor GUI, you also have the option of writing JSON directly in the Raw JSON editor. Using the Raw JSON editor offers more control, and is a requirement for using certain features such as activity attribute conditions (which are currently not supported by the Statement Editor).

This reference guide details the JSON schema for activity access controls. It describes the required structure and fields, and the accepted values and data types, for creating valid access control statements for Uptempo Plan.

Basic Syntax Rules

When writing an activity access control statement in JSON, use standard JSON syntax:

• Begin and end statements and objects with curly braces {...}

• Begin and end arrays (e.g. conditions) with square brackets [...]

• For key-value pairs, use the format "key": "value" :

  • Separate the key and value with colon :

  • Keys must be strings in double quotes "key"

  • If the value is a string, it must be in double quotes "value"

• Separate individual key-value pairs and items in arrays with a comma ,

  • Do not place a trailing comma after the last item

• Do not include comments

Structure

Access control statements use the following basic structure:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "effect": "string",
  "action": "ActivityAction | ActivityTypeAction",
  "resourceType": "string",
  "resourceLocator": "ActivityResource | ActivityTypeResource",
  "conditions": [
    {
      "field": {
          "name": "string"
      },
      "operator": "string",
      "value": ["string", "string"]
    },
    {
      "field": {
          "attributeDefinitionId": "string"
      },
      "operator": "string",
      "value": ["string", "string"]
    }
  ]
}

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "effect": "ALLOW",
    "action": "View",
    "resourceType": "ACTIVITY",
    "resourceLocator": "*",
    "conditions": [
      {
        "field": { 
          "name": "ACTIVITY_TYPE" 
        },
        "operator": "IS ONE OF",
        "value": ["21", "74", "41"]
      }
    ]
}

Top-Level Properties

Overview

The top-level properties in an access control statement are:

Property: effect

Example (fragment)

{
    ...
    "effect": "ALLOW",
    ...
}

Property: action

Type: ActivityAction

Example (fragment):

{
    ...
    "action": "View",
    "resourceType": "ACTIVITY",
    ...
}

Type: ActivityTypeAction

Example (fragment):

{
    ...
    "action": "CreateActivity",
    "resourceType": "ACTIVITY_TYPE",
    ...
}

Property: resourceType

Example (fragment):

{
    ...
    "resourceType": "ACTIVITY_TYPE",
    ...
}

Property: resourceLocator

Type: ActivityResource

Example (fragment):

{
    ...
    "resourceType": "ACTIVITY",
    "resourceLocator": "*",
    ...
}

Type: ActivityTypeResource

Example (fragment):

{
    ...
    "resourceType": "ACTIVITY_TYPE",
    "resourceLocator": "*/12"
    ...
}

Property: conditions

Example (fragment):

{
  ...
  "conditions": [
    {
      "field": {
          "name": "string"
      },
      "operator": "string",
      "value": ["string", "string"]
    },
    {
      "field": {
          "attributeDefinitionId": "string"
      },
      "operator": "string",
      "value": ["string", "string"]
    }
  ]
}

Nested Properties: conditions Object

Each object in the conditions array describes a separate condition that must be met for the statement to apply, and consists of the following properties:

Property: field

Nested Property: name

Example (fragment):

{
    "field": {
     "name": "ACTIVITY_TYPE"
    },
    ...
}

Nested Property: attributeDefinitionId

Example (fragment):

{
    "field": {
        "attributeDefinitionId": "123456"
        },
    ...
}

Property: operator

Example (fragment):

{
    ...
    "operator": "IS_ONE_OF",
    ...
}

Property: value

Example (fragment):

{
    ...
    "value": ["123", "456", "789"]
}

Finding ID Codes

If you create an access control statement with a conditions object, you must provide ID codes to uniquely identify activity types, activity type groups, attribute definitions, and attribute options.

In this section, you can find instructions for finding these ID codes in Uptempo.

Find Activity Type and Activity Type Group IDs

Use these instructions to find IDs with the value formats ACTIVITY_TYPE_ID and ACTIVITY_TYPE_GROUP_ID. These ID codes are valid for the value property.

To find ACTIVITY_TYPE_ID and ACTIVITY_TYPE_GROUP_ID codes, follow these steps:

1. Log in to your Uptempo instance. Click on Activities in the navigation menu.

   The Activities section opens to the Timeline.

2. In the Timeline, click Filter.

   The Filter by menu opens:

   
   

3. In the Select Condition menu for Type, select the condition is.

4. In the Set a value menu:

   • In the first panel, select the activity type group for which you want to find the ACTIVITY_TYPE_GROUP_ID.

   • Optional: In the second panel, select the activity type for which you want to find the ACTIVITY_TYPE_ID.

5. Click Apply.

   The Filter by menu closes, and the Activities page refreshes.

6. In the browser URL bar, find the query string parameter beginning with filter=:

   

7. The value of this parameter provides the IDs for the selected activity type group and activity type:

   • The value will have the format typeGroupId~IS~tgXXX-tYYY, where:

     • XXX is a numeric string representing the ACTIVITY_TYPE_GROUP_ID (denoted by the prefix tg)

     • YYY is a numeric string representing the ACTIVITY_TYPE_ID (denoted by the prefix t).

   • Note that IDs are numeric only — do not include the t or tg prefix.

   • If you only specified an activity type group (but no activity type), the value will not include the -tYYY portion.

Find Attribute Definition IDs and Attribute Option IDs

Use these instructions to find IDs with the value format ATTRIBUTE_DEFINITION_ID and ATTRIBUTE_OPTION_ID. These ID codes are valid for the field.attributeDefinitionId and value properties, respectively.

To find ATTRIBUTE_DEFINITION_ID and ATTRIBUTE_OPTION_ID codes, follow these steps:

1. Log in to your Uptempo instance. Click on Activities in the navigation menu.

   The Activities section opens to the Timeline.

2. In the Timeline, click Filter.

   The Filter by menu opens:

   
   
   

3. In the Select Attribute menu, select the attribute for which you want to find the ATTRIBUTE_DEFINITION_ID.

4. In the Select Condition menu, select the condition is.

5. In the Set a value menu, select the attribute for which you want to find the ATTRIBUTE_OPTION_ID.

6. Click Apply.

   The Filter by menu closes, and the Activities page refreshes.

7. In the browser URL bar, find the query string parameter beginning with filter=:

   

8. The value of this parameter provides the IDs for the selected attribute definition and attribute option:

   • The value will have the format tgXXX-tXXX-aYYY~IS~ZZZ, where:

     • YYY is a numeric string representing the ATTRIBUTE_DEFINITION_ID (denoted by the prefix a)

     • ZZZ is a numeric string representing the ATTRIBUTE_OPTION_ID

     • You can ignore the tgXXX and tXXX values

   • Note that IDs are numeric only — do not include the a prefix.