getUserPool

bytepluscc v0.0.42, Jul 20 26

Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getUserPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUserPool(args: GetUserPoolArgs, opts?: InvokeOptions): Promise<GetUserPoolResult>
function getUserPoolOutput(args: GetUserPoolOutputArgs, opts?: InvokeOptions): Output<GetUserPoolResult>

def get_user_pool(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUserPoolResult
def get_user_pool_output(id: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolResult]

func LookupUserPool(ctx *Context, args *LookupUserPoolArgs, opts ...InvokeOption) (*LookupUserPoolResult, error)
func LookupUserPoolOutput(ctx *Context, args *LookupUserPoolOutputArgs, opts ...InvokeOption) LookupUserPoolResultOutput

> Note: This function is named LookupUserPool in the Go SDK.

public static class GetUserPool 
{
    public static Task<GetUserPoolResult> InvokeAsync(GetUserPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetUserPoolResult> Invoke(GetUserPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUserPoolResult> getUserPool(GetUserPoolArgs args, InvokeOptions options)
public static Output<GetUserPoolResult> getUserPool(GetUserPoolArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:id/getUserPool:getUserPool
  arguments:
    # arguments dictionary

data "bytepluscc_id_get_user_pool" "name" {
    # arguments
}

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getUserPool Result

The following output properties are available:

Brand Byteplus.GetUserPoolBrand: User pool brand display configuration
CreateTime string: Creation time
Description string: User pool description
DiscoveryUrl string: OpenID Connect discovery URL
Domain string: User pool access domain
EmailPasswordlessSignInEnabled bool: Email passwordless login enabled
Enabled bool: User pool enabled
Id string: Uniquely identifies the resource.
IssuerUrl string: Token issuer URL
Name string: User pool name
OauthLoginCallbackUrl string: OAuth login callback URL
OauthSignUpCallbackUrl string: OAuth registration callback URL
OidcLoginCallbackUrl string: OIDC login callback URL
OidcSignUpCallbackUrl string: OIDC registration callback URL
PasswordSignInEnabled bool: Password login enabled
ProjectName string: Project name
RequiredSignUpAttributes List<string>: Required registration attribute list
SamlLoginCallbackUrl string: SAML login callback URL
SamlSignUpCallbackUrl string: SAML registration callback URL
SelfAccountRecoveryEnabled bool: Allow account self-recovery
SelfSignUpEnabled bool: Allow user self-registration
SignInAttributes List<string>: Supported login attribute list
SignUpAutoVerificationEnabled bool: Registration auto-validation enabled
SmsAnonymousSignUpEnabled bool: SMS anonymous registration enabled
SmsPasswordlessSignInEnabled bool: SMS passwordless login enabled
Tags List<Byteplus.GetUserPoolTag>: User pool tag list
TokenSigningKeyUrl string: Token signature public key URL
TokenUrl string: Token endpoint URL
TotalClients int: Total clients in user pool
TotalConnections int: Total connections and identity providers in user pool
TotalUsers int: Total users in user pool
Trn string: User pool TRN
Uid string: User pool unique identifier
UnconfirmedUserSignInEnabled bool: Allow unconfirmed users to log in
UpdateTime string: Update time

Brand GetUserPoolBrand: User pool brand display configuration
CreateTime string: Creation time
Description string: User pool description
DiscoveryUrl string: OpenID Connect discovery URL
Domain string: User pool access domain
EmailPasswordlessSignInEnabled bool: Email passwordless login enabled
Enabled bool: User pool enabled
Id string: Uniquely identifies the resource.
IssuerUrl string: Token issuer URL
Name string: User pool name
OauthLoginCallbackUrl string: OAuth login callback URL
OauthSignUpCallbackUrl string: OAuth registration callback URL
OidcLoginCallbackUrl string: OIDC login callback URL
OidcSignUpCallbackUrl string: OIDC registration callback URL
PasswordSignInEnabled bool: Password login enabled
ProjectName string: Project name
RequiredSignUpAttributes []string: Required registration attribute list
SamlLoginCallbackUrl string: SAML login callback URL
SamlSignUpCallbackUrl string: SAML registration callback URL
SelfAccountRecoveryEnabled bool: Allow account self-recovery
SelfSignUpEnabled bool: Allow user self-registration
SignInAttributes []string: Supported login attribute list
SignUpAutoVerificationEnabled bool: Registration auto-validation enabled
SmsAnonymousSignUpEnabled bool: SMS anonymous registration enabled
SmsPasswordlessSignInEnabled bool: SMS passwordless login enabled
Tags []GetUserPoolTag: User pool tag list
TokenSigningKeyUrl string: Token signature public key URL
TokenUrl string: Token endpoint URL
TotalClients int: Total clients in user pool
TotalConnections int: Total connections and identity providers in user pool
TotalUsers int: Total users in user pool
Trn string: User pool TRN
Uid string: User pool unique identifier
UnconfirmedUserSignInEnabled bool: Allow unconfirmed users to log in
UpdateTime string: Update time

brand object: User pool brand display configuration
create_time string: Creation time
description string: User pool description
discovery_url string: OpenID Connect discovery URL
domain string: User pool access domain
email_passwordless_sign_in_enabled bool: Email passwordless login enabled
enabled bool: User pool enabled
id string: Uniquely identifies the resource.
issuer_url string: Token issuer URL
name string: User pool name
oauth_login_callback_url string: OAuth login callback URL
oauth_sign_up_callback_url string: OAuth registration callback URL
oidc_login_callback_url string: OIDC login callback URL
oidc_sign_up_callback_url string: OIDC registration callback URL
password_sign_in_enabled bool: Password login enabled
project_name string: Project name
required_sign_up_attributes list(string): Required registration attribute list
saml_login_callback_url string: SAML login callback URL
saml_sign_up_callback_url string: SAML registration callback URL
self_account_recovery_enabled bool: Allow account self-recovery
self_sign_up_enabled bool: Allow user self-registration
sign_in_attributes list(string): Supported login attribute list
sign_up_auto_verification_enabled bool: Registration auto-validation enabled
sms_anonymous_sign_up_enabled bool: SMS anonymous registration enabled
sms_passwordless_sign_in_enabled bool: SMS passwordless login enabled
tags list(object): User pool tag list
token_signing_key_url string: Token signature public key URL
token_url string: Token endpoint URL
total_clients number: Total clients in user pool
total_connections number: Total connections and identity providers in user pool
total_users number: Total users in user pool
trn string: User pool TRN
uid string: User pool unique identifier
unconfirmed_user_sign_in_enabled bool: Allow unconfirmed users to log in
update_time string: Update time

brand GetUserPoolBrand: User pool brand display configuration
createTime String: Creation time
description String: User pool description
discoveryUrl String: OpenID Connect discovery URL
domain String: User pool access domain
emailPasswordlessSignInEnabled Boolean: Email passwordless login enabled
enabled Boolean: User pool enabled
id String: Uniquely identifies the resource.
issuerUrl String: Token issuer URL
name String: User pool name
oauthLoginCallbackUrl String: OAuth login callback URL
oauthSignUpCallbackUrl String: OAuth registration callback URL
oidcLoginCallbackUrl String: OIDC login callback URL
oidcSignUpCallbackUrl String: OIDC registration callback URL
passwordSignInEnabled Boolean: Password login enabled
projectName String: Project name
requiredSignUpAttributes List<String>: Required registration attribute list
samlLoginCallbackUrl String: SAML login callback URL
samlSignUpCallbackUrl String: SAML registration callback URL
selfAccountRecoveryEnabled Boolean: Allow account self-recovery
selfSignUpEnabled Boolean: Allow user self-registration
signInAttributes List<String>: Supported login attribute list
signUpAutoVerificationEnabled Boolean: Registration auto-validation enabled
smsAnonymousSignUpEnabled Boolean: SMS anonymous registration enabled
smsPasswordlessSignInEnabled Boolean: SMS passwordless login enabled
tags List<GetUserPoolTag>: User pool tag list
tokenSigningKeyUrl String: Token signature public key URL
tokenUrl String: Token endpoint URL
totalClients Integer: Total clients in user pool
totalConnections Integer: Total connections and identity providers in user pool
totalUsers Integer: Total users in user pool
trn String: User pool TRN
uid String: User pool unique identifier
unconfirmedUserSignInEnabled Boolean: Allow unconfirmed users to log in
updateTime String: Update time

brand GetUserPoolBrand: User pool brand display configuration
createTime string: Creation time
description string: User pool description
discoveryUrl string: OpenID Connect discovery URL
domain string: User pool access domain
emailPasswordlessSignInEnabled boolean: Email passwordless login enabled
enabled boolean: User pool enabled
id string: Uniquely identifies the resource.
issuerUrl string: Token issuer URL
name string: User pool name
oauthLoginCallbackUrl string: OAuth login callback URL
oauthSignUpCallbackUrl string: OAuth registration callback URL
oidcLoginCallbackUrl string: OIDC login callback URL
oidcSignUpCallbackUrl string: OIDC registration callback URL
passwordSignInEnabled boolean: Password login enabled
projectName string: Project name
requiredSignUpAttributes string[]: Required registration attribute list
samlLoginCallbackUrl string: SAML login callback URL
samlSignUpCallbackUrl string: SAML registration callback URL
selfAccountRecoveryEnabled boolean: Allow account self-recovery
selfSignUpEnabled boolean: Allow user self-registration
signInAttributes string[]: Supported login attribute list
signUpAutoVerificationEnabled boolean: Registration auto-validation enabled
smsAnonymousSignUpEnabled boolean: SMS anonymous registration enabled
smsPasswordlessSignInEnabled boolean: SMS passwordless login enabled
tags GetUserPoolTag[]: User pool tag list
tokenSigningKeyUrl string: Token signature public key URL
tokenUrl string: Token endpoint URL
totalClients number: Total clients in user pool
totalConnections number: Total connections and identity providers in user pool
totalUsers number: Total users in user pool
trn string: User pool TRN
uid string: User pool unique identifier
unconfirmedUserSignInEnabled boolean: Allow unconfirmed users to log in
updateTime string: Update time

brand GetUserPoolBrand: User pool brand display configuration
create_time str: Creation time
description str: User pool description
discovery_url str: OpenID Connect discovery URL
domain str: User pool access domain
email_passwordless_sign_in_enabled bool: Email passwordless login enabled
enabled bool: User pool enabled
id str: Uniquely identifies the resource.
issuer_url str: Token issuer URL
name str: User pool name
oauth_login_callback_url str: OAuth login callback URL
oauth_sign_up_callback_url str: OAuth registration callback URL
oidc_login_callback_url str: OIDC login callback URL
oidc_sign_up_callback_url str: OIDC registration callback URL
password_sign_in_enabled bool: Password login enabled
project_name str: Project name
required_sign_up_attributes Sequence[str]: Required registration attribute list
saml_login_callback_url str: SAML login callback URL
saml_sign_up_callback_url str: SAML registration callback URL
self_account_recovery_enabled bool: Allow account self-recovery
self_sign_up_enabled bool: Allow user self-registration
sign_in_attributes Sequence[str]: Supported login attribute list
sign_up_auto_verification_enabled bool: Registration auto-validation enabled
sms_anonymous_sign_up_enabled bool: SMS anonymous registration enabled
sms_passwordless_sign_in_enabled bool: SMS passwordless login enabled
tags Sequence[GetUserPoolTag]: User pool tag list
token_signing_key_url str: Token signature public key URL
token_url str: Token endpoint URL
total_clients int: Total clients in user pool
total_connections int: Total connections and identity providers in user pool
total_users int: Total users in user pool
trn str: User pool TRN
uid str: User pool unique identifier
unconfirmed_user_sign_in_enabled bool: Allow unconfirmed users to log in
update_time str: Update time

brand Property Map: User pool brand display configuration
createTime String: Creation time
description String: User pool description
discoveryUrl String: OpenID Connect discovery URL
domain String: User pool access domain
emailPasswordlessSignInEnabled Boolean: Email passwordless login enabled
enabled Boolean: User pool enabled
id String: Uniquely identifies the resource.
issuerUrl String: Token issuer URL
name String: User pool name
oauthLoginCallbackUrl String: OAuth login callback URL
oauthSignUpCallbackUrl String: OAuth registration callback URL
oidcLoginCallbackUrl String: OIDC login callback URL
oidcSignUpCallbackUrl String: OIDC registration callback URL
passwordSignInEnabled Boolean: Password login enabled
projectName String: Project name
requiredSignUpAttributes List<String>: Required registration attribute list
samlLoginCallbackUrl String: SAML login callback URL
samlSignUpCallbackUrl String: SAML registration callback URL
selfAccountRecoveryEnabled Boolean: Allow account self-recovery
selfSignUpEnabled Boolean: Allow user self-registration
signInAttributes List<String>: Supported login attribute list
signUpAutoVerificationEnabled Boolean: Registration auto-validation enabled
smsAnonymousSignUpEnabled Boolean: SMS anonymous registration enabled
smsPasswordlessSignInEnabled Boolean: SMS passwordless login enabled
tags List<Property Map>: User pool tag list
tokenSigningKeyUrl String: Token signature public key URL
tokenUrl String: Token endpoint URL
totalClients Number: Total clients in user pool
totalConnections Number: Total connections and identity providers in user pool
totalUsers Number: Total users in user pool
trn String: User pool TRN
uid String: User pool unique identifier
unconfirmedUserSignInEnabled Boolean: Allow unconfirmed users to log in
updateTime String: Update time

Supporting Types

GetUserPoolBrand

LogoUri string: Brand logo URL
Name string: Brand name

LogoUri string: Brand logo URL
Name string: Brand name

logo_uri string: Brand logo URL
name string: Brand name

logoUri String: Brand logo URL
name String: Brand name

logoUri string: Brand logo URL
name string: Brand name

logo_uri str: Brand logo URL
name str: Brand name

logoUri String: Brand logo URL
name String: Brand name

GetUserPoolTag

Key string: Tag key
Value string: Tag value

Key string: Tag key
Value string: Tag value

key string: Tag key
value string: Tag value

key String: Tag key
value String: Tag value

key string: Tag key
value string: Tag value

key str: Tag key
value str: Tag value

key String: Tag key
value String: Tag value

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.id.getUserPool

On this page

On this page

Using getUserPool

getUserPool Result

Supporting Types

GetUserPoolBrand

GetUserPoolTag

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

bytepluscc.id.getUserPool

On this page

On this page

Using getUserPool

getUserPool Result

Supporting Types

GetUserPoolBrand

GetUserPoolTag

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.