BAballerina-platform
Groups Endpoint

Update Group - PATCH

Changed on

This API updates the group details and returns the updated group details using a PATCH operation.

  • <b>Scope(Permission) required:</b> internal_group_mgt_update

  • <b>Flow type:</b> Client Credentials OAuth Flow

patch/Groups/{id}

Request

Path parameters

idstring required

Unique id of the resource type.

Query parameters

attributesstring

SCIM defined attributes parameter.

excludedAttributesstring

SCIM defined excludedAttribute parameter.

Request body

schemasstring[] required

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "value": {
        "members": [
          {
            "display": "kris",
            "value": "409ca90b-2ba6-4474-9a45-2cf7376e6e43"
          }
        ]
      }
    }
  ]
}

Response

Group is updated

displayNamestring
schemasstring[]
idstring
membersobject[]

Example response

{
  "displayName": "DEFAULT/manager",
  "meta": {
    "created": "2019-08-26T14:27:36.000Z",
    "location": "https://api.asgardeo.io/t/{org-name}/scim2/Groups/7bac6a86-1f21-4937-9fb1-5be4a93ef469",
    "lastModified": "2019-08-26T14:27:36.000Z",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "7bac6a86-1f21-4937-9fb1-5be4a93ef469"
}

Changes

  • 7978594f207eRevision changes
    • breaking

      the request property became required

    • breaking

      the response's property type changed from object to array for status

  • d290ee2c70fcRevision changes
    • breaking

      the response's property type changed from array to object for status

    • info

      the request property became optional