Type Alias JSONPatch

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.

type JSONPatch = {
    op: "replace" | "set" | "unset" | "add" | "renew" | "remove-value";
    path:
        | "/name"
        | "/roles"
        | "/assignedRoles"
        | "/inviteExpiry"
        | "/preferredZoneinfo"
        | "/preferredLocale"
        | "/status"
        | "/assignedGroups";
    value: | string
    | boolean
    | unknown[]
    | RefIDs
    | RefNames
    | AssignedGroupsRefNames;
}
Index

Properties

Properties

op: "replace" | "set" | "unset" | "add" | "renew" | "remove-value"

The operation to be performed. The fields set and unset are deprecated.

path:
    | "/name"
    | "/roles"
    | "/assignedRoles"
    | "/inviteExpiry"
    | "/preferredZoneinfo"
    | "/preferredLocale"
    | "/status"
    | "/assignedGroups"

A JSON Pointer. The field roles is deprecated.

value: string | boolean | unknown[] | RefIDs | RefNames | AssignedGroupsRefNames

The value to be used for this operation.