Skip to content

Latest commit

 

History

History
3189 lines (2018 loc) · 110 KB

user.go.md

File metadata and controls

3189 lines (2018 loc) · 110 KB

user Submodule

Constructs

User

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

Initializers

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/user"

user.NewUser(scope Construct, id *string, config UserConfig) User
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config UserConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

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

ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget
func AddMoveTarget(moveTarget *string)

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
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

MoveFromId
func MoveFromId(id *string)

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
func MoveTo(moveTarget *string, index interface{})

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: interface{}

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


MoveToId
func MoveToId(id *string)

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
func PutPasswordHash(value UserPasswordHash)
valueRequired

ResetCity
func ResetCity()
ResetCostCenter
func ResetCostCenter()
ResetCountryCode
func ResetCountryCode()
ResetCustomProfileAttributes
func ResetCustomProfileAttributes()
ResetCustomProfileAttributesToIgnore
func ResetCustomProfileAttributesToIgnore()
ResetDepartment
func ResetDepartment()
ResetDisplayName
func ResetDisplayName()
ResetDivision
func ResetDivision()
ResetEmployeeNumber
func ResetEmployeeNumber()
ResetExpirePasswordOnCreate
func ResetExpirePasswordOnCreate()
ResetHonorificPrefix
func ResetHonorificPrefix()
ResetHonorificSuffix
func ResetHonorificSuffix()
ResetId
func ResetId()
ResetLocale
func ResetLocale()
ResetManager
func ResetManager()
ResetManagerId
func ResetManagerId()
ResetMiddleName
func ResetMiddleName()
ResetMobilePhone
func ResetMobilePhone()
ResetNickName
func ResetNickName()
ResetOldPassword
func ResetOldPassword()
ResetOrganization
func ResetOrganization()
ResetPassword
func ResetPassword()
ResetPasswordHash
func ResetPasswordHash()
ResetPasswordInlineHook
func ResetPasswordInlineHook()
ResetPostalAddress
func ResetPostalAddress()
ResetPreferredLanguage
func ResetPreferredLanguage()
ResetPrimaryPhone
func ResetPrimaryPhone()
ResetProfileUrl
func ResetProfileUrl()
ResetRecoveryAnswer
func ResetRecoveryAnswer()
ResetRecoveryQuestion
func ResetRecoveryQuestion()
ResetSecondEmail
func ResetSecondEmail()
ResetSkipRoles
func ResetSkipRoles()
ResetState
func ResetState()
ResetStatus
func ResetStatus()
ResetStreetAddress
func ResetStreetAddress()
ResetTimezone
func ResetTimezone()
ResetTitle
func ResetTitle()
ResetUserType
func ResetUserType()
ResetZipCode
func 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
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/user"

user.User_IsConstruct(x interface{}) *bool

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: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/user"

user.User_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/user"

user.User_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/user"

user.User_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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.8.1/docs/resources/user#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} 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 interface{} 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 interface{} 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 interface{} 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 interface{} 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
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
func Connection() interface{}
  • Type: interface{}

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
func Provisioners() *[]interface{}
  • Type: *[]interface{}

PasswordHashRequired
func PasswordHash() UserPasswordHashOutputReference

RawStatusRequired
func RawStatus() *string
  • Type: *string

CityInputOptional
func CityInput() *string
  • Type: *string

CostCenterInputOptional
func CostCenterInput() *string
  • Type: *string

CountryCodeInputOptional
func CountryCodeInput() *string
  • Type: *string

CustomProfileAttributesInputOptional
func CustomProfileAttributesInput() *string
  • Type: *string

CustomProfileAttributesToIgnoreInputOptional
func CustomProfileAttributesToIgnoreInput() *[]*string
  • Type: *[]*string

DepartmentInputOptional
func DepartmentInput() *string
  • Type: *string

DisplayNameInputOptional
func DisplayNameInput() *string
  • Type: *string

DivisionInputOptional
func DivisionInput() *string
  • Type: *string

EmailInputOptional
func EmailInput() *string
  • Type: *string

EmployeeNumberInputOptional
func EmployeeNumberInput() *string
  • Type: *string

ExpirePasswordOnCreateInputOptional
func ExpirePasswordOnCreateInput() interface{}
  • Type: interface{}

FirstNameInputOptional
func FirstNameInput() *string
  • Type: *string

HonorificPrefixInputOptional
func HonorificPrefixInput() *string
  • Type: *string

