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 | 否 | SignInAttributes | |
RequiredSignUpAttributes | Array of String | 否 | 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 | SignInAttributes | |
RequiredSignUpAttributes | Array of String | 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} | |
400 | InvalidParameter.{parameter} | |
400 | InvalidRequest | |
400 | MissingAction | |
400 | InvalidAction | |
401 | SignatureNotMatch | |
403 | AccessDenied | |
403 | InvalidAccessKeyId | |
404 | NotFound | 资源 %s 不存在 |
409 | Duplicated | 资源 %s 已存在 |
429 | Throttling | |
429 | QuotaExceeded | 配额 %s 已达上限 |
500 | InternalError | 内部服务错误: %s |
500 | DownstreamServerError | |
503 | ServiceUnavailable |