Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

User

Provides a Cloud SSO User resource.

For information about Cloud SSO User and how to use it, see What is User.

NOTE: Available in v1.140.0+.

NOTE: Cloud SSO Only Support cn-shanghai And us-west-1 Region

Create a User Resource

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         description: Optional[str] = None,
         directory_id: Optional[str] = None,
         display_name: Optional[str] = None,
         email: Optional[str] = None,
         first_name: Optional[str] = None,
         last_name: Optional[str] = None,
         status: Optional[str] = None,
         user_name: Optional[str] = None)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)
type: alicloud:cloudsso:User
properties: # The arguments to resource properties.
options: # 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.
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.

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

The User resource accepts the following input properties:

DirectoryId string

The ID of the Directory.

UserName string

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

Description string

The description of user. The description can be up to 1024 characters long.

DisplayName string

The display name of user. The display name can be up to 256 characters long.

Email string

The User's Contact Email Address. The email can be up to 128 characters long.

FirstName string

The first name of user. The first_name can be up to 64 characters long.

LastName string

The last name of user. The last_name can be up to 64 characters long.

Status string

The status of user. Valid values: Disabled, Enabled.

DirectoryId string

The ID of the Directory.

UserName string

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

Description string

The description of user. The description can be up to 1024 characters long.

DisplayName string

The display name of user. The display name can be up to 256 characters long.

Email string

The User's Contact Email Address. The email can be up to 128 characters long.

FirstName string

The first name of user. The first_name can be up to 64 characters long.

LastName string

The last name of user. The last_name can be up to 64 characters long.

Status string

The status of user. Valid values: Disabled, Enabled.

directoryId String

The ID of the Directory.

userName String

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

description String

The description of user. The description can be up to 1024 characters long.

displayName String

The display name of user. The display name can be up to 256 characters long.

email String

The User's Contact Email Address. The email can be up to 128 characters long.

firstName String

The first name of user. The first_name can be up to 64 characters long.

lastName String

The last name of user. The last_name can be up to 64 characters long.

status String

The status of user. Valid values: Disabled, Enabled.

directoryId string

The ID of the Directory.

userName string

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

description string

The description of user. The description can be up to 1024 characters long.

displayName string

The display name of user. The display name can be up to 256 characters long.

email string

The User's Contact Email Address. The email can be up to 128 characters long.

firstName string

The first name of user. The first_name can be up to 64 characters long.

lastName string

The last name of user. The last_name can be up to 64 characters long.

status string

The status of user. Valid values: Disabled, Enabled.

directory_id str

The ID of the Directory.

user_name str

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

description str

The description of user. The description can be up to 1024 characters long.

display_name str

The display name of user. The display name can be up to 256 characters long.

email str

The User's Contact Email Address. The email can be up to 128 characters long.

first_name str

The first name of user. The first_name can be up to 64 characters long.

last_name str

The last name of user. The last_name can be up to 64 characters long.

status str

The status of user. Valid values: Disabled, Enabled.

directoryId String

The ID of the Directory.

userName String

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

description String

The description of user. The description can be up to 1024 characters long.

displayName String

The display name of user. The display name can be up to 256 characters long.

email String

The User's Contact Email Address. The email can be up to 128 characters long.

firstName String

The first name of user. The first_name can be up to 64 characters long.

lastName String

The last name of user. The last_name can be up to 64 characters long.

status String

The status of user. Valid values: Disabled, Enabled.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

UserId string

The User ID of the group.

Id string

The provider-assigned unique ID for this managed resource.

UserId string

The User ID of the group.

id String

The provider-assigned unique ID for this managed resource.

userId String

The User ID of the group.

id string

The provider-assigned unique ID for this managed resource.

userId string

The User ID of the group.

id str

The provider-assigned unique ID for this managed resource.

user_id str

The User ID of the group.

id String

The provider-assigned unique ID for this managed resource.

userId String

The User ID of the group.

Look up an 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,
        description: Optional[str] = None,
        directory_id: Optional[str] = None,
        display_name: Optional[str] = None,
        email: Optional[str] = None,
        first_name: Optional[str] = None,
        last_name: Optional[str] = None,
        status: 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)
Resource lookup is not supported in YAML
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:
Description string

The description of user. The description can be up to 1024 characters long.

DirectoryId string

The ID of the Directory.

DisplayName string

The display name of user. The display name can be up to 256 characters long.

Email string

The User's Contact Email Address. The email can be up to 128 characters long.

FirstName string

The first name of user. The first_name can be up to 64 characters long.

LastName string

The last name of user. The last_name can be up to 64 characters long.

Status string

The status of user. Valid values: Disabled, Enabled.

UserId string

The User ID of the group.

UserName string

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

Description string

The description of user. The description can be up to 1024 characters long.

DirectoryId string

The ID of the Directory.

DisplayName string

The display name of user. The display name can be up to 256 characters long.

Email string

The User's Contact Email Address. The email can be up to 128 characters long.

FirstName string

The first name of user. The first_name can be up to 64 characters long.

LastName string

The last name of user. The last_name can be up to 64 characters long.

Status string

The status of user. Valid values: Disabled, Enabled.

UserId string

The User ID of the group.

UserName string

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

description String

The description of user. The description can be up to 1024 characters long.

directoryId String

The ID of the Directory.

displayName String

The display name of user. The display name can be up to 256 characters long.

email String

The User's Contact Email Address. The email can be up to 128 characters long.

firstName String

The first name of user. The first_name can be up to 64 characters long.

lastName String

The last name of user. The last_name can be up to 64 characters long.

status String

The status of user. Valid values: Disabled, Enabled.

userId String

The User ID of the group.

userName String

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

description string

The description of user. The description can be up to 1024 characters long.

directoryId string

The ID of the Directory.

displayName string

The display name of user. The display name can be up to 256 characters long.

email string

The User's Contact Email Address. The email can be up to 128 characters long.

firstName string

The first name of user. The first_name can be up to 64 characters long.

lastName string

The last name of user. The last_name can be up to 64 characters long.

status string

The status of user. Valid values: Disabled, Enabled.

userId string

The User ID of the group.

userName string

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

description str

The description of user. The description can be up to 1024 characters long.

directory_id str

The ID of the Directory.

display_name str

The display name of user. The display name can be up to 256 characters long.

email str

The User's Contact Email Address. The email can be up to 128 characters long.

first_name str

The first name of user. The first_name can be up to 64 characters long.

last_name str

The last name of user. The last_name can be up to 64 characters long.

status str

The status of user. Valid values: Disabled, Enabled.

user_id str

The User ID of the group.

user_name str

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

description String

The description of user. The description can be up to 1024 characters long.

directoryId String

The ID of the Directory.

displayName String

The display name of user. The display name can be up to 256 characters long.

email String

The User's Contact Email Address. The email can be up to 128 characters long.

firstName String

The first name of user. The first_name can be up to 64 characters long.

lastName String

The last name of user. The last_name can be up to 64 characters long.

status String

The status of user. Valid values: Disabled, Enabled.

userId String

The User ID of the group.

userName String

The name of user. The name must be 1 to 64 characters in length and can contain letters, digits, at signs (@), periods (.), underscores (_), and hyphens (-).

Import

Cloud SSO User can be imported using the id, e.g.

 $ pulumi import alicloud:cloudsso/user:User example <directory_id>:<user_id>

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.