bytepluscc.cloudidentity.User

bytepluscc v0.0.11, Jan 21 26

bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

云身份中心用户，与企业员工身份一一映射。云身份中心用户是一种身份类型，可与某个账号下的IAM用户身份进行唯一关联并单点登录。云身份中心提供企业员工身份全生命周期管理、权限管理能力，推荐您在本产品内统一管理员工身份。

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const cloudIdentityUserDemo = new bytepluscc.cloudidentity.User("CloudIdentityUserDemo", {
    userName: "CloudIdentityUserDemo",
    displayName: "CloudIdentityUserDemo",
    description: "CloudIdentityUserDemo description",
    email: "xxx@163.com",
    phone: "***********",
    password: "********",
    passwordResetRequired: true,
});

import pulumi
import pulumi_bytepluscc as bytepluscc

cloud_identity_user_demo = bytepluscc.cloudidentity.User("CloudIdentityUserDemo",
    user_name="CloudIdentityUserDemo",
    display_name="CloudIdentityUserDemo",
    description="CloudIdentityUserDemo description",
    email="xxx@163.com",
    phone="***********",
    password="********",
    password_reset_required=True)

package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/cloudidentity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudidentity.NewUser(ctx, "CloudIdentityUserDemo", &cloudidentity.UserArgs{
			UserName:              pulumi.String("CloudIdentityUserDemo"),
			DisplayName:           pulumi.String("CloudIdentityUserDemo"),
			Description:           pulumi.String("CloudIdentityUserDemo description"),
			Email:                 pulumi.String("xxx@163.com"),
			Phone:                 pulumi.String("***********"),
			Password:              pulumi.String("********"),
			PasswordResetRequired: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var cloudIdentityUserDemo = new Bytepluscc.Cloudidentity.User("CloudIdentityUserDemo", new()
    {
        UserName = "CloudIdentityUserDemo",
        DisplayName = "CloudIdentityUserDemo",
        Description = "CloudIdentityUserDemo description",
        Email = "xxx@163.com",
        Phone = "***********",
        Password = "********",
        PasswordResetRequired = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.cloudidentity.User;
import com.byteplus.bytepluscc.cloudidentity.UserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var cloudIdentityUserDemo = new User("cloudIdentityUserDemo", UserArgs.builder()
            .userName("CloudIdentityUserDemo")
            .displayName("CloudIdentityUserDemo")
            .description("CloudIdentityUserDemo description")
            .email("xxx@163.com")
            .phone("***********")
            .password("********")
            .passwordResetRequired(true)
            .build());

    }
}

resources:
  cloudIdentityUserDemo:
    type: bytepluscc:cloudidentity:User
    name: CloudIdentityUserDemo
    properties:
      userName: CloudIdentityUserDemo
      displayName: CloudIdentityUserDemo
      description: CloudIdentityUserDemo description
      email: xxx@163.com
      phone: '***********'
      password: '********'
      passwordResetRequired: true

Create User Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new User(name: string, args?: UserArgs, opts?: CustomResourceOptions);

@overload
def User(resource_name: str,
         args: Optional[UserArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         description: Optional[str] = None,
         display_name: Optional[str] = None,
         email: Optional[str] = None,
         password: Optional[str] = None,
         password_reset_required: Optional[bool] = None,
         phone: Optional[str] = None,
         user_name: Optional[str] = None)

func NewUser(ctx *Context, name string, args *UserArgs, opts ...ResourceOption) (*User, error)

public User(string name, UserArgs? args = null, CustomResourceOptions? opts = null)

public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: bytepluscc:cloudidentity:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UserArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var userResource = new Bytepluscc.Cloudidentity.User("userResource", new()
{
    Description = "string",
    DisplayName = "string",
    Email = "string",
    Password = "string",
    PasswordResetRequired = false,
    Phone = "string",
    UserName = "string",
});

example, err := cloudidentity.NewUser(ctx, "userResource", &cloudidentity.UserArgs{
	Description:           pulumi.String("string"),
	DisplayName:           pulumi.String("string"),
	Email:                 pulumi.String("string"),
	Password:              pulumi.String("string"),
	PasswordResetRequired: pulumi.Bool(false),
	Phone:                 pulumi.String("string"),
	UserName:              pulumi.String("string"),
})

var userResource = new com.byteplus.bytepluscc.cloudidentity.User("userResource", com.byteplus.bytepluscc.cloudidentity.UserArgs.builder()
    .description("string")
    .displayName("string")
    .email("string")
    .password("string")
    .passwordResetRequired(false)
    .phone("string")
    .userName("string")
    .build());

user_resource = bytepluscc.cloudidentity.User("userResource",
    description="string",
    display_name="string",
    email="string",
    password="string",
    password_reset_required=False,
    phone="string",
    user_name="string")

const userResource = new bytepluscc.cloudidentity.User("userResource", {
    description: "string",
    displayName: "string",
    email: "string",
    password: "string",
    passwordResetRequired: false,
    phone: "string",
    userName: "string",
});

type: bytepluscc:cloudidentity:User
properties:
    description: string
    displayName: string
    email: string
    password: string
    passwordResetRequired: false
    phone: string
    userName: string

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The User resource accepts the following input properties:

Description string: 用户描述。
DisplayName string: 用户显示名。
Email string: 邮箱。
Password string: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
PasswordResetRequired bool: 首次登陆需不需要重置密码。
Phone string: 手机号。
UserName string: 用户名。

Description string: 用户描述。
DisplayName string: 用户显示名。
Email string: 邮箱。
Password string: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
PasswordResetRequired bool: 首次登陆需不需要重置密码。
Phone string: 手机号。
UserName string: 用户名。

description String: 用户描述。
displayName String: 用户显示名。
email String: 邮箱。
password String: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
passwordResetRequired Boolean: 首次登陆需不需要重置密码。
phone String: 手机号。
userName String: 用户名。

description string: 用户描述。
displayName string: 用户显示名。
email string: 邮箱。
password string: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
passwordResetRequired boolean: 首次登陆需不需要重置密码。
phone string: 手机号。
userName string: 用户名。

description str: 用户描述。
display_name str: 用户显示名。
email str: 邮箱。
password str: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
password_reset_required bool: 首次登陆需不需要重置密码。
phone str: 手机号。
user_name str: 用户名。

description String: 用户描述。
displayName String: 用户显示名。
email String: 邮箱。
password String: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
passwordResetRequired Boolean: 首次登陆需不需要重置密码。
phone String: 手机号。
userName String: 用户名。

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

CreatedTime string: 创建时间。
Id string: The provider-assigned unique ID for this managed resource.
IdentityType string: 身份类型。
Source string: 用户来源。
UpdatedTime string: 更新时间。
UserId string: 用户id。

CreatedTime string: 创建时间。
Id string: The provider-assigned unique ID for this managed resource.
IdentityType string: 身份类型。
Source string: 用户来源。
UpdatedTime string: 更新时间。
UserId string: 用户id。

createdTime String: 创建时间。
id String: The provider-assigned unique ID for this managed resource.
identityType String: 身份类型。
source String: 用户来源。
updatedTime String: 更新时间。
userId String: 用户id。

createdTime string: 创建时间。
id string: The provider-assigned unique ID for this managed resource.
identityType string: 身份类型。
source string: 用户来源。
updatedTime string: 更新时间。
userId string: 用户id。

created_time str: 创建时间。
id str: The provider-assigned unique ID for this managed resource.
identity_type str: 身份类型。
source str: 用户来源。
updated_time str: 更新时间。
user_id str: 用户id。

createdTime String: 创建时间。
id String: The provider-assigned unique ID for this managed resource.
identityType String: 身份类型。
source String: 用户来源。
updatedTime String: 更新时间。
userId String: 用户id。

Look up Existing User Resource

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        email: Optional[str] = None,
        identity_type: Optional[str] = None,
        password: Optional[str] = None,
        password_reset_required: Optional[bool] = None,
        phone: Optional[str] = None,
        source: Optional[str] = None,
        updated_time: Optional[str] = None,
        user_id: Optional[str] = None,
        user_name: Optional[str] = None) -> User

func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)

public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)

