Groups - Update a group with PATCH | Webex for Developers

Update a group with PATCH

Update group attributes with PATCH.

Specify the group ID in the groupId parameter in the URI.

Authorization

OAuth token returned by Identity Broker.

One of the following OAuth scopes is required:

identity:people_rw

The following administrators can use this API:

id_full_admin
id_group_admin

Usage:

The input JSON must conform to one of the following schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
- urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
Unrecognized schemas (ID/section) are ignored.
Read-only attributes provided as input values are ignored.
Each operation on an attribute must be compatible with the attribute's mutability.
Each PATCH operation represents a single action to be applied to the same SCIM resource specified by the request URI. Operations are applied sequentially in the order they appear in the array. Each operation in the sequence is applied to the target resource; the resulting resource becomes the target of the next operation. Evaluation continues until all operations are successfully applied or until an error condition is encountered.

Add operations:

The add operation is used to add a new attribute value to an existing resource. The operation must contain a value member whose content specifies the value to be added. The value may be a quoted value, or it may be a JSON object containing the sub-attributes of the complex attribute specified in the operation's path. The result of the add operation depends upon the target location indicated by path references:

If omitted, the target location is assumed to be the resource itself. The value parameter contains a set of attributes to be added to the resource.
If the target location does not exist, the attribute and value are added.
If the target location specifies a complex attribute, a set of sub-attributes shall be specified in the value parameter.
If the target location specifies a multi-valued attribute, a new value is added to the attribute.
If the target location specifies a single-valued attribute, the existing value is replaced.
If the target location specifies an attribute that does not exist (has no value), the attribute is added with the new value.
If the target location exists, the value is replaced.
If the target location already contains the value specified, no changes should be made to the resource.

Replace operations:

The replace operation replaces the value at the target location specified by the path. The operation performs the following functions, depending on the target location specified by path:

If the path parameter is omitted, the target is assumed to be the resource itself. In this case, the value attribute shall contain a list of one or more attributes that are to be replaced.
If the target location is a single-value attribute, the value of the attribute is replaced.
If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are replaced.
If the target location path specifies an attribute that does not exist, the service provider shall treat the operation as an "add".
If the target location specifies a complex attribute, a set of sub-attributes SHALL be specified in the value parameter, which replaces any existing values or adds where an attribute did not previously exist. Sub-attributes that are not specified in the value parameters are left unchanged.
If the target location is a multi-valued attribute and a value selection ("valuePath") filter is specified that matches one or more values of the multi-valued attribute, then all matching record values will be replaced.
If the target location is a complex multi-valued attribute with a value selection filter ("valuePath") and a specific sub-attribute (e.g., "addresses[type eq "work"].streetAddress"), the matching sub-attribute of all matching records is replaced.
If the target location is a multi-valued attribute for which a value selection filter ("valuePath") has been supplied and no record match was made, the service provider will indicate the failure by returning HTTP status code 400 and a scimType error code of noTarget.

Remove operations:

The remove operation removes the value at the target location specified by the required attribute path. The operation performs the following functions, depending on the target location specified by path:

If path is unspecified, the operation fails with HTTP status code 400 and a "scimType" error code of "noTarget".
If the target location is a single-value attribute, the attribute and its associated value is removed, and the attribute will be considered unassigned.
If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are removed, and the attribute SHALL be considered unassigned.
If the target location is a multi-valued attribute and a complex filter is specified comparing a value, the values matched by the filter are removed. If no other values remain after the removal of the selected values, the multi-valued attribute will be considered unassigned.
If the target location is a complex multi-valued attribute and a complex filter is specified based on the attribute`s sub-attributes, the matching records are removed. Sub-attributes whose values have been removed will be considered unassigned. If the complex multi-valued attribute has no remaining records, the attribute will be considered unassigned.

PATCH/identity/scim/{orgId}/v2/Groups/{groupId}

URI Parameters

orgId

stringrequired

The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.

groupId

stringrequired

A unique identifier for the group.

Body Parameters

schemas

array[string]required

Input JSON schemas.

Possible values: urn:ietf:params:scim:api:messages:2.0:PatchOp

Operations

array[object]required

A list of patch operations.

enum

The operation to perform.

add

string

replace

string

remove

string

path

string

A string containing an attribute path describing the target of the operation.

Possible values: displayName

value

string

New value.

Possible values: new attribute value

Response Properties

schemas

array[string]

Input JSON schemas.

displayName

string

A human-readable name for the group.

string

A unique identifier for the group.

externalId

string

An identifier for the resource as defined by the provisioning client.

members

array[object]

A list of members of this group.

type

string

A label indicating the type of resource, for example user, machine, or group.

Possible values: user

value

string

The identifier of the member of this Group.

Possible values: c5349664-9f3d-410b-8bd3-6c31f181f13d

display

string

A human-readable name for the group member.

Possible values: A user

$ref

string

The URI corresponding to a SCIM resource that is a member of this Group.

Possible values: https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d

Response Codes

The list below describes the common success and error responses you should expect from the API.

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

PATCH

/identity/scim//v2/Groups/

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Body

schemas
arrayRequired
Input JSON schemas.
Operations
arrayRequired
A list of patch operations.

https://webexapis.com/identity/scim/e9f9ab27-0459-4cd0-bd72-089bde5a7da6/v2/Groups/cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "displayName",
      "value": "new attribute value"
    }
  ]
}

200 / OK

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
    ],
    "id": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
    "displayName": "wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com",
    "externalId": "test",
    "members": [
        {
            "value": "9836fa05-21f4-4fbc-8863-8eaf3dfbabe7",
            "type": "user",
            "$ref": "https://example.com/v2/Users/9836fa05-21f4-4fbc-8863-8eaf3dfbabe7",
            "display": "A user"
        },
        {
            "value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
            "type": "group",
            "$ref": "https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0",
            "display": "A nested group"
        }
    ],
    "meta": {
        "resourceType": "group",
        "created": "2011-08-01T21:32:44.882Z",
        "lastModified": "2011-08-01T21:32:44.882Z",
        "version": "W\/\"e180ee84f0671b1\"",
        "location": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"
    },
    "urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
        "usage": "location",
        "owners": [
            {
                "value": "bb9e77e5-91c3-4006-87c7-c18d885174c7"
            },
            {
                "value": "93e10e81-f836-434c-8e4c-8f496aeef8d5"
            }
        ],
        "managedBy": [
            {
                "orgId": "e82f0522-09b1-49fb-9fff-735fee313456",
                "type": "user",
                "id": "0f0c3024-73dc-4e1f-b4b0-f47e67c0399c",
                "role": "location_full_admin"
            },
            {
                "orgId": "cd828192-269c-4bc7-943b-273555227961",
                "type": "machine",
                "id": "4ecec95a-0493-4df0-bd1c-c97712561077",
                "role": "id_user_admin"
            }
        ],
        "provisionSource": "AD",
        "meta": {
            "organizationID": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6"
        }
    }
}