PatchSCIMGroup
Applicable editions | Central edition, Region edition |
Service Endpoint and Authorization
- Get a Service Endpoint: Replace {domain} in the API request syntax.
- Get a Personal Access Token。
- Get organizationId:Required only for the Central edition. Go to Organization Management console's Basic Information page to obtain the organization ID.
Product | Resource | Required Permission |
Organization Management | SCIM | Read and write |
Request Syntax
Central edition
PATCH https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Groups/{id}Region edition
PATCH https://{domain}/oapi/v1/platform/scim/v2/Groups/{id}Request Headers
Parameter | Type | Required | Description | Example Value |
x-yunxiao-token | string | Yes | Personal access token. | pt-0fh3****0fbG_35af****0484 |
Request Parameters #1
Parameter | Type | Location | Required | Description | Example Value |
organizationId | string | path | Yes | Organization ID. | |
id | string | path | Yes | SCIM resource ID. | |
| - | object | body | No | ||
| Operations | array | body | Yes | ||
| - | object | body | No | ||
| op | string | body | Yes | Valid values: [add remove replace]. | add |
| path | string | body | No | ||
| value | body | No | |||
| schemas | array[string] | body | Yes |
Request Parameters #2
Parameter | Type | Location | Required | Description | Example Value |
organizationId | string | path | Yes | Organization ID | |
id | string | path | Yes | SCIM resource ID | |
| - | object | body | No | ||
| Operations | array | body | Yes | ||
| - | object | body | No | ||
| op | string | body | Yes | Valid values: [add remove replace] | add |
| path | string | body | No | ||
| value | body | No | |||
| schemas | array[string] | body | Yes |
Request Example #1
Central edition
curl -X 'PATCH' \
'https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Groups/{id}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"Operations": [
{
"op": "add",
"path": "",
"value":
}
],
"schemas": [
]
}'Region edition
curl -X 'PATCH' \
'https://{domain}/oapi/v1/platform/scim/v2/Groups/{id}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"Operations": [
{
"op": "add",
"path": "",
"value":
}
],
"schemas": [
]
}'Request Example #2
Central edition
curl -X 'PATCH' \
'https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Groups/{id}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"Operations": [
{
"op": "add",
"path": "",
"value":
}
],
"schemas": [
]
}'Region edition
curl -X 'PATCH' \
'https://{domain}/oapi/v1/platform/scim/v2/Groups/{id}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"Operations": [
{
"op": "add",
"path": "",
"value":
}
],
"schemas": [
]
}'Response Parameters
Parameter | Type | Description | Example Value |
| - | object | ||
| displayName | string | ||
| externalId | string | ||
| id | string | ||
| members | array | ||
| - | object | ||
| $ref | string | ||
| display | string | ||
| type | string | ||
| value | string | ||
| meta | object | ||
| created | string | ||
| lastModified | string | ||
| location | string | ||
| resourceType | string | ||
| version | string | ||
| schemas | array[string] | ||
| urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group | object | ||
| parentExternalId | string | ||
| parentId | string | ||
| path | string |
Response Example
{
"displayName": "",
"externalId": "",
"id": "",
"members": [
{
"$ref": "",
"display": "",
"type": "",
"value": ""
}
],
"meta": {
"created": "",
"lastModified": "",
"location": "",
"resourceType": "",
"version": ""
},
"schemas": [
],
"urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group": {
"parentExternalId": "",
"parentId": "",
"path": ""
}
}Error Codes
VisitError Code Center to view API-related error codes.