CreateUser - CreateUser--智能体身份和权限管理平台-火山引擎

文档中心

智能体身份和权限管理平台

用户身份管理

CreateUser - CreateUser

CreateUser API.

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateUser	要执行的操作，取值：CreateUser。
Version	String	是	2025-10-30	API的版本，取值：2025-10-30。
UserPoolUid	String	是	example	UserPoolUid
Profile	String	否	Example	Profile
Nickname	String	否	example	Nickname
Picture	String	否	example	picture
Website	String	否	Website	example
Gender	String	否	Example	Gender
Birthdate	String	否	example	Birthdate
Zoneinfo	String	否	example	Zoneinfo
Locale	String	否	example	Locale
EmailVerified	Boolean	否	true	EmailVerified
PhoneNumberVerified	Boolean	否	true	PhoneNumberVerified
PreferredUsername	String	否	example	PreferredUsername parameter.
Email	String	否	example	Email parameter.
Password	String	是	example	Password parameter.
Name	String	否	example	Name parameter.
PhoneNumber	String	否	example	PhoneNumber parameter.
GivenName	String	否	example	GivenName parameter.
FamilyName	String	否	example	FamilyName parameter.
MiddleName	String	否	example	MiddleName parameter.
UserMetadata	String	否	example	UserMetadata parameter.

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Zoneinfo	String	cn	Zoneinfo
UserState	String	CONFIRMED	UserState
Uid	String	example	Uid parameter.
PhoneNumberVerified	Boolean	true	PhoneNumberVerified
EmailVerified	Boolean	true	EmailVerified
Sub	String	example	Sub parameter.
PreferredUsername	String	example	PreferredUsername parameter.
Email	String	example	Email parameter.
Nickname	String	example	Nickname
Name	String	example	Name parameter.
Connection	String	example	Connection parameter.
NumLogins	Integer	1	NumLogins parameter.
LatestLogin	String	example	LatestLogin parameter.
LatestBrowser	String	example	LatestBrowser parameter.
PhoneNumber	String	example	PhoneNumber parameter.
CreateTime	String	2025-09-15T07:59:24Z	CreateTime
UpdateTime	String	2025-09-15T07:59:24Z	UpdateTime
GivenName	String	example	GivenName parameter.
FamilyName	String	example	FamilyName parameter.
MiddleName	String	example	MiddleName parameter.
Profile	String	example	Profile parameter.
Picture	String	example	Picture parameter.
Website	String	example	Website parameter.
Gender	String	example	Gender parameter.
Birthdate	String	example	Birthdate parameter.
Locale	String	example	Locale parameter.
UserMetadata	String	example	UserMetadata parameter.

请求示例

POST /?Action=CreateUser&Version=2025-10-30 HTTP/1.1
Host: cis-control-test.ivolces.com:30190
Content-Type: application/json; charset=UTF-8
X-Date: 20251124T071312Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251124/cn-beijing/id/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UserPoolUid": "example",
  "Profile": "Example",
  "Nickname": "example",
  "Picture": "example",
  "Website": "Website",
  "Gender": "Example",
  "Birthdate": "example",
  "Zoneinfo": "example",
  "Locale": "example",
  "EmailVerified": true,
  "PhoneNumberVerified": true,
  "PreferredUsername": "example",
  "Email": "example",
  "Password": "example",
  "Name": "example",
  "PhoneNumber": "example",
  "GivenName": "example",
  "FamilyName": "example",
  "MiddleName": "example",
  "UserMetadata": "example"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202511241513151430641701694B0EF8",
    "Action": "CreateUser",
    "Version": "2025-10-30",
    "Service": "id",
    "Region": "cn-beijing"
  },
  "Result": {
    "Zoneinfo": "cn",
    "UserState": "CONFIRMED",
    "Uid": "example",
    "PhoneNumberVerified": true,
    "EmailVerified": true,
    "Sub": "example",
    "PreferredUsername": "example",
    "Email": "example",
    "Nickname": "example",
    "Name": "example",
    "Connection": "example",
    "NumLogins": 1,
    "LatestLogin": "example",
    "LatestBrowser": "example",
    "PhoneNumber": "example",
    "CreateTime": "2025-09-15T07:59:24Z",
    "UpdateTime": "2025-09-15T07:59:24Z",
    "GivenName": "example",
    "FamilyName": "example",
    "MiddleName": "example",
    "Profile": "example",
    "Picture": "example",
    "Website": "example",
    "Gender": "example",
    "Birthdate": "example",
    "Locale": "example",
    "UserMetadata": "example"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.{parameter}	The required parameter %s is missing.
400	InvalidParameter.{parameter}	The parameter %s is invalid.
400	InvalidRequest	The request is invalid or malformed.
400	MissingAction	The request is missing an action.
400	InvalidAction	The specified action is invalid.
401	SignatureNotMatch	The request signature provided is incorrect.
403	AccessDenied	You are not authorized to perform this action.
403	InvalidAccessKeyId	The access key ID provided is not valid.
404	NotFound	Resource not found: %s.	资源 %s 不存在
409	Duplicated	Resource already exists: %s.	资源 %s 已存在
429	Throttling	The request is denied due to request throttling.
429	QuotaExceeded	Quota exceeded: %s.	配额 %s 已达上限
500	InternalError	Internal server error: %s.	内部服务错误: %s
500	DownstreamServerError	An error has occurred due to an unreachable service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

最近更新时间：2025.12.14 13:43:19

这个页面对您有帮助吗？

有用

无用

智能体身份和权限管理平台

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求参数

返回参数

请求示例

返回示例

错误码