# ApiRoleConfigGroup Data Model

A role config group contains roles of the same role type sharing the same configuration. While each role has to belong to a group, a role config group may be empty. There exists a default role config group for each role type. Default groups cannot be removed nor created. The name of a role config group is unique and cannot be changed. The configuration of individual roles may be overridden on role level.

Properties
name | data type | description
--- | --- | ---
name | string | Readonly. The unique name of this role config group.
roleType | string | Readonly. The type of the roles in this group.
base | boolean | Readonly. Indicates whether this is a base group.
config | ApiConfigList | The configuration for this group. Optional.
displayName | string | The display name of this group.
serviceRef | ApiServiceRef | Readonly. The service reference (service name and cluster name) of this group.

Example

    {
      "name" : "...",
      "roleType" : "...",
      "base" : true,
      "config" : {
        "items" : [ {
          "name" : "...",
          "value" : "...",
          "required" : true,
          "default" : "...",
          "displayName" : "...",
          "description" : "...",
          "relatedName" : "...",
          "sensitive" : true,
          "validationState" : "OK",
          "validationMessage" : "...",
          "validationWarningsSuppressed" : true
        }, {
          "name" : "...",
          "value" : "...",
          "required" : true,
          "default" : "...",
          "displayName" : "...",
          "description" : "...",
          "relatedName" : "...",
          "sensitive" : true,
          "validationState" : "OK",
          "validationMessage" : "...",
          "validationWarningsSuppressed" : true
        } ]
      },
      "displayName" : "...",
      "serviceRef" : {
        "peerName" : "...",
        "clusterName" : "...",
        "clusterDisplayName" : "...",
        "serviceName" : "...",
        "serviceDisplayName" : "...",
        "serviceType" : "..."
      }
    }