产品简介

产品概述

产品优势

应用场景

购买指南

操作指南

用户管理目录

用户管理

应用管理

认证管理

审计管理

个性化设置

开发对接指南

概述

使用认证 API 接入

获取用户信息

更新用户信息

修改用户密码

重置用户密码

获取 Token

获取 JWT 公钥

刷新 Token

注销 Token

获取 OpenID Provider 配置信息

API 文档

History

Introduction

API Category

Making API Requests

User Management APIs

Data Sync APIs

Audit Management APIs

Data Types

Error Codes

常见问题

功能相关

计费相关

CIAM 政策

隐私协议

数据处理和安全协议

更新用户信息

PDF

聚焦模式

字号

最后更新时间： 2023-12-22 11:42:07

接口描述
更新已登录用户的个人信息。调用此接口时，需携带登录成功时得到的具备 openid scope 的 Access Token。如果更新手机号或邮箱，则需先调用 发送 OTP 验证码 接口向用户发送验证码。
支持的应用类型
Web 应用、单页应用、移动 App、M2M 应用。
请求方法
PATCH
请求路径
/userinfo
请求 Content-Type
application/json
请求示例
PATCH /userinfo HTTP/1.1
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN_WITH_OPENID_SCOPE
Host: sample.portal.tencentciam.com
﻿
{
  "nickname" : "MOCK_NICKNAME"
}
请求头
名称
描述
Authorization
OAuth 2.0 Bearer Token，格式为 Bearer <Token>，其中 Bearer 为固定字符串，<Token> 为用户登录成功时得到的具备 openid scope 的 Access Token，Bearer 和 <Token> 之间用一个空格隔开。
请求体 JSON 参数
JSON 路径
数据类型
描述
phone_number
String
用户的手机号，限国内三大运营商11位手机号。传递此参数时，须同时传递 phone_number_otp_token 和 phone_number_otp 两个参数。
phone_number_otp_token
String
发送短信验证码成功后服务端返回的 otp_token。
phone_number_otp
String
用户手机收到的 OTP 验证码。
email
String
用户的邮箱地址。传递此参数时，须同时传递 email_otp_token 和 email_otp 两个参数。
email_otp_token
String
发送邮箱验证码成功后服务端返回的 otp_token。
email_otp
String
用户邮箱收到的 OTP 验证码。
name
String
用户姓名。
nickname
String
用户昵称。
zoneinfo
String
用户时区，如 Asia/Shanghai 或 Europe/Paris。
locale
String
用户 locale 信息，如 zh-CN 或 en-US。
说明：
 其他参数的取值为用户属性标识。属性标识可以在 属性自定义页面 的属性详情界面查看。
正常响应示例
HTTP/1.1 200 OK
Content-Type: application/json
﻿
{
  "sub" : "MOCK_USER_ID",
  "email" : "MOCK_USERNAME@example.com",
  "name" : "MOCK_NAME",
  "nickname" : "MOCK_NICKNAME",
  "zoneinfo" : "Asia/Shanghai",
  "locale" : "zh-CN"
}
说明：
 除 sub 字段一定返回外，其余返回哪些字段由应用参数配置中的 Claims 决定。
异常响应示例
入参包含未知属性。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "invalid_request",
"error_description" : "Unknown attribute(s) found."
}
入参包含不支持修改的属性。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "invalid_request",
"error_description" : "Unsupported user attribute(s) found."
}
电话号码格式不合法。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "malformed_phone_number"
}
电话号码已存在。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "duplicate_phone_number"
}
phone_number_otp_token 错误或已过期，或注册时使用的参数与发送验证码时不一致（例如：手机号不同）。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "bad_phone_number_otp_token"
}
phone_number_otp 错误或已过期。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "bad_phone_number_otp"
}
邮箱格式不合法。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "malformed_email"
}
邮箱已存在。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "duplicate_email"
}
email_otp_token 错误或已过期，或注册时使用的参数与发送验证码时不一致（例如：邮箱不同）。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "bad_email_otp_token"
}
email_otp 错误或已过期。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "bad_email_otp"
}
入参取值不合法（例如：不符合用户属性正则表达式）。
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
﻿
{
"error" : "illegal_parameter_value"
}
bearer_token 缺失。
HTTP/1.1 400 Bad Request
WWW-Authenticate: Bearer error="invalid_request", error_description="Bearer token not found in the request", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1"
bearer_token 错误。
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer error="invalid_token", error_description="Error decoding JWT", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1"
bearer_token 无效。
HTTP/1.1 403 Forbidden
WWW-Authenticate: Bearer error="insufficient_scope", error_description="The request requires higher privil
﻿

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

账号风控平台

更新用户信息

接口描述

支持的应用类型

请求方法

请求路径

请求 Content-Type

请求示例

请求头

请求体 JSON 参数

正常响应示例

异常响应示例

帮助和支持

名称	描述
Authorization	OAuth 2.0 Bearer Token，格式为 `Bearer <Token>`，其中 `Bearer` 为固定字符串，`<Token>` 为用户登录成功时得到的具备 `openid scope 的 Access Token`，`Bearer` 和 `<Token>` 之间用一个空格隔开。

JSON 路径	数据类型	描述
phone_number	String	用户的手机号，限国内三大运营商11位手机号。传递此参数时，须同时传递 `phone_number_otp_token` 和 `phone_number_otp` 两个参数。
phone_number_otp_token	String	发送短信验证码成功后服务端返回的 `otp_token`。
phone_number_otp	String	用户手机收到的 OTP 验证码。
email	String	用户的邮箱地址。传递此参数时，须同时传递 `email_otp_token` 和 `email_otp` 两个参数。
email_otp_token	String	发送邮箱验证码成功后服务端返回的 `otp_token`。
email_otp	String	用户邮箱收到的 OTP 验证码。
name	String	用户姓名。
nickname	String	用户昵称。
zoneinfo	String	用户时区，如 `Asia/Shanghai` 或 `Europe/Paris`。
locale	String	用户 locale 信息，如 `zh-CN` 或 `en-US`。