Skip to main content

Patch a Governance Group

PATCH 

/workgroups/:id

This API updates an existing governance group by ID. The following fields and objects are patchable:

  • name
  • description
  • owner

A token with API or ORG_ADMIN authority is required to call this API.

Request

Path Parameters

    id stringrequired

    ID of the Governance Group

    Example: 2c9180837ca6693d017ca8d097500149

Body

array
  • Array [
  • op stringrequired

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

    path stringrequired

    A string JSON Pointer representing the target path to an element to be affected by the operation

    value object

    The value to be used for the operation, required for "add" and "replace" operations

    oneOf

    string

  • ]

Responses

A Governance Group.

Schema
    owner object

    Owner's identity.

    type string

    Possible values: [IDENTITY]

    Owner's DTO type.

    id string

    Owner's identity ID.

    name string

    Owner's display name.

    id string

    Governance group ID.

    name string

    Governance group name.

    description string

    Governance group description.

    memberCount int64

    Number of members in the governance group.

    connectionCount int64

    Number of connections in the governance group.

Loading...