HonorificSuffixInputOptional
func HonorificSuffixInput() *string
  • Type: *string

IdInputOptional
func IdInput() *string
  • Type: *string

LastNameInputOptional
func LastNameInput() *string
  • Type: *string

LocaleInputOptional
func LocaleInput() *string
  • Type: *string

LoginInputOptional
func LoginInput() *string
  • Type: *string

ManagerIdInputOptional
func ManagerIdInput() *string
  • Type: *string

ManagerInputOptional
func ManagerInput() *string
  • Type: *string

MiddleNameInputOptional
func MiddleNameInput() *string
  • Type: *string

MobilePhoneInputOptional
func MobilePhoneInput() *string
  • Type: *string

NickNameInputOptional
func NickNameInput() *string
  • Type: *string

OldPasswordInputOptional
func OldPasswordInput() *string
  • Type: *string

OrganizationInputOptional
func OrganizationInput() *string
  • Type: *string

PasswordHashInputOptional
func PasswordHashInput() UserPasswordHash

PasswordInlineHookInputOptional
func PasswordInlineHookInput() *string
  • Type: *string

PasswordInputOptional
func PasswordInput() *string
  • Type: *string

PostalAddressInputOptional
func PostalAddressInput() *string
  • Type: *string

PreferredLanguageInputOptional
func PreferredLanguageInput() *string
  • Type: *string

PrimaryPhoneInputOptional
func PrimaryPhoneInput() *string
  • Type: *string

ProfileUrlInputOptional
func ProfileUrlInput() *string
  • Type: *string

RecoveryAnswerInputOptional
func RecoveryAnswerInput() *string
  • Type: *string

RecoveryQuestionInputOptional
func RecoveryQuestionInput() *string
  • Type: *string

SecondEmailInputOptional
func SecondEmailInput() *string
  • Type: *string

SkipRolesInputOptional
func SkipRolesInput() interface{}
  • Type: interface{}

StateInputOptional
func StateInput() *string
  • Type: *string

StatusInputOptional
func StatusInput() *string
  • Type: *string

StreetAddressInputOptional
func StreetAddressInput() *string
  • Type: *string

TimezoneInputOptional
func TimezoneInput() *string
  • Type: *string

TitleInputOptional
func TitleInput() *string
  • Type: *string

UserTypeInputOptional
func UserTypeInput() *string
  • Type: *string

ZipCodeInputOptional
func ZipCodeInput() *string
  • Type: *string

CityRequired
func City() *string
  • Type: *string

CostCenterRequired
func CostCenter() *string
  • Type: *string

CountryCodeRequired
func CountryCode() *string
  • Type: *string

CustomProfileAttributesRequired
func CustomProfileAttributes() *string
  • Type: *string

CustomProfileAttributesToIgnoreRequired
func CustomProfileAttributesToIgnore() *[]*string
  • Type: *[]*string

DepartmentRequired
func Department() *string
  • Type: *string

DisplayNameRequired
func DisplayName() *string
  • Type: *string

DivisionRequired
func Division() *string
  • Type: *string

EmailRequired
func Email() *string
  • Type: *string

EmployeeNumberRequired
func EmployeeNumber() *string
  • Type: *string

ExpirePasswordOnCreateRequired
func ExpirePasswordOnCreate() interface{}
  • Type: interface{}

FirstNameRequired
func FirstName() *string
  • Type: *string

HonorificPrefixRequired
func HonorificPrefix() *string
  • Type: *string

HonorificSuffixRequired
func HonorificSuffix() *string
  • Type: *string

IdRequired
func Id() *string
  • Type: *string

LastNameRequired
func LastName() *string
  • Type: *string

LocaleRequired
func Locale() *string
  • Type: *string

LoginRequired
func Login() *string
  • Type: *string

ManagerRequired
func Manager() *string
  • Type: *string

ManagerIdRequired
func ManagerId() *string
  • Type: *string

MiddleNameRequired
func MiddleName() *string
  • Type: *string

MobilePhoneRequired
func MobilePhone() *string
  • Type: *string

NickNameRequired
func NickName() *string
  • Type: *string

OldPasswordRequired
func OldPassword() *string
  • Type: *string

OrganizationRequired
func Organization() *string
  • Type: *string

PasswordRequired
func Password() *string
  • Type: *string

