dataoktauser

package
v12.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 18, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

README

data_okta_user

Refer to the Terraform Registory for docs: data_okta_user.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DataOktaUser_GenerateConfigForImport 

func DataOktaUser_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a DataOktaUser resource upon running "cdktf plan <stack-name>".

func DataOktaUser_IsConstruct 

func DataOktaUser_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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DataOktaUser_IsTerraformDataSource 

func DataOktaUser_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataOktaUser_IsTerraformElement 

func DataOktaUser_IsTerraformElement(x interface{}) *bool

Experimental.

func DataOktaUser_TfResourceType 

func DataOktaUser_TfResourceType() *string

func NewDataOktaUserSearchList_Override 

func NewDataOktaUserSearchList_Override(d DataOktaUserSearchList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)

func NewDataOktaUserSearchOutputReference_Override 

func NewDataOktaUserSearchOutputReference_Override(d DataOktaUserSearchOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)

func NewDataOktaUser_Override 

func NewDataOktaUser_Override(d DataOktaUser, scope constructs.Construct, id *string, config *DataOktaUserConfig)

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user okta_user} Data Source.

Types

type DataOktaUser 

type DataOktaUser interface {
	cdktf.TerraformDataSource
	AdminRoles() *[]*string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	City() *string
	CompoundSearchOperator() *string
	SetCompoundSearchOperator(val *string)
	CompoundSearchOperatorInput() *string
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	CostCenter() *string
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	CountryCode() *string
	CustomProfileAttributes() *string
	DelayReadSeconds() *string
	SetDelayReadSeconds(val *string)
	DelayReadSecondsInput() *string
	Department() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	DisplayName() *string
	Division() *string
	Email() *string
	EmployeeNumber() *string
	FirstName() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	GroupMemberships() *[]*string
	HonorificPrefix() *string
	HonorificSuffix() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	LastName() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Locale() *string
	Login() *string
	Manager() *string
	ManagerId() *string
	MiddleName() *string
	MobilePhone() *string
	NickName() *string
	// The tree node.
	Node() constructs.Node
	Organization() *string
	PostalAddress() *string
	PreferredLanguage() *string
	PrimaryPhone() *string
	ProfileUrl() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	RawOverrides() interface{}
	Roles() *[]*string
	Search() DataOktaUserSearchList
	SearchInput() interface{}
	SecondEmail() *string
	SkipGroups() interface{}
	SetSkipGroups(val interface{})
	SkipGroupsInput() interface{}
	SkipRoles() interface{}
	SetSkipRoles(val interface{})
	SkipRolesInput() interface{}
	State() *string
	Status() *string
	StreetAddress() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Timezone() *string
	Title() *string
	UserId() *string
	SetUserId(val *string)
	UserIdInput() *string
	UserType() *string
	ZipCode() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutSearch(value interface{})
	ResetCompoundSearchOperator()
	ResetDelayReadSeconds()
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetSearch()
	ResetSkipGroups()
	ResetSkipRoles()
	ResetUserId()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user okta_user}.

func NewDataOktaUser 

func NewDataOktaUser(scope constructs.Construct, id *string, config *DataOktaUserConfig) DataOktaUser

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user okta_user} Data Source.

type DataOktaUserConfig 

type DataOktaUserConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// Search operator used when joining mulitple search clauses.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#compound_search_operator DataOktaUser#compound_search_operator}
	CompoundSearchOperator *string `field:"optional" json:"compoundSearchOperator" yaml:"compoundSearchOperator"`
	// Force delay of the user read by N seconds.
	//
	// Useful when eventual consistency of user information needs to be allowed for.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#delay_read_seconds DataOktaUser#delay_read_seconds}
	DelayReadSeconds *string `field:"optional" json:"delayReadSeconds" yaml:"delayReadSeconds"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#id DataOktaUser#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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// search block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#search DataOktaUser#search}
	Search interface{} `field:"optional" json:"search" yaml:"search"`
	// Do not populate user groups information (prevents additional API call).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#skip_groups DataOktaUser#skip_groups}
	SkipGroups interface{} `field:"optional" json:"skipGroups" yaml:"skipGroups"`
	// Do not populate user roles information (prevents additional API call).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#skip_roles DataOktaUser#skip_roles}
	SkipRoles interface{} `field:"optional" json:"skipRoles" yaml:"skipRoles"`
	// Retrieve a single user based on their id.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#user_id DataOktaUser#user_id}
	UserId *string `field:"optional" json:"userId" yaml:"userId"`
}

type DataOktaUserSearch 

type DataOktaUserSearch struct {
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#comparison DataOktaUser#comparison}.
	Comparison *string `field:"optional" json:"comparison" yaml:"comparison"`
	// A raw search expression string.
	//
	// This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#expression DataOktaUser#expression}
	Expression *string `field:"optional" json:"expression" yaml:"expression"`
	// Property name to search for.
	//
	// This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#name DataOktaUser#name}
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/user#value DataOktaUser#value}.
	Value *string `field:"optional" json:"value" yaml:"value"`
}

type DataOktaUserSearchList 

type DataOktaUserSearchList interface {
	cdktf.ComplexList
	// 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.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	// The attribute on the parent resource this class is referencing.
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	// The parent resource.
	TerraformResource() cdktf.IInterpolatingParent
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
	WrapsSet() *bool
	SetWrapsSet(val *bool)
	// Experimental.
	ComputeFqn() *string
	Get(index *float64) DataOktaUserSearchOutputReference
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataOktaUserSearchList 

func NewDataOktaUserSearchList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataOktaUserSearchList

type DataOktaUserSearchOutputReference 

type DataOktaUserSearchOutputReference interface {
	cdktf.ComplexObject
	Comparison() *string
	SetComparison(val *string)
	ComparisonInput() *string
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// 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.
	// Experimental.
	CreationStack() *[]*string
	Expression() *string
	SetExpression(val *string)
	ExpressionInput() *string
	// Experimental.
	Fqn() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	Name() *string
	SetName(val *string)
	NameInput() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Value() *string
	SetValue(val *string)
	ValueInput() *string
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetComparison()
	ResetExpression()
	ResetName()
	ResetValue()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataOktaUserSearchOutputReference 

func NewDataOktaUserSearchOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) DataOktaUserSearchOutputReference

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.