Sign in
OpenAPI 3.0.42026-08-138121,1193.1 MB

ece7c5a315e7

Groups

Updates existing group roleset.

patch/v1/groups/{groupId}/rolesets/{rolesetId}

Path parameters

groupIdinteger required

The group Id.

rolesetIdinteger required

The roleset Id.

Request body

namestring

The name of the roleset.

descriptionstring

The description of the roleset.

rankinteger

The rank/positioning of the roleset.

colorinteger

Optional. The color of the roleset (GroupRoleSetColorType value, e.g. 0 = Invalid, 1 = Blue). When omitted, only name and description are updated and the existing color is left unchanged. When set, name, description, and color are updated via UpdateGroupRoleSetProperties.

Response

OK

idinteger

The role id

namestring

The role name

descriptionstring

The role description

rankinteger

The role rank

memberCountinteger

The number of members in the role.

isBaseboolean

Whether or not the role is the base role for the group

color0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16

The role color. ['Invalid' = 0, 'Blue' = 1, 'Green' = 2, 'Purple' = 3, 'Yellow' = 4, 'Orange' = 5, 'Red' = 6, 'Magenta' = 7, 'Teal' = 8, 'Turquoise' = 9, 'Rust' = 10, 'Pistachio' = 11, 'Midnight' = 12, 'Lavender' = 13, 'Pink' = 14, 'Crimson' = 15, 'Plum' = 16]