PasswordInlineHookRequired
func PasswordInlineHook() *string
  • Type: *string

PostalAddressRequired
func PostalAddress() *string
  • Type: *string

PreferredLanguageRequired
func PreferredLanguage() *string
  • Type: *string

PrimaryPhoneRequired
func PrimaryPhone() *string
  • Type: *string

ProfileUrlRequired
func ProfileUrl() *string
  • Type: *string

RecoveryAnswerRequired
func RecoveryAnswer() *string
  • Type: *string

RecoveryQuestionRequired
func RecoveryQuestion() *string
  • Type: *string

SecondEmailRequired
func SecondEmail() *string
  • Type: *string

SkipRolesRequired
func SkipRoles() interface{}
  • Type: interface{}

StateRequired
func State() *string
  • Type: *string

StatusRequired
func Status() *string
  • Type: *string

StreetAddressRequired
func StreetAddress() *string
  • Type: *string

TimezoneRequired
func Timezone() *string
  • Type: *string

TitleRequired
func Title() *string
  • Type: *string

UserTypeRequired
func UserType() *string
  • Type: *string

ZipCodeRequired
func ZipCode() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

UserConfig

Initializer

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/user"

&user.UserConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Email: *string,
	FirstName: *string,
	LastName: *string,
	Login: *string,
	City: *string,
	CostCenter: *string,
	CountryCode: *string,
	CustomProfileAttributes: *string,
	CustomProfileAttributesToIgnore: *[]*string,
	Department: *string,
	DisplayName: *string,
	Division: *string,
	EmployeeNumber: *string,
	ExpirePasswordOnCreate: interface{},
	HonorificPrefix: *string,
	HonorificSuffix: *string,
	Id: *string,
	Locale: *string,
	Manager: *string,
	ManagerId: *string,
	MiddleName: *string,
	MobilePhone: *string,
	NickName: *string,
	OldPassword: *string,
	Organization: *string,
	Password: *string,
	PasswordHash: github.com/cdktf/cdktf-provider-okta-go/okta/v13.user.UserPasswordHash,
	PasswordInlineHook: *string,
	PostalAddress: *string,
	PreferredLanguage: *string,
	PrimaryPhone: *string,
	ProfileUrl: *string,
	RecoveryAnswer: *string,
	RecoveryQuestion: *string,
	SecondEmail: *string,
	SkipRoles: interface{},
	State: *string,
	Status: *string,
	StreetAddress: *string,
	Timezone: *string,
	Title: *string,
	UserType: *string,
	ZipCode: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} 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 interface{} 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.8.1/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 interface{} 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
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

EmailRequired
Email *string
  • Type: *string

User primary email address.

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


FirstNameRequired
FirstName *string
  • Type: *string

User first name.

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


LastNameRequired
LastName *string
  • Type: *string

User last name.

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


LoginRequired
Login *string
  • Type: *string

User Okta login.

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


CityOptional
City *string
  • Type: *string

User city.

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


CostCenterOptional
CostCenter *string
  • Type: *string

User cost center.

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


CountryCodeOptional
CountryCode *string
  • Type: *string

User country code.

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


CustomProfileAttributesOptional
CustomProfileAttributes *string
  • 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.8.1/docs/resources/user#custom_profile_attributes User#custom_profile_attributes}


CustomProfileAttributesToIgnoreOptional
CustomProfileAttributesToIgnore *[]*string
  • 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.8.1/docs/resources/user#custom_profile_attributes_to_ignore User#custom_profile_attributes_to_ignore}


DepartmentOptional
Department *string
  • Type: *string

User department.

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


DisplayNameOptional
DisplayName *string
  • Type: *string

User display name, suitable to show end users.

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


DivisionOptional
Division *string
  • Type: *string

User division.

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


EmployeeNumberOptional
EmployeeNumber *string
  • Type: *string

User employee number.

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


ExpirePasswordOnCreateOptional
ExpirePasswordOnCreate interface{}
  • Type: interface{}

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.8.1/docs/resources/user#expire_password_on_create User#expire_password_on_create}


HonorificPrefixOptional
HonorificPrefix *string
  • Type: *string

User honorific prefix.

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


HonorificSuffixOptional
HonorificSuffix *string
  • Type: *string

User honorific suffix.

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


IdOptional
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/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
Locale *string
  • Type: *string

User default location.

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


ManagerOptional
Manager *string
  • Type: *string

Manager of User.

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


