Role data for authorization configuration

This page provides information for creating role data files, that is, payload JSON files that you can submit when you configure role authorizations.

The following code sample shows the available objects that you can include within such a file. The rest of this page provides details about each of these objects and their properties.

{
    "Name": "AdminRole",
    "Description": "Administration role",   
    "AllowedJobs": {
        "Included": [
           [["FileName", "like", "a*"], ["JobType", "eq", "Job,Command"]],
           [["FileName", "like", "b*"], ["JobType", "eq", "Job,Command"]]
        ],
        "Excluded": [
           [["FileName", "like", "c*"], ["JobType", "eq", "Job,Command"]],
           [["FileName", "like", "d*"], ["JobType", "eq", "Job,Command"]]
        ]
    },
    "AllowedJobActions": {
        "ViewProperties": true,
        "SetToOk": true,
        "Documentation": true,
        "Confirm": true,
        "Log": true
    },
    "Privileges": {
        "ClientAccess": {
           "WorkloadChangeManagerAccess": "Full",
           "ApplicationIntegratorAccess": "None"
           },
        "ConfigurationManager": {
           "Authorization": "Browse",
           "ControlmSecurity": "Update"
           }   
    },
    "Folders": [{
        "Privilege": "Full",
        "ControlmServer":  "aaa*",
        "Library": "bbb*",
        "Folder": "ccc*",
        "Order": true,
        "Jobs": {
            "Privilege": "Full",
            "Application": "aaa*",
            "SubApplication": "bbb*"
        }
    }],
    "Calendars": [{
        "Privilege": "Full",
        "ControlmServer": "aaa*",
        "Name": "bbb*"
    }],
    "RunasUsers": [{
        "ControlmServer": "aaa*",
        "RunasUser": "aaa*",
        "Host": "bbb*"
    }],
    "WorkloadPolicies": [{
        "Privilege": "Full",
        "Name": "*"
    }],
    "SiteStandard": [{
        "Privilege": "Full",
        "Name": "*"
    }],
    "SiteCustomization": [{
        "Privilege": "Full",
        "Name": "*"
    }],
    "Services": [{
        "Privilege": "Full",
        "Name": "*",
        "AllowedActions":
            {"DrillDown": true,
            "Run": true,
            "Hold": true,
            "Resume": true,
            "ViewOrderableService": true}
    }],
    "Events": [{
        "Privilege": "Full",
        "ControlmServer": "aaa*",
        "Name": "*"
    }],
    "Mutexes": [{
        "Privilege": "Full",
        "ControlmServer": "aaa*",
        "Name": "*"
    }],
    "Semaphores": [{
        "Privilege": "Full",
        "ControlmServer": "aaa*",
        "Name": "*"
    }],
    "GlobalEvents": [{
        "Privilege": "Full",
        "Name": "*"
    }]
}

General role settings

The role file contains the following general properties for the role that you are defining:

For example:

    "Name": "AdminRole",
    "Description": "Administration role",

AllowedJobs

Grants the role browse access to the output of jobs that you specify using include/exclude filters.

    "AllowedJobs": {
        "Included": [
           [["FileName", "like", "a*"], ["JobType", "eq", "Job,Command"]],
           [["FileName", "like", "b*"], ["JobType", "eq", "job,command"}],
        ]
        "Excluded": [
           [["FileName", "like", "c*"], ["JobType", "eq", "Job,Command"]],
           [["FileName", "like", "d*"], ["JobType", "eq", "Job,Command"}],
        ]
    }

Under the AllowedJobs object, you define job authorizations:

• The Included object lists filters for jobs that the role is authorized to access.
• The Excluded object lists filters for jobs that the role is NOT authorized to access.

In each of these lists, you can include one or more filters. An implied OR logical operator connects between the various filters.

Each filter can include multiple conditions, with an implied AND logical operator connecting between the conditions. A condition is a pattern-matching expression that detects jobs according to a specific job property. A condition has the following format:

["jobProperty", "operator", "value"]

The following table provides guidelines for specifying the various elements within the filter condition:

AllowedJobActions

Authorizes the role to perform specific actions (browse actions, control actions, or update actions) on the jobs filtered through the AllowedJobs object and the folders specified through the Folders object.

    "AllowedJobActions": {
        "ViewProperties": true,
        "SetToOk": true, 
        "Documentation": true, 
        "Confirm": true,
        "Log": true 
    }

Under the AllowedJobsActions object, you define which job actions the role is authorized to perform. Each action is set to either true (allowed) or false (not allowed). The default is false.

The following table lists all available job actions. For your convenience, the actions in this table are divided into three categories — Browse actions, Control actions, and Update actions.

Privileges

Grants the role access to various Control-M components, utilities, and tools, and authorizes the role to perform actions through these tools based on the defined access levels.

    "Privileges": {
        "ClientAccess" {
           "ConfigurationManagerAccess": "Full",
           "ApplicationIntegratorAccess": "None",
	       },
        "ConfigurationManager" {
		   "Authorization": "Browse",
		   "ControlmSecurity": "Update",
           } 	
    }

Under the Privileges object, various Control-M features and capabilities are categorized and grouped together under the following next-level objects:

• ClientAccess
• ConfigurationManager
• Monitoring
• Planning
• Tools
• ViewpointManager

