Skip to content

Latest commit

 

History

History
3189 lines (2018 loc) · 112 KB

user.csharp.md

File metadata and controls

3189 lines (2018 loc) · 112 KB
Raw

user Submodule

Constructs

User

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user okta_user}.

Initializers 

using HashiCorp.Cdktf.Providers.Okta;

new User(Construct Scope, string Id, UserConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config UserConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutPasswordHash No description.
ResetCity No description.
ResetCostCenter No description.
ResetCountryCode No description.
ResetCustomProfileAttributes No description.
ResetCustomProfileAttributesToIgnore No description.
ResetDepartment No description.
ResetDisplayName No description.
ResetDivision No description.
ResetEmployeeNumber No description.
ResetExpirePasswordOnCreate No description.
ResetHonorificPrefix No description.
ResetHonorificSuffix No description.
ResetId No description.
ResetLocale No description.
ResetManager No description.
ResetManagerId No description.
ResetMiddleName No description.
ResetMobilePhone No description.
ResetNickName No description.
ResetOldPassword No description.
ResetOrganization No description.
ResetPassword No description.
ResetPasswordHash No description.
ResetPasswordInlineHook No description.
ResetPostalAddress No description.
ResetPreferredLanguage No description.
ResetPrimaryPhone No description.
ResetProfileUrl No description.
ResetRecoveryAnswer No description.
ResetRecoveryQuestion No description.
ResetSecondEmail No description.
ResetSkipRoles No description.
ResetState No description.
ResetStatus No description.
ResetStreetAddress No description.
ResetTimezone No description.
ResetTitle No description.
ResetUserType No description.
ResetZipCode No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

PutPasswordHash 
private void PutPasswordHash(UserPasswordHash Value)
ValueRequired
ResetCity 
private void ResetCity()
ResetCostCenter 
private void ResetCostCenter()
ResetCountryCode 
private void ResetCountryCode()
ResetCustomProfileAttributes 
private void ResetCustomProfileAttributes()
ResetCustomProfileAttributesToIgnore 
private void ResetCustomProfileAttributesToIgnore()
ResetDepartment 
private void ResetDepartment()
ResetDisplayName 
private void ResetDisplayName()
ResetDivision 
private void ResetDivision()
ResetEmployeeNumber 
private void ResetEmployeeNumber()
ResetExpirePasswordOnCreate 
private void ResetExpirePasswordOnCreate()
ResetHonorificPrefix 
private void ResetHonorificPrefix()
ResetHonorificSuffix 
private void ResetHonorificSuffix()
ResetId 
private void ResetId()
ResetLocale 
private void ResetLocale()
ResetManager 
private void ResetManager()
ResetManagerId 
private void ResetManagerId()
ResetMiddleName 
private void ResetMiddleName()
ResetMobilePhone 
private void ResetMobilePhone()
ResetNickName 
private void ResetNickName()
ResetOldPassword 
private void ResetOldPassword()
ResetOrganization 
private void ResetOrganization()
ResetPassword 
private void ResetPassword()
ResetPasswordHash 
private void ResetPasswordHash()
ResetPasswordInlineHook 
private void ResetPasswordInlineHook()
ResetPostalAddress 
private void ResetPostalAddress()
ResetPreferredLanguage 
private void ResetPreferredLanguage()
ResetPrimaryPhone 
private void ResetPrimaryPhone()
ResetProfileUrl 
private void ResetProfileUrl()
ResetRecoveryAnswer 
private void ResetRecoveryAnswer()
ResetRecoveryQuestion 
private void ResetRecoveryQuestion()
ResetSecondEmail 
private void ResetSecondEmail()
ResetSkipRoles 
private void ResetSkipRoles()
ResetState 
private void ResetState()
ResetStatus 
private void ResetStatus()
ResetStreetAddress 
private void ResetStreetAddress()
ResetTimezone 
private void ResetTimezone()
ResetTitle 
private void ResetTitle()
ResetUserType 
private void ResetUserType()
ResetZipCode 
private void ResetZipCode()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a User resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Okta;

User.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Okta;

User.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Okta;

User.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Okta;

User.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a User resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

The construct id used in the generated config for the User to import.

ImportFromIdRequired
  • Type: string

The id of the existing User that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#import import section} in the documentation of this resource for the id to use

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the User to import is found.

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
PasswordHash UserPasswordHashOutputReference No description.
RawStatus string No description.
CityInput string No description.
CostCenterInput string No description.
CountryCodeInput string No description.
CustomProfileAttributesInput string No description.
CustomProfileAttributesToIgnoreInput string[] No description.
DepartmentInput string No description.
DisplayNameInput string No description.
DivisionInput string No description.
EmailInput string No description.
EmployeeNumberInput string No description.
ExpirePasswordOnCreateInput object No description.
FirstNameInput string No description.
HonorificPrefixInput string No description.
HonorificSuffixInput string No description.
IdInput string No description.
LastNameInput string No description.
LocaleInput string No description.
LoginInput string No description.
ManagerIdInput string No description.
ManagerInput string No description.
MiddleNameInput string No description.
MobilePhoneInput string No description.
NickNameInput string No description.
OldPasswordInput string No description.
OrganizationInput string No description.
PasswordHashInput UserPasswordHash No description.
PasswordInlineHookInput string No description.
PasswordInput string No description.
PostalAddressInput string No description.
PreferredLanguageInput string No description.
PrimaryPhoneInput string No description.
ProfileUrlInput string No description.
RecoveryAnswerInput string No description.
RecoveryQuestionInput string No description.
SecondEmailInput string No description.
SkipRolesInput object No description.
StateInput string No description.
StatusInput string No description.
StreetAddressInput string No description.
TimezoneInput string No description.
TitleInput string No description.
UserTypeInput string No description.
ZipCodeInput string No description.
City string No description.
CostCenter string No description.
CountryCode string No description.
CustomProfileAttributes string No description.
CustomProfileAttributesToIgnore string[] No description.
Department string No description.
DisplayName string No description.
Division string No description.
Email string No description.
EmployeeNumber string No description.
ExpirePasswordOnCreate object No description.
FirstName string No description.
HonorificPrefix string No description.
HonorificSuffix string No description.
Id string No description.
LastName string No description.
Locale string No description.
Login string No description.
Manager string No description.
ManagerId string No description.
MiddleName string No description.
MobilePhone string No description.
NickName string No description.
OldPassword string No description.
Organization string No description.
Password string No description.
PasswordInlineHook string No description.
PostalAddress string No description.
PreferredLanguage string No description.
PrimaryPhone string No description.
ProfileUrl string No description.
RecoveryAnswer string No description.
RecoveryQuestion string No description.
SecondEmail string No description.
SkipRoles object No description.
State string No description.
Status string No description.
StreetAddress string No description.
Timezone string No description.
Title string No description.
UserType string No description.
ZipCode string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
public object Connection { get; }
  • Type: object
CountOptional 
public object Count { get; }
  • Type: object
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
PasswordHashRequired 
public UserPasswordHashOutputReference PasswordHash { get; }
RawStatusRequired 
public string RawStatus { get; }
  • Type: string
CityInputOptional 
public string CityInput { get; }
  • Type: string
CostCenterInputOptional 
public string CostCenterInput { get; }
  • Type: string
CountryCodeInputOptional 
public string CountryCodeInput { get; }
  • Type: string
CustomProfileAttributesInputOptional 
public string CustomProfileAttributesInput { get; }
  • Type: string
CustomProfileAttributesToIgnoreInputOptional 
public string[] CustomProfileAttributesToIgnoreInput { get; }
  • Type: string[]
DepartmentInputOptional 
public string DepartmentInput { get; }
  • Type: string
DisplayNameInputOptional 
public string DisplayNameInput { get; }
  • Type: string
DivisionInputOptional 
public string DivisionInput { get; }
  • Type: string
EmailInputOptional 
public string EmailInput { get; }
  • Type: string
EmployeeNumberInputOptional 
public string EmployeeNumberInput { get; }
  • Type: string
ExpirePasswordOnCreateInputOptional 
public object ExpirePasswordOnCreateInput { get; }
  • Type: object
FirstNameInputOptional 
public string FirstNameInput { get; }
  • Type: string
HonorificPrefixInputOptional 
public string HonorificPrefixInput { get; }
  • Type: string
HonorificSuffixInputOptional 
public string HonorificSuffixInput { get; }
  • Type: string
IdInputOptional 
public string IdInput { get; }
  • Type: string
LastNameInputOptional 
public string LastNameInput { get; }
  • Type: string
LocaleInputOptional 
public string LocaleInput { get; }
  • Type: string
LoginInputOptional 
public string LoginInput { get; }
  • Type: string
ManagerIdInputOptional 
public string ManagerIdInput { get; }
  • Type: string
ManagerInputOptional 
public string ManagerInput { get; }
  • Type: string
MiddleNameInputOptional 
public string MiddleNameInput { get; }
  • Type: string
MobilePhoneInputOptional 
public string MobilePhoneInput { get; }
  • Type: string
NickNameInputOptional 
public string NickNameInput { get; }
  • Type: string
OldPasswordInputOptional 
public string OldPasswordInput { get; }
  • Type: string
OrganizationInputOptional 
public string OrganizationInput { get; }
  • Type: string
PasswordHashInputOptional 
public UserPasswordHash PasswordHashInput { get; }
PasswordInlineHookInputOptional 
public string PasswordInlineHookInput { get; }
  • Type: string
PasswordInputOptional 
public string PasswordInput { get; }
  • Type: string
PostalAddressInputOptional 
public string PostalAddressInput { get; }
  • Type: string
PreferredLanguageInputOptional 
public string PreferredLanguageInput { get; }
  • Type: string
PrimaryPhoneInputOptional 
public string PrimaryPhoneInput { get; }
  • Type: string
ProfileUrlInputOptional 
public string ProfileUrlInput { get; }
  • Type: string
RecoveryAnswerInputOptional 
public string RecoveryAnswerInput { get; }
  • Type: string
RecoveryQuestionInputOptional 
public string RecoveryQuestionInput { get; }
  • Type: string
SecondEmailInputOptional 
public string SecondEmailInput { get; }
  • Type: string
SkipRolesInputOptional 
public object SkipRolesInput { get; }
  • Type: object
StateInputOptional 
public string StateInput { get; }
  • Type: string
StatusInputOptional 
public string StatusInput { get; }
  • Type: string
StreetAddressInputOptional 
public string StreetAddressInput { get; }
  • Type: string
TimezoneInputOptional 
public string TimezoneInput { get; }
  • Type: string
TitleInputOptional 
public string TitleInput { get; }
  • Type: string
UserTypeInputOptional 
public string UserTypeInput { get; }
  • Type: string
ZipCodeInputOptional 
public string ZipCodeInput { get; }
  • Type: string
CityRequired 
public string City { get; }
  • Type: string
CostCenterRequired 
public string CostCenter { get; }
  • Type: string
CountryCodeRequired 
public string CountryCode { get; }
  • Type: string
CustomProfileAttributesRequired 
public string CustomProfileAttributes { get; }
  • Type: string
CustomProfileAttributesToIgnoreRequired 
public string[] CustomProfileAttributesToIgnore { get; }
  • Type: string[]
DepartmentRequired 
public string Department { get; }
  • Type: string
DisplayNameRequired 
public string DisplayName { get; }
  • Type: string
DivisionRequired 
public string Division { get; }
  • Type: string
EmailRequired 
public string Email { get; }
  • Type: string
EmployeeNumberRequired 
public string EmployeeNumber { get; }
  • Type: string
ExpirePasswordOnCreateRequired 
public object ExpirePasswordOnCreate { get; }
  • Type: object
FirstNameRequired 
public string FirstName { get; }
  • Type: string
HonorificPrefixRequired 
public string HonorificPrefix { get; }
  • Type: string
HonorificSuffixRequired 
public string HonorificSuffix { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
LastNameRequired 
public string LastName { get; }
  • Type: string
LocaleRequired 
public string Locale { get; }
  • Type: string
LoginRequired 
public string Login { get; }
  • Type: string
ManagerRequired 
public string Manager { get; }
  • Type: string
ManagerIdRequired 
public string ManagerId { get; }
  • Type: string
MiddleNameRequired 
public string MiddleName { get; }
  • Type: string
MobilePhoneRequired 
public string MobilePhone { get; }
  • Type: string
NickNameRequired 
public string NickName { get; }
  • Type: string
OldPasswordRequired 
public string OldPassword { get; }
  • Type: string
OrganizationRequired 
public string Organization { get; }
  • Type: string
PasswordRequired 
public string Password { get; }
  • Type: string
PasswordInlineHookRequired 
public string PasswordInlineHook { get; }
  • Type: string
PostalAddressRequired 
public string PostalAddress { get; }
  • Type: string
PreferredLanguageRequired 
public string PreferredLanguage { get; }
  • Type: string
PrimaryPhoneRequired 
public string PrimaryPhone { get; }
  • Type: string
ProfileUrlRequired 
public string ProfileUrl { get; }
  • Type: string
RecoveryAnswerRequired 
public string RecoveryAnswer { get; }
  • Type: string
RecoveryQuestionRequired 
public string RecoveryQuestion { get; }
  • Type: string
SecondEmailRequired 
public string SecondEmail { get; }
  • Type: string
SkipRolesRequired 
public object SkipRoles { get; }
  • Type: object
StateRequired 
public string State { get; }
  • Type: string
StatusRequired 
public string Status { get; }
  • Type: string
StreetAddressRequired 
public string StreetAddress { get; }
  • Type: string
TimezoneRequired 
public string Timezone { get; }
  • Type: string
TitleRequired 
public string Title { get; }
  • Type: string
UserTypeRequired 
public string UserType { get; }
  • Type: string
ZipCodeRequired 
public string ZipCode { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

UserConfig

Initializer 

using HashiCorp.Cdktf.Providers.Okta;

new UserConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Email,
    string FirstName,
    string LastName,
    string Login,
    string City = null,
    string CostCenter = null,
    string CountryCode = null,
    string CustomProfileAttributes = null,
    string[] CustomProfileAttributesToIgnore = null,
    string Department = null,
    string DisplayName = null,
    string Division = null,
    string EmployeeNumber = null,
    object ExpirePasswordOnCreate = null,
    string HonorificPrefix = null,
    string HonorificSuffix = null,
    string Id = null,
    string Locale = null,
    string Manager = null,
    string ManagerId = null,
    string MiddleName = null,
    string MobilePhone = null,
    string NickName = null,
    string OldPassword = null,
    string Organization = null,
    string Password = null,
    UserPasswordHash PasswordHash = null,
    string PasswordInlineHook = null,
    string PostalAddress = null,
    string PreferredLanguage = null,
    string PrimaryPhone = null,
    string ProfileUrl = null,
    string RecoveryAnswer = null,
    string RecoveryQuestion = null,
    string SecondEmail = null,
    object SkipRoles = null,
    string State = null,
    string Status = null,
    string StreetAddress = null,
    string Timezone = null,
    string Title = null,
    string UserType = null,
    string ZipCode = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Email string User primary email address.
FirstName string User first name.
LastName string User last name.
Login string User Okta login.
City string User city.
CostCenter string User cost center.
CountryCode string User country code.
CustomProfileAttributes string JSON formatted custom attributes for a user. It must be JSON due to various types Okta allows.
CustomProfileAttributesToIgnore string[] List of custom_profile_attribute keys that should be excluded from being managed by Terraform.
Department string User department.
DisplayName string User display name, suitable to show end users.
Division string User division.
EmployeeNumber string User employee number.
ExpirePasswordOnCreate object If set to true, the user will have to change the password at the next login.
HonorificPrefix string User honorific prefix.
HonorificSuffix string User honorific suffix.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#id User#id}.
Locale string User default location.
Manager string Manager of User.
ManagerId string Manager ID of User.
MiddleName string User middle name.
MobilePhone string User mobile phone number.
NickName string User nickname.
OldPassword string Old User Password.
Organization string User organization.
Password string User Password.
PasswordHash UserPasswordHash password_hash block.
PasswordInlineHook string Specifies that a Password Import Inline Hook should be triggered to handle verification of the user's password the first time the user logs in.
PostalAddress string User mailing address.
PreferredLanguage string User preferred language.
PrimaryPhone string User primary phone number.
ProfileUrl string User online profile (web page).
RecoveryAnswer string User Password Recovery Answer.
RecoveryQuestion string User Password Recovery Question.
SecondEmail string User secondary email address, used for account recovery.
SkipRoles object Do not populate user roles information (prevents additional API call).
State string User state or region.
Status string User profile property. Valid values are ACTIVE, DEPROVISIONED, STAGED, SUSPENDED. Default: ACTIVE.
StreetAddress string User street address.
Timezone string User default timezone.
Title string User title.
UserType string User employee type.
ZipCode string User zipcode or postal code.
ConnectionOptional 
public object Connection { get; set; }
  • Type: object
CountOptional 
public object Count { get; set; }
  • Type: object
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; set; }
  • Type: object[]
EmailRequired 
public string Email { get; set; }
  • Type: string

User primary email address.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#email User#email}

FirstNameRequired 
public string FirstName { get; set; }
  • Type: string

User first name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#first_name User#first_name}

LastNameRequired 
public string LastName { get; set; }
  • Type: string

User last name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#last_name User#last_name}

LoginRequired 
public string Login { get; set; }
  • Type: string

User Okta login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#login User#login}

CityOptional 
public string City { get; set; }
  • Type: string

User city.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#city User#city}

CostCenterOptional 
public string CostCenter { get; set; }
  • Type: string

User cost center.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#cost_center User#cost_center}

CountryCodeOptional 
public string CountryCode { get; set; }
  • Type: string

User country code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#country_code User#country_code}

CustomProfileAttributesOptional 
public string CustomProfileAttributes { get; set; }
  • Type: string

JSON formatted custom attributes for a user. It must be JSON due to various types Okta allows.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#custom_profile_attributes User#custom_profile_attributes}

CustomProfileAttributesToIgnoreOptional 
public string[] CustomProfileAttributesToIgnore { get; set; }
  • Type: string[]

List of custom_profile_attribute keys that should be excluded from being managed by Terraform.

This is useful in situations where specific custom fields may contain sensitive information and should be managed outside of Terraform.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#custom_profile_attributes_to_ignore User#custom_profile_attributes_to_ignore}

DepartmentOptional 
public string Department { get; set; }
  • Type: string

User department.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#department User#department}

DisplayNameOptional 
public string DisplayName { get; set; }
  • Type: string

User display name, suitable to show end users.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#display_name User#display_name}

DivisionOptional 
public string Division { get; set; }
  • Type: string

User division.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#division User#division}

EmployeeNumberOptional 
public string EmployeeNumber { get; set; }
  • Type: string

User employee number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#employee_number User#employee_number}

ExpirePasswordOnCreateOptional 
public object ExpirePasswordOnCreate { get; set; }
  • Type: object

If set to true, the user will have to change the password at the next login.

This property will be used when user is being created and works only when password field is set. Default: false

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#expire_password_on_create User#expire_password_on_create}

HonorificPrefixOptional 
public string HonorificPrefix { get; set; }
  • Type: string

User honorific prefix.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#honorific_prefix User#honorific_prefix}

HonorificSuffixOptional 
public string HonorificSuffix { get; set; }
  • Type: string

User honorific suffix.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#honorific_suffix User#honorific_suffix}

IdOptional 
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#id User#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

LocaleOptional 
public string Locale { get; set; }
  • Type: string

User default location.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#locale User#locale}

ManagerOptional 
public string Manager { get; set; }
  • Type: string

Manager of User.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#manager User#manager}

ManagerIdOptional 
public string ManagerId { get; set; }
  • Type: string

Manager ID of User.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#manager_id User#manager_id}

MiddleNameOptional 
public string MiddleName { get; set; }
  • Type: string

User middle name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#middle_name User#middle_name}

MobilePhoneOptional 
public string MobilePhone { get; set; }
  • Type: string

User mobile phone number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#mobile_phone User#mobile_phone}

NickNameOptional 
public string NickName { get; set; }
  • Type: string

User nickname.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#nick_name User#nick_name}

OldPasswordOptional 
public string OldPassword { get; set; }
  • Type: string

Old User Password.

Should be only set in case the password was not changed using the provider. fter successful password change this field should be removed and password field should be used for further changes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#old_password User#old_password}

OrganizationOptional 
public string Organization { get; set; }
  • Type: string

User organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#organization User#organization}

PasswordOptional 
public string Password { get; set; }
  • Type: string

User Password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#password User#password}

PasswordHashOptional 
public UserPasswordHash PasswordHash { get; set; }

password_hash block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#password_hash User#password_hash}

PasswordInlineHookOptional 
public string PasswordInlineHook { get; set; }
  • Type: string

Specifies that a Password Import Inline Hook should be triggered to handle verification of the user's password the first time the user logs in.

This allows an existing password to be imported into Okta directly from some other store. When updating a user with a password hook the user must be in the STAGED status. The password field should not be specified when using Password Import Inline Hook.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#password_inline_hook User#password_inline_hook}

PostalAddressOptional 
public string PostalAddress { get; set; }
  • Type: string

User mailing address.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#postal_address User#postal_address}

PreferredLanguageOptional 
public string PreferredLanguage { get; set; }
  • Type: string

User preferred language.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#preferred_language User#preferred_language}

PrimaryPhoneOptional 
public string PrimaryPhone { get; set; }
  • Type: string

User primary phone number.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#primary_phone User#primary_phone}

ProfileUrlOptional 
public string ProfileUrl { get; set; }
  • Type: string

User online profile (web page).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#profile_url User#profile_url}

RecoveryAnswerOptional 
public string RecoveryAnswer { get; set; }
  • Type: string

User Password Recovery Answer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#recovery_answer User#recovery_answer}

RecoveryQuestionOptional 
public string RecoveryQuestion { get; set; }
  • Type: string

User Password Recovery Question.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#recovery_question User#recovery_question}

SecondEmailOptional 
public string SecondEmail { get; set; }
  • Type: string

User secondary email address, used for account recovery.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#second_email User#second_email}

SkipRolesOptional 
public object SkipRoles { get; set; }
  • Type: object

Do not populate user roles information (prevents additional API call).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#skip_roles User#skip_roles}

StateOptional 
public string State { get; set; }
  • Type: string

User state or region.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#state User#state}

StatusOptional 
public string Status { get; set; }
  • Type: string

User profile property. Valid values are ACTIVE, DEPROVISIONED, STAGED, SUSPENDED. Default: ACTIVE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#status User#status}

StreetAddressOptional 
public string StreetAddress { get; set; }
  • Type: string

User street address.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#street_address User#street_address}

TimezoneOptional 
public string Timezone { get; set; }
  • Type: string

User default timezone.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#timezone User#timezone}

TitleOptional 
public string Title { get; set; }
  • Type: string

User title.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#title User#title}

UserTypeOptional 
public string UserType { get; set; }
  • Type: string

User employee type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#user_type User#user_type}

ZipCodeOptional 
public string ZipCode { get; set; }
  • Type: string

User zipcode or postal code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#zip_code User#zip_code}

UserPasswordHash

Initializer 

using HashiCorp.Cdktf.Providers.Okta;

new UserPasswordHash {
    string Algorithm,
    string Value,
    string Salt = null,
    string SaltOrder = null,
    double WorkFactor = null
};

Properties

Name Type Description
Algorithm string The algorithm used to generate the hash using the password.
Value string For SHA-512, SHA-256, SHA-1, MD5, This is the actual base64-encoded hash of the password (and salt, if used).
Salt string Only required for salted hashes.
SaltOrder string Specifies whether salt was pre- or postfixed to the password before hashing.
WorkFactor double Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm.
AlgorithmRequired 
public string Algorithm { get; set; }
  • Type: string

The algorithm used to generate the hash using the password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#algorithm User#algorithm}

ValueRequired 
public string Value { get; set; }
  • Type: string

For SHA-512, SHA-256, SHA-1, MD5, This is the actual base64-encoded hash of the password (and salt, if used).

This is the Base64 encoded value of the SHA-512/SHA-256/SHA-1/MD5 digest that was computed by either pre-fixing or post-fixing the salt to the password, depending on the saltOrder. If a salt was not used in the source system, then this should just be the the Base64 encoded value of the password's SHA-512/SHA-256/SHA-1/MD5 digest. For BCRYPT, This is the actual radix64-encoded hashed password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#value User#value}

SaltOptional 
public string Salt { get; set; }
  • Type: string

Only required for salted hashes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#salt User#salt}

SaltOrderOptional 
public string SaltOrder { get; set; }
  • Type: string

Specifies whether salt was pre- or postfixed to the password before hashing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#salt_order User#salt_order}

WorkFactorOptional 
public double WorkFactor { get; set; }
  • Type: double

Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/user#work_factor User#work_factor}

Classes

UserPasswordHashOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Okta;

new UserPasswordHashOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetSalt No description.
ResetSaltOrder No description.
ResetWorkFactor No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetSalt 
private void ResetSalt()
ResetSaltOrder 
private void ResetSaltOrder()
ResetWorkFactor 
private void ResetWorkFactor()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
AlgorithmInput string No description.
SaltInput string No description.
SaltOrderInput string No description.
ValueInput string No description.
WorkFactorInput double No description.
Algorithm string No description.
Salt string No description.
SaltOrder string No description.
Value string No description.
WorkFactor double No description.
InternalValue UserPasswordHash No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
public string Fqn { get; }
  • Type: string
AlgorithmInputOptional 
public string AlgorithmInput { get; }
  • Type: string
SaltInputOptional 
public string SaltInput { get; }
  • Type: string
SaltOrderInputOptional 
public string SaltOrderInput { get; }
  • Type: string
ValueInputOptional 
public string ValueInput { get; }
  • Type: string
WorkFactorInputOptional 
public double WorkFactorInput { get; }
  • Type: double
AlgorithmRequired 
public string Algorithm { get; }
  • Type: string
SaltRequired 
public string Salt { get; }
  • Type: string
SaltOrderRequired 
public string SaltOrder { get; }
  • Type: string
ValueRequired 
public string Value { get; }
  • Type: string
WorkFactorRequired 
public double WorkFactor { get; }
  • Type: double
InternalValueOptional 
public UserPasswordHash InternalValue { get; }