Group

Represents a user group.

Properties

Field	Data type
`key`	`string`
`name`	`string`
`href`	`string`
`description`	`string`
`parent-groups`	`Groups`
`child-groups`	`Groups`
`users`	`Users`
`roles`	`Roles`
`properties`	`Properties`

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<group description="string" href="string" key="string" name="string">
  <parent-groups count="123">
    <group>[[[group...|]]]</group>
  </parent-groups>
  <child-groups count="123">
    <group>[[[group...|]]]</group>
  </child-groups>
  <users count="123">
    <user>[[[user...|user.html]]]</user>
  </users>
  <roles>
    <role>[[[role...|role.html]]]</role>
  </roles>
  <properties count="123" href="string">
    <property>[[[property...|property.html]]]</property>
  </properties>
</group>

{
  "child-groups" : {
    "count" : 4,
    "group" : [ "[[[group...|]]]" ]
  },
  "roles" : {
    "role" : [ "[[[role...|role.html]]]" ]
  },
  "name" : "name",
  "description" : "description",
  "href" : "href",
  "parent-groups" : {
    "count" : 4,
    "group" : [ "[[[group...|]]]" ]
  },
  "key" : "key",
  "users" : {
    "count" : 6,
    "user" : [ {
      "lastLogin" : "lastLogin",
      "roles" : {
        "role" : [ "[[[role...|role.html]]]" ]
      },
      "groups" : {
        "count" : 4,
        "group" : [ "[[[group...|]]]" ]
      },
      "hasPassword" : true,
      "password" : "password",
      "enabled2FA" : true,
      "name" : "name",
      "realm" : "realm",
      "id" : 8,
      "href" : "href",
      "locator" : "locator",
      "email" : "email",
      "properties" : {
        "count" : 1,
        "property" : [ {
          "inherited" : true,
          "name" : "name",
          "type" : "[[[type...|type.html]]]",
          "value" : "value"
        } ],
        "href" : "href"
      },
      "username" : "username",
      "avatars" : {
        "urlToSize80" : "urlToSize80",
        "urlToSize28" : "urlToSize28",
        "urlToSize40" : "urlToSize40",
        "urlToSize32" : "urlToSize32",
        "urlToSize20" : "urlToSize20",
        "urlToSize64" : "urlToSize64",
        "urlToSize56" : "urlToSize56"
      }
    } ]
  },
  "properties" : {
    "count" : 1,
    "property" : [ {
      "inherited" : true,
      "name" : "name",
      "type" : "[[[type...|type.html]]]",
      "value" : "value"
    } ],
    "href" : "href"
  }
}

Last modified: 04 July 2024