Update a group

PATCH

/scim/v2/Groups/:groupId

PATCH

/scim/v2/Groups/:groupId

$ curl -X PATCH https://api.getpostman.com/scim/v2/Groups/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "schemas": [
>     "urn:ietf:params:scim:api:messages:2.0:PatchOp"
>   ],
>   "Operations": [
>     {
>       "op": "replace",
>       "value": {
>         "id": "561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00",
>         "displayName": "TestAPI"
>       }
>     }
>   ]
> }'

1 {
2   "schemas": [
3     "urn:ietf:params:scim:schemas:core:2.0:Group"
4   ],
5   "id": "405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
6   "displayName": "TestAPI",
7   "externalId": "1234",
8   "meta": {
9     "resourceType": "Group",
10     "created": "2022-02-22T04:24:13.000Z",
11     "lastModified": "2022-02-22T04:24:13.000Z"
12   },
13   "members": [
14     {
15       "display": "Taylor Lee",
16       "value": "23a35c2723d34c03b4c56443c09e7173"
17     }
18   ]
19 }

Updates a group’s information. Using this endpoint you can:

Update a group’s name.
Add or remove members from a Postman group.

Updates a group's information. Using this endpoint you can: - Update a group's name. - Add or remove members from a Postman group.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

groupIdstringRequired

The group's ID.

Request

This endpoint expects an object.

schemaslist of stringsOptional

The SCIM schema URI.

Operationslist of objectsOptional

Information about the group update operation.

Response

Successful Response

schemaslist of strings

The SCIM schema URI.

idstring

The group's ID.

displayNamestring

The group's name.

externalIdstring

The group's external ID.

metaobject

The response’s non-standard meta information.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error