Patch Group
Patch an existing group by ID
This endpoint is responsible for patching a group. For more information, check the specification: https://tools.ietf.org/html/rfc7644#section-3.5.2.
Request
URI
PATCH
https://{api_host}/usergroup/t/{tenant}/scim/v2/Groups/{id}
COPY
Path Parameters
string
id
Required
The ID of the group
string
tenant
Required
The VMware Identity Services tenant ID
tenant example
my-tenantRequest Body
PatchRequestMedia
of type(s)
application/scim+json
Required
Show optional properties
{
"Operations": [
{
"op": "add"
}
]
}{
"Operations": [
{
"value": "India",
"path": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:country",
"op": "add"
}
],
"id": "string",
"meta": {
"location": "string",
"version": "string",
"lastModified": "string",
"resourceType": "string",
"created": "string"
},
"externalId": "string",
"schemas": [
"string"
]
}
array of
object
Operations
Required
Operations for SCIM 2 patch request
string
id
Optional
The unique identifier of the SCIM resource
object
meta
Optional
The meta information of the resource
string
externalId
Optional
The SCIM resource external identifier
array of
string
schemas
Optional
The SCIM resource schema URIs
Responses
200
The group was successfully updated.
Returns
GroupMedia
of type(s)
application/scim+json
{
"members": [
{
"value": "42dc6b2c-4517-4e88-b1a7-79a1a1f88b5b",
"$ref": "https://example.com/v2/User/42dc6b2c-4517-4e88-b1a7-79a1a1f88b5b",
"display": "Example User"
}
],
"displayName": "Example Group",
"id": "string",
"meta": {
"location": "string",
"version": "string",
"lastModified": "string",
"resourceType": "string",
"created": "string"
},
"externalId": "string",
"schemas": [
"string"
]
}
400
The request contains invalid information.
Operation doesn't return any data structure
404
The group was not found.
Operation doesn't return any data structure
409
The specified version number does not match the resource's latest version number, or a service provider refused to create a new, duplicate resource.
Operation doesn't return any data structure
Code Samples
COPY
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/scim+json' -d '{"Operations":["object"]}'