Class Password
Creates a Password Policy.
This resource allows you to create and configure a Password Policy.
Example Usage
using Pulumi;
using Okta = Pulumi.Okta;
class MyStack : Stack
{
public MyStack()
{
var example = new Okta.Policy.Password("example", new Okta.Policy.PasswordArgs
{
Description = "Example",
GroupsIncludeds =
{
data.Okta_group.Everyone.Id,
},
PasswordHistoryCount = 4,
Status = "ACTIVE",
});
}
}
Inherited Members
Namespace: Pulumi.Okta.Policy
Assembly: Pulumi.Okta.dll
Syntax
public class Password : CustomResource
Constructors
View SourcePassword(String, PasswordArgs, CustomResourceOptions)
Create a Password resource with the given unique name, arguments, and options.
Declaration
public Password(string name, PasswordArgs args = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| PasswordArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceAuthProvider
Authentication Provider: "OKTA" or "ACTIVE_DIRECTORY". Default is "OKTA".
Declaration
public Output<string> AuthProvider { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Description
Policy Description.
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
EmailRecovery
Enable or disable email password recovery: ACTIVE or INACTIVE.
Declaration
public Output<string> EmailRecovery { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
GroupsIncludeds
List of Group IDs to Include.
Declaration
public Output<ImmutableArray<string>> GroupsIncludeds { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<System.String>> |
Name
Policy Name.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PasswordAutoUnlockMinutes
Number of minutes before a locked account is unlocked: 0 = no limit.
Declaration
public Output<int?> PasswordAutoUnlockMinutes { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordDictionaryLookup
Check Passwords Against Common Password Dictionary.
Declaration
public Output<bool?> PasswordDictionaryLookup { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
PasswordExcludeFirstName
User firstName attribute must be excluded from the password.
Declaration
public Output<bool?> PasswordExcludeFirstName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
PasswordExcludeLastName
User lastName attribute must be excluded from the password.
Declaration
public Output<bool?> PasswordExcludeLastName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
PasswordExcludeUsername
If the user name must be excluded from the password.
Declaration
public Output<bool?> PasswordExcludeUsername { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
PasswordExpireWarnDays
Length in days a user will be warned before password expiry: 0 = no warning.
Declaration
public Output<int?> PasswordExpireWarnDays { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordHistoryCount
Number of distinct passwords that must be created before they can be reused: 0 = none.
Declaration
public Output<int?> PasswordHistoryCount { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordMaxAgeDays
Length in days a password is valid before expiry: 0 = no limit.",
Declaration
public Output<int?> PasswordMaxAgeDays { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordMaxLockoutAttempts
Number of unsuccessful login attempts allowed before lockout: 0 = no limit.
Declaration
public Output<int?> PasswordMaxLockoutAttempts { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordMinAgeMinutes
Minimum time interval in minutes between password changes: 0 = no limit.
Declaration
public Output<int?> PasswordMinAgeMinutes { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordMinLength
Minimum password length. Default is 8.
Declaration
public Output<int?> PasswordMinLength { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordMinLowercase
Minimum number of lower case characters in password.
Declaration
public Output<int?> PasswordMinLowercase { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordMinNumber
Minimum number of numbers in password.
Declaration
public Output<int?> PasswordMinNumber { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordMinSymbol
Minimum number of symbols in password.
Declaration
public Output<int?> PasswordMinSymbol { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordMinUppercase
Minimum number of upper case characters in password.
Declaration
public Output<int?> PasswordMinUppercase { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
PasswordShowLockoutFailures
If a user should be informed when their account is locked.
Declaration
public Output<bool?> PasswordShowLockoutFailures { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
Priority
Priority of the policy.
Declaration
public Output<int?> Priority { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
QuestionMinLength
Min length of the password recovery question answer.
Declaration
public Output<int?> QuestionMinLength { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
QuestionRecovery
Enable or disable security question password recovery: ACTIVE or INACTIVE.
Declaration
public Output<string> QuestionRecovery { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
RecoveryEmailToken
Lifetime in minutes of the recovery email token.
Declaration
public Output<int?> RecoveryEmailToken { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Int32>> |
SkipUnlock
When an Active Directory user is locked out of Okta, the Okta unlock operation should also attempt to unlock the user's Windows account.
Declaration
public Output<bool?> SkipUnlock { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
SmsRecovery
Enable or disable SMS password recovery: ACTIVE or INACTIVE.
Declaration
public Output<string> SmsRecovery { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Status
Policy Status: "ACTIVE" or "INACTIVE".
Declaration
public Output<string> Status { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, PasswordState, CustomResourceOptions)
Get an existing Password resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Password Get(string name, Input<string> id, PasswordState 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. |
| PasswordState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Password |