Put Group

Put Group

This endpoint is responsible for updating a group. For more information, check the specification: https://tools.ietf.org/html/rfc7644#section-3.5.1.

Request
URI
PUT
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-tenant
Request Body
GroupMedia of type(s) application/scim+json
Required 
{
    "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",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}
array of GroupMemberMedia
members
Optional

A list of members of the group

string
displayName
Required

A human-readable name for the group

string
id
Optional

The unique identifier of the SCIM resource

string
externalId
Optional

The SCIM resource external identifier

MetaMedia
meta
Optional

meta

array of string
schemas
Optional

The SCIM resource schema URIs

Authentication
This operation uses the following authentication methods.
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",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}
array of GroupMemberMedia
members
Optional

A list of members of the group

string
displayName
Required

A human-readable name for the group

string
id
Optional

The unique identifier of the SCIM resource

string
externalId
Optional

The SCIM resource external identifier

MetaMedia
meta
Optional

meta

array of string
schemas
Optional

The SCIM resource schema URIs


400

The request contains invalid information.

Operation doesn't return any data structure

403

Forbidden to update specific group.

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

On This Page
Scim2 Operations
POST
Create Group
DELETE
Delete Group
GET
Get Group
PATCH
Patch Group
POST
Post Groups Search
PUT
Put Group
GET
Search Groups