Add a new user group.

POST {{baseUrl}}/app/rest/userGroups?fields=<string>

Request Params

KeyDatatypeRequiredDescription
fieldsstring

Request Body

{"key"=>"<string>", "name"=>"<string>", "href"=>"<string>", "description"=>"<string>", "parent-groups"=>{"count"=>"<integer>", "group"=>[{"key"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "href"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "description"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "parent-groups"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "child-groups"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "users"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "roles"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "properties"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"key"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "href"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "description"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "parent-groups"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "child-groups"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "users"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "roles"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "properties"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}]}, "child-groups"=>{"count"=>"<integer>", "group"=>[{"key"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "href"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "description"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "parent-groups"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "child-groups"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "users"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "roles"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "properties"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"key"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "href"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "description"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "parent-groups"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "child-groups"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "users"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "roles"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "properties"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}]}, "users"=>{"count"=>"<integer>", "user"=>[{"username"=>"<string>", "name"=>"<string>", "id"=>"<long>", "email"=>"<string>", "lastLogin"=>"<string>", "password"=>"<string>", "hasPassword"=>"<boolean>", "realm"=>"<string>", "href"=>"<string>", "properties"=>{"count"=>"<integer>", "href"=>"<string>", "property"=>[{"name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "inherited"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "inherited"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}]}, "roles"=>{"role"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "groups"=>{"count"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "group"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "locator"=>"<string>", "avatars"=>{"urlToSize20"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize28"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize32"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize40"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize56"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize64"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize80"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "enabled2FA"=>"<boolean>"}, {"username"=>"<string>", "name"=>"<string>", "id"=>"<long>", "email"=>"<string>", "lastLogin"=>"<string>", "password"=>"<string>", "hasPassword"=>"<boolean>", "realm"=>"<string>", "href"=>"<string>", "properties"=>{"count"=>"<integer>", "href"=>"<string>", "property"=>[{"name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "inherited"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "inherited"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}]}, "roles"=>{"role"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "groups"=>{"count"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "group"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "locator"=>"<string>", "avatars"=>{"urlToSize20"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize28"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize32"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize40"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize56"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize64"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "urlToSize80"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "enabled2FA"=>"<boolean>"}]}, "roles"=>{"role"=>[{"roleId"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "scope"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "href"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"roleId"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "scope"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "href"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}]}, "properties"=>{"count"=>"<integer>", "href"=>"<string>", "property"=>[{"name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "inherited"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "value"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "inherited"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}]}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;key&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;href&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;parent-groups&quot;:{&quot;count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;group&quot;:[{&quot;key&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;href&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;description&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;parent-groups&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;child-groups&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;users&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;roles&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;properties&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;key&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;href&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;description&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;parent-groups&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;child-groups&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;users&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;roles&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;properties&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}]},&quot;child-groups&quot;:{&quot;count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;group&quot;:[{&quot;key&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;href&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;description&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;parent-groups&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;child-groups&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;users&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;roles&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;properties&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;key&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;href&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;description&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;parent-groups&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;child-groups&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;users&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;roles&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;properties&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}]},&quot;users&quot;:{&quot;count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;user&quot;:[{&quot;username&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastLogin&quot;:&quot;\u003cstring\u003e&quot;,&quot;password&quot;:&quot;\u003cstring\u003e&quot;,&quot;hasPassword&quot;:&quot;\u003cboolean\u003e&quot;,&quot;realm&quot;:&quot;\u003cstring\u003e&quot;,&quot;href&quot;:&quot;\u003cstring\u003e&quot;,&quot;properties&quot;:{&quot;count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;href&quot;:&quot;\u003cstring\u003e&quot;,&quot;property&quot;:[{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;value&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;inherited&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;value&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;inherited&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}]},&quot;roles&quot;:{&quot;role&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;groups&quot;:{&quot;count&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;group&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;locator&quot;:&quot;\u003cstring\u003e&quot;,&quot;avatars&quot;:{&quot;urlToSize20&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize28&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize32&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize40&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize56&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize64&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize80&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;enabled2FA&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;username&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastLogin&quot;:&quot;\u003cstring\u003e&quot;,&quot;password&quot;:&quot;\u003cstring\u003e&quot;,&quot;hasPassword&quot;:&quot;\u003cboolean\u003e&quot;,&quot;realm&quot;:&quot;\u003cstring\u003e&quot;,&quot;href&quot;:&quot;\u003cstring\u003e&quot;,&quot;properties&quot;:{&quot;count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;href&quot;:&quot;\u003cstring\u003e&quot;,&quot;property&quot;:[{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;value&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;inherited&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;value&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;inherited&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}]},&quot;roles&quot;:{&quot;role&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;groups&quot;:{&quot;count&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;group&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;locator&quot;:&quot;\u003cstring\u003e&quot;,&quot;avatars&quot;:{&quot;urlToSize20&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize28&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize32&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize40&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize56&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize64&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;urlToSize80&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;enabled2FA&quot;:&quot;\u003cboolean\u003e&quot;}]},&quot;roles&quot;:{&quot;role&quot;:[{&quot;roleId&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;scope&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;href&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;roleId&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;scope&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;href&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}]},&quot;properties&quot;:{&quot;count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;href&quot;:&quot;\u003cstring\u003e&quot;,&quot;property&quot;:[{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;value&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;inherited&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;value&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;inherited&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}]}}