ManagerIdOptional
ManagerId *string
  • Type: *string

Manager ID of User.

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


MiddleNameOptional
MiddleName *string
  • Type: *string

User middle name.

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


MobilePhoneOptional
MobilePhone *string
  • Type: *string

User mobile phone number.

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


NickNameOptional
NickName *string
  • Type: *string

User nickname.

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


OldPasswordOptional
OldPassword *string
  • 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.8.1/docs/resources/user#old_password User#old_password}


OrganizationOptional
Organization *string
  • Type: *string

User organization.

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


PasswordOptional
Password *string
  • Type: *string

User Password.

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


PasswordHashOptional
PasswordHash UserPasswordHash

password_hash block.

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


PasswordInlineHookOptional
PasswordInlineHook *string
  • 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.8.1/docs/resources/user#password_inline_hook User#password_inline_hook}


PostalAddressOptional
PostalAddress *string
  • Type: *string

User mailing address.

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


PreferredLanguageOptional
PreferredLanguage *string
  • Type: *string

User preferred language.

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


PrimaryPhoneOptional
PrimaryPhone *string
  • Type: *string

User primary phone number.

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


ProfileUrlOptional
ProfileUrl *string
  • Type: *string

User online profile (web page).

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


RecoveryAnswerOptional
RecoveryAnswer *string
  • Type: *string

User Password Recovery Answer.

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


RecoveryQuestionOptional
RecoveryQuestion *string
  • Type: *string

User Password Recovery Question.

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


SecondEmailOptional
SecondEmail *string
  • Type: *string

User secondary email address, used for account recovery.

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


SkipRolesOptional
SkipRoles interface{}
  • Type: interface{}

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

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


StateOptional
State *string
  • Type: *string

User state or region.

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


StatusOptional
Status *string
  • 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.8.1/docs/resources/user#status User#status}


StreetAddressOptional
StreetAddress *string
  • Type: *string

User street address.

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


TimezoneOptional
Timezone *string
  • Type: *string

User default timezone.

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


TitleOptional
Title *string
  • Type: *string

User title.

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


UserTypeOptional
UserType *string
  • Type: *string

User employee type.

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


ZipCodeOptional
ZipCode *string
  • Type: *string

User zipcode or postal code.

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


UserPasswordHash

Initializer

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/user"

&user.UserPasswordHash {
	Algorithm: *string,
	Value: *string,
	Salt: *string,
	SaltOrder: *string,
	WorkFactor: *f64,
}

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 *f64 Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm.

AlgorithmRequired
Algorithm *string
  • 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.8.1/docs/resources/user#algorithm User#algorithm}


ValueRequired
Value *string
  • 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.8.1/docs/resources/user#value User#value}


SaltOptional
Salt *string
  • Type: *string

Only required for salted hashes.

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


SaltOrderOptional
SaltOrder *string
  • 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.8.1/docs/resources/user#salt_order User#salt_order}


WorkFactorOptional
WorkFactor *f64
  • Type: *f64

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.8.1/docs/resources/user#work_factor User#work_factor}


Classes

UserPasswordHashOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/user"

user.NewUserPasswordHashOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) UserPasswordHashOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/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
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetSalt
func ResetSalt()
ResetSaltOrder
func ResetSaltOrder()
ResetWorkFactor
func 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 *f64 No description.
Algorithm *string No description.
Salt *string No description.
SaltOrder *string No description.
Value *string No description.
WorkFactor *f64 No description.
InternalValue UserPasswordHash No description.

CreationStackRequired
func CreationStack() *[]*string
  • 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
func Fqn() *string
  • Type: *string

AlgorithmInputOptional
func AlgorithmInput() *string
  • Type: *string

SaltInputOptional
func SaltInput() *string
  • Type: *string

SaltOrderInputOptional
func SaltOrderInput() *string
  • Type: *string

ValueInputOptional
func ValueInput() *string
  • Type: *string

WorkFactorInputOptional
func WorkFactorInput() *f64
  • Type: *f64

AlgorithmRequired
func Algorithm() *string
  • Type: *string

SaltRequired
func Salt() *string
  • Type: *string

SaltOrderRequired
func SaltOrder() *string
  • Type: *string

ValueRequired
func Value() *string
  • Type: *string

WorkFactorRequired
func WorkFactor() *f64
  • Type: *f64

InternalValueOptional
func InternalValue() UserPasswordHash