Type Alias GroupPatch

A JSON Patch document.

type GroupPatch = {
    op: "replace";
    path: "assignedRoles" | "name" | "description";
    value: AssignedRolesRefIDs | AssignedRolesRefNames | string;
}

Index

Properties

Properties

op

op: "replace"

The operation to be performed. Currently "replace" is the only supported operation.

path

path: "assignedRoles" | "name" | "description"

Attribute name of a field of the Groups entity. "Name" and "description" is only available for custom groups.

value

value: AssignedRolesRefIDs | AssignedRolesRefNames | string

The roles to assign to the group (limit of 100 roles per group) or the new custom group name or description.