UpdateSCIMUser - 全量更新 SCIM 用户

更新时间:
复制 MD 格式

适用版本

中心版、Region版

服务接入点与授权信息

产品

资源

所需权限

组织管理

SCIM

读写

请求语法

中心版

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

Region版

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

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

是

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数 #1

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

是

组织 ID。

id

string

path

是

SCIM 资源 ID。

-

object

body

否

active

boolean

body

否

displayName

string

body

否

emails

array

body

否

-

object

body

否

primary

boolean

body

否

type

string

body

否

value

string

body

否

externalId

string

body

否

groups

array

body

否

-

object

body

否

$ref

string

body

否

display

string

body

否

value

string

body

否

id

string

body

否

meta

object

body

否

created

string

body

否

lastModified

string

body

否

location

string

body

否

resourceType

string

body

否

version

string

body

否

name

object

body

否

familyName

string

body

否

formatted

string

body

否

givenName

string

body

否

honorificPrefix

string

body

否

honorificSuffix

string

body

否

middleName

string

body

否

nickName

string

body

否

phoneNumbers

array

body

否

-

object

body

否

type

string

body

否

value

string

body

否

schemas

array[string]

body

是

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object

body

否

costCenter

string

body

否

department

string

body

否

division

string

body

否

employeeNumber

string

body

否

organization

string

body

否

userName

string

body

是

请求参数 #2

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

是

组织 ID

id

string

path

是

SCIM 资源 ID

-

object

body

否

active

boolean

body

否

displayName

string

body

否

emails

array

body

否

-

object

body

否

primary

boolean

body

否

type

string

body

否

value

string

body

否

externalId

string

body

否

groups

array

body

否

-

object

body

否

$ref

string

body

否

display

string

body

否

value

string

body

否

id

string

body

否

meta

object

body

否

created

string

body

否

lastModified

string

body

否

location

string

body

否

resourceType

string

body

否

version

string

body

否

name

object

body

否

familyName

string

body

否

formatted

string

body

否

givenName

string

body

否

honorificPrefix

string

body

否

honorificSuffix

string

body

否

middleName

string

body

否

nickName

string

body

否

phoneNumbers

array

body

否

-

object

body

否

type

string

body

否

value

string

body

否

schemas

array[string]

body

是

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object

body

否

costCenter

string

body

否

department

string

body

否

division

string

body

否

employeeNumber

string

body

否

organization

string

body

否

userName

string

body

是

请求示例 #1

中心版

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版

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": ""
    }'

请求示例 #2

中心版

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版

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": ""
    }'

返回参数

参数

类型

描述

示例值

-

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

返回示例

{
    "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": ""
}

错误码

访问错误码中心查看 API 相关错误码。