UpdateSCIMUser - Fully update a SCIM user-Alibaba Cloud DevOps(Alibaba Cloud DevOps)-阿里云帮助中心

Applicable editions

Central edition, Region edition

Service endpoints and authorization

Obtain a service endpoint: Replace {domain} in the API request syntax.
Obtain a personal access token。
Obtain organizationId: Required only for the Central edition. Go to the 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

PUT https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Users/{id}

Region edition

PUT https://{domain}/oapi/v1/platform/scim/v2/Users/{id}

Request headers

Parameter	Type	Required	Description	Example
x-yunxiao-token	string	Yes	The personal access token.	pt-0fh3**0fbG_35af**0484

Request parameters #1

Parameter	Type	Location	Required	Description	Example
organizationId	string	path	Yes	The organization ID.
id	string	path	Yes	The SCIM resource ID.
-	object	body	No
active	boolean	body	No
displayName	string	body	No
emails	array	body	No
-	object	body	No
primary	boolean	body	No
type	string	body	No
value	string	body	No
externalId	string	body	No
groups	array	body	No
-	object	body	No
$ref	string	body	No
display	string	body	No
value	string	body	No
id	string	body	No
meta	object	body	No
created	string	body	No
lastModified	string	body	No
location	string	body	No
resourceType	string	body	No
version	string	body	No
name	object	body	No
familyName	string	body	No
formatted	string	body	No
givenName	string	body	No
honorificPrefix	string	body	No
honorificSuffix	string	body	No
middleName	string	body	No
nickName	string	body	No
phoneNumbers	array	body	No
-	object	body	No
type	string	body	No
value	string	body	No
schemas	array[string]	body	Yes
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	object	body	No
costCenter	string	body	No
department	string	body	No
division	string	body	No
employeeNumber	string	body	No
organization	string	body	No
userName	string	body	Yes

Request parameters #2

Parameter	Type	Location	Required	Description	Example
organizationId	string	path	Yes	The organization ID
id	string	path	Yes	The SCIM resource ID
-	object	body	No
active	boolean	body	No
displayName	string	body	No
emails	array	body	No
-	object	body	No
primary	boolean	body	No
type	string	body	No
value	string	body	No
externalId	string	body	No
groups	array	body	No
-	object	body	No
$ref	string	body	No
display	string	body	No
value	string	body	No
id	string	body	No
meta	object	body	No
created	string	body	No
lastModified	string	body	No
location	string	body	No
resourceType	string	body	No
version	string	body	No
name	object	body	No
familyName	string	body	No
formatted	string	body	No
givenName	string	body	No
honorificPrefix	string	body	No
honorificSuffix	string	body	No
middleName	string	body	No
nickName	string	body	No
phoneNumbers	array	body	No
-	object	body	No
type	string	body	No
value	string	body	No
schemas	array[string]	body	Yes
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	object	body	No
costCenter	string	body	No
department	string	body	No
division	string	body	No
employeeNumber	string	body	No
organization	string	body	No
userName	string	body	Yes

Request example #1

Central edition

curl -X 'PUT' \
  '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 '
    {
        "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": ""
    }'

Region edition

curl -X 'PUT' \
  'https://{domain}/oapi/v1/platform/scim/v2/Users/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "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": ""
    }'

Request example #2

Central edition

curl -X 'PUT' \
  '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 '
    {
        "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": ""
    }'

Region edition

curl -X 'PUT' \
  'https://{domain}/oapi/v1/platform/scim/v2/Users/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "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": ""
    }'

Response parameters

Parameter	Type	Description	Example
-	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

Visit the Error Code Center to view API error codes.