Partially Updating a Group_SCIM Group Management_API_API Reference

Function

This API is used to update some attributes of an existing group and manage users in the group.

URI

PATCH /{tenant_id}/scim/v2/Groups/{group_id}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Globally unique ID of a tenant
group_id	Yes	String	Globally unique ID of a group

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Bearer token

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
schemas	Yes	Array of strings	Summary
Operations	Yes	Array of objects	List of the updates to be performed

**Table 4** Operations
Parameter	Mandatory	Type	Description
op	Yes	String	Update type. add: add an attribute; replace: replace an attribute; remove: remove an attribute.
value	No	Object	Attribute value to be updated
path	No	String	Attribute path to be updated. Only the following attributes of a group can be modified: displayName, members, and externalId.

Response Parameters

Status code: 400

**Table 5** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 403

**Table 6** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 404

**Table 7** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 409

**Table 8** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 500

**Table 9** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Example Request

Updating some attributes of a group

PATCH https://{hostname}/{tenant_id}/scim/v2/Groups/{group_id}

{
  "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ],
  "Operations" : [ {
    "op" : "replace",
    "value" : {
      "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
      "displayName" : "Update display name"
    }
  }, {
    "op" : "add",
    "path" : "members",
    "value" : [ {
      "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9"
    } ]
  }, {
    "op" : "replace",
    "path" : "members",
    "value" : [ {
      "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9"
    }, {
      "value" : "1bdaa75c-7aaf-3aa2-7aac-6a00aaaa335f"
    } ]
  }, {
    "op" : "remove",
    "path" : "members",
    "value" : [ {
      "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9"
    }, {
      "value" : "1bdaa75c-7aaf-3aa2-7aac-6a00aaaa335f"
    } ]
  } ]
}

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Partially Updating a Group