public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)

resources:  _:    type: bytepluscc:cloudidentity:User    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreatedTime string: 创建时间。
Description string: 用户描述。
DisplayName string: 用户显示名。
Email string: 邮箱。
IdentityType string: 身份类型。
Password string: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
PasswordResetRequired bool: 首次登陆需不需要重置密码。
Phone string: 手机号。
Source string: 用户来源。
UpdatedTime string: 更新时间。
UserId string: 用户id。
UserName string: 用户名。

CreatedTime string: 创建时间。
Description string: 用户描述。
DisplayName string: 用户显示名。
Email string: 邮箱。
IdentityType string: 身份类型。
Password string: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
PasswordResetRequired bool: 首次登陆需不需要重置密码。
Phone string: 手机号。
Source string: 用户来源。
UpdatedTime string: 更新时间。
UserId string: 用户id。
UserName string: 用户名。

createdTime String: 创建时间。
description String: 用户描述。
displayName String: 用户显示名。
email String: 邮箱。
identityType String: 身份类型。
password String: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
passwordResetRequired Boolean: 首次登陆需不需要重置密码。
phone String: 手机号。
source String: 用户来源。
updatedTime String: 更新时间。
userId String: 用户id。
userName String: 用户名。

createdTime string: 创建时间。
description string: 用户描述。
displayName string: 用户显示名。
email string: 邮箱。
identityType string: 身份类型。
password string: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
passwordResetRequired boolean: 首次登陆需不需要重置密码。
phone string: 手机号。
source string: 用户来源。
updatedTime string: 更新时间。
userId string: 用户id。
userName string: 用户名。

created_time str: 创建时间。
description str: 用户描述。
display_name str: 用户显示名。
email str: 邮箱。
identity_type str: 身份类型。
password str: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
password_reset_required bool: 首次登陆需不需要重置密码。
phone str: 手机号。
source str: 用户来源。
updated_time str: 更新时间。
user_id str: 用户id。
user_name str: 用户名。

createdTime String: 创建时间。
description String: 用户描述。
displayName String: 用户显示名。
email String: 邮箱。
identityType String: 身份类型。
password String: 密码。密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。
passwordResetRequired Boolean: 首次登陆需不需要重置密码。
phone String: 手机号。
source String: 用户来源。
updatedTime String: 更新时间。
userId String: 用户id。
userName String: 用户名。

Import

$ pulumi import bytepluscc:cloudidentity/user:User example "user_id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.cloudidentity.User

On this page

On this page

Example Usage

Create User Resource

Constructor syntax

Parameters

Constructor example

User Resource Properties

Inputs

Outputs

Look up Existing User Resource

Import

Package Details

On this page

On this page