The following table lists all the Control-M features and capabilities in these categories, and provides details of the authorization levels that are available for each feature. The default authorization for all features is None.

Folders

Grants the role access to specific folders, along with an authorization level for each folder. Also enables you to grant different authorizations per job within a specific folder based on Application or Sub Application criteria.

    "Folders": [{
        "Privilege": "Full", 
        "ControlmServer":  "aaa*",
        "Library": "bbb*",
        "Folder": "ccc*",
        "Order": true,
        "Jobs": {
            "Privilege": "Full",
            "Application": "aaa*",
            "SubApplication": "bbb*"
        },
    }]

The Folders object has the following properties:

For properties that support multiple values (ControlmServer, Library, Folder, Application, and SubApplication), you can use commas (,) or wildcards (such as * or ?). For more information, see Pattern matching strings in the Control-M Online Help.

Calendars

Associates specific calendars in Control-M with the role, along with an authorization level for each calendar.

    "Calendars": [{
        "Privilege": "Full",
        "ControlmServer": "aaa*", 
        "Name": "bbb*"
    }]

The Calendars object has the following properties:

For properties that support multiple values (ControlmServer and Name), you can use commas (,) or wildcards (such as * or ?). For more information, see Pattern matching strings in the Control-M Online Help.

RunasUsers

Associates "run as" users with the role, for running jobs on a Control-M/Agent.

Note: For a role's RunasUser definitions to take effect on jobs in a folder, the same role must be granted sufficient folder privileges — either Full or Update privileges must be granted to the relevant folders.

    "RunasUsers": [{
        "ControlmServer": "aaa*",
        "RunasUser": "aaa*",
        "Host": "bbb*"
    }]

The RunasUsers object has the following properties:

You must define at least one of these properties. Once one property is defined, the implied value for any other undefined property is "*".

For multiple values in any of these properties, you can use commas (,) or wildcards (such as * or ?).

You might also want to specify values to be excluded. For example, to exclude user names root or Oracle, you can specify the following string:
"RunasUser": "!(root|Oracle)"

For more information, see Pattern matching strings in the Control-M Online Help.

WorkloadPolicies

Associates specific Workload Policies in Control-M with the role, along with an authorization level for each Workload Policy.

Workload policies are groups of jobs that you define for the purpose of balancing the workload and limiting resources used by jobs.

    "WorkloadPolicies": [{
        "Privilege": "Full",
        "Name": "*"
    }]

The WorkloadPolicies object has the following properties. All parameters are required.

SiteStandard

Associates specific Site Standards with the role, along with an authorization level for each one.

Site Standards are collections of settings that are applied to folders and jobs to ensure that web users follow organization standards.

    "SiteStandard": [{
        "Privilege": "Full",
        "Name": "*"
    }]

The SiteStandard object has the following properties. All parameters are required.

SiteCustomization

Associates specific Site Customizations with the role, along with an authorization level for each one.

Site Customizations are collections of settings that are applied to jobs to limit web users' access to job properties or to restrict the types of jobs that web users can create.

    "SiteCustomization": [{
        "Privilege": "Full",
        "Name": "*"
    }]

The SiteCustomization object has the following properties. All parameters are required.

Services

Grants the role authorization to view services and to perform job actions, order, hold, and release services.

A service is a group of jobs that are aggregated based on various job filtering criteria.

    "Services": [{
        "Privilege": "Full",
        "Name": "*",
        "AllowedActions":
            {"DrillDown": true, 
            "Run": true, 
            "Hold": true, 
            "Resume": true, 
            "ViewOrderableService": true}
    }]

The Services object has the following properties:

Events

Grants the role authorization to manage events, by associating specific events with the role and assigning an authorization level to each one.

    "Events": [{
        "Privilege": "Full",
        "ControlmServer": "aaa*",
        "Name": "*"
    }]

The Events object has the following properties:

For properties that support multiple values (ControlmServer and Name), you can use commas (,) or wildcards (such as * or ?). For more information, see Pattern matching strings in the Control-M Online Help.

Mutexes

Grants the role authorization to manage mutexes (also known as control resources), by associating specific mutexes with the role and assigning an authorization level to each one.

    "Mutexes": [{
        "Privilege": "Full",
        "ControlmServer": "aaa*",
        "Name": "*"
    }]

The Mutexes object has the following properties:

For properties that support multiple values (ControlmServer and Name), you can use commas (,) or wildcards (such as * or ?). For more information, see Pattern matching strings in the Control-M Online Help.

Semaphores

Grants the role authorization to manage semaphores (also known as quantitative resources), by associating specific semaphores with the role and assigning an authorization level to each one.

    "Semaphores": [{
        "Privilege": "Full",
        "ControlmServer": "aaa*",
        "Name": "*"
    }]

The Semaphores object has the following properties:

For properties that support multiple values (ControlmServer and Name), you can use commas (,) or wildcards (such as * or ?). For more information, see Pattern matching strings in the Control-M Online Help.

GlobalEvents

Grant the role authorization to manage global events, by associating specific global events with the role and assigning an authorization level to each one.

    "GlobalEvents": [{
        "Privilege": "Full",
        "Name": "*",
    }]

The GlobalEvents object has the following properties. All parameters are required.