The patch group endpoint selectively modifies the attributes of the group indicated by the ID parameter. You can add or remove the value for the following attribute:

members – The users inside the group.

SCIM RFC compliance

This endpoint fully complies with the SCIM RFC as it relates to the supported schema.

API payload

{  
    "schemas": [  
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"  
    ],  
    "Operations": \[  
        {  
            "name": "addMember",  
            "op": "add",  
            "path": "members",  
            "value": [  
              {  
              "displayName":"new user",  
              "value":"{{user-id}}"  
              }  
            ]              
      },  
        {  
            "op": "remove",  
          "path": "members[value eq \"{{user-id}}\"]"  
        }  
    ]  
}

Other flavors of the payload are supported as well. For example, a replace operation without a path where the value implies the attribute path and its value.

Error conditions

404 (Not Found) – A group with the specified ID is not found.
400 (Bad Request) – The patch operation syntax is invalid, or Opti ID does not support the patch operation.

200The modified group.

400The request was invalid or cannot be otherwise served. An accompanying error message will explain further.

404The requested resource was not found.

500A server error occurred, please try again