PatchSCIMUser-Alibaba Cloud DevOps(Alibaba Cloud DevOps)-阿里云帮助中心

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/Users/{id}

Region edition

PATCH https://{domain}/oapi/v1/platform/scim/v2/Users/{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/Users/{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/Users/{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/Users/{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/Users/{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
active	boolean
displayName	string
emails	array
-	object
primary	boolean
type	string
value	string
externalId	string
groups	array
-	object
$ref	string
display	string
value	string
id	string
meta	object
created	string
lastModified	string
location	string
resourceType	string
version	string
name	object
familyName	string
formatted	string
givenName	string
honorificPrefix	string
honorificSuffix	string
middleName	string
nickName	string
phoneNumbers	array
-	object
type	string
value	string
schemas	array[string]
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	object
costCenter	string
department	string
division	string
employeeNumber	string
organization	string
userName	string

Response Example

{
    "active": false,
    "displayName": "",
    "emails": [
        {
            "primary": false,
            "type": "",
            "value": ""
        }
    ],
    "externalId": "",
    "groups": [
        {
            "$ref": "",
            "display": "",
            "value": ""
        }
    ],
    "id": "",
    "meta": {
        "created": "",
        "lastModified": "",
        "location": "",
        "resourceType": "",
        "version": ""
    },
    "name": {
        "familyName": "",
        "formatted": "",
        "givenName": "",
        "honorificPrefix": "",
        "honorificSuffix": "",
        "middleName": ""
    },
    "nickName": "",
    "phoneNumbers": [
        {
            "type": "",
            "value": ""
        }
    ],
    "schemas": [
        
    ],
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "costCenter": "",
        "department": "",
        "division": "",
        "employeeNumber": "",
        "organization": ""
    },
    "userName": ""
}

Error Codes

VisitError Code Center to view API-related error codes.