Patch Patch Group

Patch Patch Group

Updates group's information. The group id is a unique internal identifier and can be retrieved using the search API /scim/Groups?filter=... Patch operation allows to send in the request only attributes that need to be changed.

Request
URI
PATCH
https://{api_host}/SAAS/jersey/manager/api/scim/Groups/{id}
COPY
Path Parameters
string
id
Required

the id of the group to update

id example
d24afa39-05a1-433f-8aa9-ad41c9a3d394
Request Body

the group resource updated information as a JSON string

SdkGroupResource of type(s) application/json
Required 
{
    "displayName": "string",
    "resourceDescriptor": {
        "endpoint": "string",
        "description": "string",
        "name": "string",
        "attributeSchemas": [
            "string"
        ],
        "strictMode": false,
        "scimObject": {
            "schemas": [
                "string"
            ]
        },
        "meta": {
            "lastModified": "string",
            "version": "string",
            "location": "string",
            "created": "string"
        },
        "externalId": "string",
        "attributes": [
            {
                "subAttributes": [
                    "AttributeDescriptor Object"
                ],
                "description": "string",
                "canonicalValues": [
                    {
                        "operation": "string",
                        "type": "string",
                        "primary": false,
                        "value": "string",
                        "display": "string"
                    }
                ],
                "dataType": "string",
                "required": false,
                "caseExact": false,
                "name": "string",
                "readOnly": false,
                "multiValuedChildName": "string",
                "multiValued": false,
                "schema": "string"
            }
        ],
        "schema": "string",
        "id": "string",
        "resourceDescriptor": "ResourceDescriptor Object"
    },
    "urn:scim:schemas:extension:workspace:1.0": {
        "distinguishedName": "CN=all-admin-users,CN=Users,DC=acme,DC=com",
        "internalGroupType": "EXTERNAL",
        "domain": "acme.com",
        "description": "The group for all admin users",
        "compositionRules": "{\n  \"addedUserIds\" : [ ],\n  \"excludedUserIds\" : [ ],\n  \"rule\" : {\n    \"type\" : \"internalGroup\",\n    \"groupId\" : \"53cc45f9-2e21-4fa4-ae81-32e6fb15bd91\"\n  }\n}",
        "userStoreUuid": "acme.com",
        "parents": [
            {
                "operation": "string",
                "type": "string",
                "primary": false,
                "value": "string",
                "display": "string"
            }
        ],
        "compositionRulesV2": false,
        "email": "[email protected]"
    },
    "scimObject": {
        "schemas": [
            "string"
        ]
    },
    "meta": {
        "lastModified": "string",
        "version": "string",
        "location": "string",
        "created": "string"
    },
    "externalId": "string",
    "members": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "id": "string",
    "schemas": [
        "string"
    ]
}
string
displayName
Optional

displayName

object
resourceDescriptor
Optional

resourceDescriptor

object
urn:scim:schemas:extension:workspace:1.0
Optional

urn:scim:schemas:extension:workspace:1.0

object
scimObject
Optional

scimObject

object
meta
Optional

meta

string
externalId
Optional

externalId

array of object
members
Optional

members

string
id
Optional

id

array of string
schemas
Optional

The set of schemas that are currently contributing attributes to this group

Authentication
This operation uses the following authentication methods.
Responses
400

The supplied JSON is incorrect

Operation doesn't return any data structure

500

An unexpected error occurred

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Scim Operations
POST
Post Post User
GET
Get Get Users
POST
Post Find Users
GET
Get Get User
DELETE
Delete Delete User
PATCH
Patch Patch User
POST
Post Find Groups
GET
Get Get Role
PATCH
Patch Patch Role
GET
Get Get Roles
GET
Get Get Schemas
GET
Get Get Group
DELETE
Delete Delete Group
PATCH
Patch Patch Group
POST
Post Post Group
GET
Get Get Groups