You need to enable JavaScript to run this app.
文档中心
智能体身份和权限管理平台

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

复制全文
下载 pdf
用户身份管理
CreateUserPool - CreateUserPool
复制全文
下载 pdf
CreateUserPool - CreateUserPool

CreateUserPool API.

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String
是

CreateUserPool

要执行的操作,取值:CreateUserPool。

Version
String
是

2025-10-30

API的版本,取值:2025-10-30。

PasswordSignInEnabled
Boolean
否

true

PasswordSignInEnabled

SmsPasswordlessSignInEnabled
Boolean
否

true

SmsPasswordlessSignInEnabled

EmailPasswordlessSignInEnabled
Boolean
否

true

EmailPasswordlessSignInEnabled

SelfSignUpEnabled
Boolean
否

true

SelfSignUpEnabled

SignInAttributes
Array of String
否

email

SignInAttributes

RequiredSignUpAttributes
Array of String
否

email

RequiredSignUpAttributes

Tags
Array of Object
否

[{"Key": "app", "Value": "test"}]

tags

ProjectName
String
否

default

ProjectName

SignUpAutoVerificationEnabled
Boolean
否

true

SignUpAutoVerificationEnabled

SelfAccountRecoveryEnabled
Boolean
否

true

SelfAccountRecoveryEnabled

UnconfirmedUserSignInEnabled
Boolean
否

false

UnconfirmedUserSignInEnabled

Brand
Object
否

{"Name": "Example", "LogoUri": "https://img.freepik.com/free-vector/flat-design-cn-nc-logo-template_23-2149255667.jpg"}

Brand

Name
String
是

example

Name parameter.

Description
String
否

example

Description parameter.

返回参数

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

参数
类型
示例值
描述
SignUpAutoVerificationEnabled
Boolean

true

SignUpAutoVerificationEnabled

SelfAccountRecoveryEnabled
Boolean

true

SelfAccountRecoveryEnabled

UnconfirmedUserSignInEnabled
Boolean

true

UnconfirmedUserSignInEnabled

Brand
Object

{"Name": "Example", "LogoUri": "https://img.freepik.com/free-vector/flat-design-cn-nc-logo-template_23-2149255667.jpg"}

userpool brand

Trn
String

example

TRN

Uid
String

example

Uid parameter.

Name
String

example

Name parameter.

Description
String

example

Description parameter.

Domain
String

example

Domain parameter.

CreateTime
String

2025-09-15T07:59:24Z

CreateTime

UpdateTime
String

2025-09-15T07:59:24Z

UpdateTime

TotalUsers
Integer

1

TotalUsers

TotalClients
Integer

1

TotalClients

TotalConnections
Integer

1

TotalConnections

TokenSigningKeyUrl
String

example

TokenSigningKeyUrl

DiscoveryUrl
String

https://exmaple.com/.well-known/openid-configuration

DiscoveryUrl

OauthSignUpCallbackUrl
String

https://example.com/signup/generic_oauth/callback

OauthSignUpCallbackUrl

OauthLoginCallbackUrl
String

https://example.com/signin/generic_oauth/callback

OauthLoginCallbackUrl

OidcSignUpCallbackUrl
String

https://example.com/signup/generic_oidc/callback

OidcSignUpCallbackUrl

OidcLoginCallbackUrl
String

https://example.com/signin/generic_oidc/callback

OidcLoginCallbackUrl

SamlSignUpCallbackUrl
String

https://example.com/signup/generic_saml/callback

SamlSignUpCallbackUrl

SamlLoginCallbackUrl
String

https://example.com/signin/generic_saml/callback

SamlLoginCallbackUrl

PasswordSignInEnabled
Boolean

true

PasswordSignInEnabled

SmsPasswordlessSignInEnabled
Boolean

true

SmsPasswordlessSignInEnabled

EmailPasswordlessSignInEnabled
Boolean

true

EmailPasswordlessSignInEnabled

SelfSignUpEnabled
Boolean

true

SelfSignUpEnabled

SignInAttributes
Array of String

email

SignInAttributes

RequiredSignUpAttributes
Array of String

email

RequiredSignUpAttributes

Tags
Array of Object

[{"Key": "app", "Value": "test"}]

tags

ProjectName
String

example

ProjectName

请求示例

POST /?Action=CreateUserPool&Version=2025-10-30 HTTP/1.1
Host: cis-control-test.ivolces.com:30190
Content-Type: application/json; charset=UTF-8
X-Date: 20251124T061617Z
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

{
  "PasswordSignInEnabled": true,
  "SmsPasswordlessSignInEnabled": true,
  "EmailPasswordlessSignInEnabled": true,
  "SelfSignUpEnabled": true,
  "SignInAttributes": [
    "email"
  ],
  "RequiredSignUpAttributes": [
    "email"
  ],
  "Tags": [
    {
      "Key": "app",
      "Value": "test"
    }
  ],
  "ProjectName": "default",
  "Name": "example",
  "Description": "example"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202511241416371331521320244211A8",
    "Action": "CreateUserPool",
    "Version": "2025-10-30",
    "Service": "id",
    "Region": "cn-beijing"
  },
  "Result": {
    "Trn": "example",
    "Uid": "example",
    "Name": "example",
    "Description": "example",
    "Domain": "example",
    "CreateTime": "2025-09-15T07:59:24Z",
    "UpdateTime": "2025-09-15T07:59:24Z",
    "TotalUsers": 1,
    "TotalClients": 1,
    "TotalConnections": 1,
    "TokenSigningKeyUrl": "example",
    "DiscoveryUrl": "https://exmaple.com/.well-known/openid-configuration",
    "OauthSignUpCallbackUrl": "https://example.com/signup/generic_oauth/callback",
    "OauthLoginCallbackUrl": "https://example.com/signin/generic_oauth/callback",
    "OidcSignUpCallbackUrl": "https://example.com/signup/generic_oidc/callback",
    "OidcLoginCallbackUrl": "https://example.com/signin/generic_oidc/callback",
    "SamlSignUpCallbackUrl": "https://example.com/signup/generic_saml/callback",
    "SamlLoginCallbackUrl": "https://example.com/signin/generic_saml/callback",
    "PasswordSignInEnabled": true,
    "SmsPasswordlessSignInEnabled": true,
    "EmailPasswordlessSignInEnabled": true,
    "SelfSignUpEnabled": true,
    "SignInAttributes": [
      "email"
    ],
    "RequiredSignUpAttributes": [
      "email"
    ],
    "Tags": [
      {
        "Key": "app",
        "Value": "test"
      }
    ],
    "ProjectName": "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
这个页面对您有帮助吗?
有用
有用
无用
无用