Admin Role View

Used when creating or updating an admin role to a user. Admin roles enable you to define a unique set of capabilities for each set of organizations. Capabilities and controlled organizations can be assigned directly or indirectly through roles.

One or more admin roles can be assigned to a single user and one or more users can be assigned the same admin role.

Table 3–18 Top-Level Attributes of Admin Role View

Name	Editable?	Type	Required?
id	Read/Write	String	No
name	Read/Write	String	Yes
capabilities		List	Yes
capabilitiesRule		String	Yes
controlledOrganizations		List	Yes
controlledOrganizationsRule		String	Yes
controlledOrganizationsUserform		String	Yes
controlledSubOrganizations		List (object)	No
memberObjectGroup		List	Yes

id

Uniquely identifies the AdminRole object in Waveset. System-generated.

name

Specifies the name of the admin role.

capabilities

Identifies the list of capability names that are assigned to this admin role.

capabilitiesRule

Specifies the name of the rule to be evaluated that will return a list of zero or more capability names to be assigned.

controlledOrganizations

Lists organization names over which the associated capabilities are allowed.

controlledOrganizationsRule

Specifies the name of the rule to be evaluated. This rule will return a list of zero of more controlled organizations names to be assigned.

controlledOrganizationsUserform

Specifies the userform that will be used when editing or creating users in the scope of organizations controlled by this admin role. Valid if the userform is not directly assigned to the user that is assigned this Admin role.

controlledSubOrganizations

Lists the controlled organizations for which a subset of the objects available has been either included or excluded. The value of this attribute consists of a list of controlledSubOrganization objects. Each ControlledOrganization object view is as follows.

Table 3–19 controlledSubOrganizations View Attributes (Admin Role view)

Attribute	Data Type	Required?
name	String (name of controlled object group)
types	List (objects)

types is a list of objects, where the list of objects to include or exclude are organized by type (for example, Resource, Role, and Policy). The view for each object type is as follows:

Table 3–20 controlledSubOrganizations View Attribute Object Types (Admin Role view)

Attribute	Data Type	Required?
name	String
include	List (objects)
exclude	List (objects)

name

Specifies the name of the object type.

include

Lists object names of the associated object type to include.

exclude

Lists object names of the associated type to exclude.

memberObjectGroup

Lists the ObjectGroups of which this Admin role is a member. These are the object groups (organizations) that this Admin role is available to.