BAballerina-platform
Groups Endpoint

Update Group - PUT

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

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

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

put/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

displayNamestring
membersobject[]

Example request

{
  "displayName": "manager",
  "members": [
    {
      "value": "409ca90b-2ba6-4474-9a45-2cf7376e6e43",
      "display": "kris"
    }
  ]
}

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",
  "members": [
    {
      "display": "kris",
      "value": "409ca90b-2ba6-4474-9a45-2cf7376e6e43"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.