Class User
Manages a V3 User resource within OpenStack Keystone.
Note: You must have admin privileges in your OpenStack cloud to use this resource.
Example Usage
using Pulumi;
using OpenStack = Pulumi.OpenStack;
class MyStack : Stack
{
public MyStack()
{
var project1 = new OpenStack.Identity.Project("project1", new OpenStack.Identity.ProjectArgs
{
});
var user1 = new OpenStack.Identity.User("user1", new OpenStack.Identity.UserArgs
{
DefaultProjectId = project1.Id,
Description = "A user",
Extra =
{
{ "email", "user_1@foobar.com" },
},
IgnoreChangePasswordUponFirstUse = true,
MultiFactorAuthEnabled = true,
MultiFactorAuthRules =
{
new OpenStack.Identity.Inputs.UserMultiFactorAuthRuleArgs
{
Rule =
{
"password",
"totp",
},
},
new OpenStack.Identity.Inputs.UserMultiFactorAuthRuleArgs
{
Rule =
{
"password",
},
},
},
Password = "password123",
});
}
}
Inherited Members
Namespace: Pulumi.OpenStack.Identity
Assembly: Pulumi.OpenStack.dll
Syntax
public class User : CustomResource
Constructors
View SourceUser(String, UserArgs, CustomResourceOptions)
Create a User resource with the given unique name, arguments, and options.
Declaration
public User(string name, UserArgs args = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| UserArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceDefaultProjectId
The default project this user belongs to.
Declaration
public Output<string> DefaultProjectId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Description
A description of the user.
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
DomainId
The domain this user belongs to.
Declaration
public Output<string> DomainId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Enabled
Whether the user is enabled or disabled. Valid
values are true and false.
Declaration
public Output<bool?> Enabled { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
Extra
Free-form key/value pairs of extra information.
Declaration
public Output<ImmutableDictionary<string, object>> Extra { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>> |
IgnoreChangePasswordUponFirstUse
User will not have to
change their password upon first use. Valid values are true and false.
Declaration
public Output<bool?> IgnoreChangePasswordUponFirstUse { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
IgnoreLockoutFailureAttempts
User will not have a failure
lockout placed on their account. Valid values are true and false.
Declaration
public Output<bool?> IgnoreLockoutFailureAttempts { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
IgnorePasswordExpiry
User's password will not expire.
Valid values are true and false.
Declaration
public Output<bool?> IgnorePasswordExpiry { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
MultiFactorAuthEnabled
Whether to enable multi-factor
authentication. Valid values are true and false.
Declaration
public Output<bool?> MultiFactorAuthEnabled { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
MultiFactorAuthRules
A multi-factor authentication rule. The structure is documented below. Please see the Ocata release notes for more information on how to use mulit-factor rules.
Declaration
public Output<ImmutableArray<UserMultiFactorAuthRule>> MultiFactorAuthRules { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<UserMultiFactorAuthRule>> |
Name
The name of the user.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Password
The password for the user.
Declaration
public Output<string> Password { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Region
The region in which to obtain the V3 Keystone client.
If omitted, the region argument of the provider is used. Changing this
creates a new User.
Declaration
public Output<string> Region { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, UserState, CustomResourceOptions)
Get an existing User resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static User Get(string name, Input<string> id, UserState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| UserState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| User |