Skip to content

Latest commit

 

History

History
1430 lines (896 loc) · 55.8 KB

authenticator.go.md

File metadata and controls

1430 lines (896 loc) · 55.8 KB

authenticator Submodule

Constructs

Authenticator

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator okta_authenticator}.

Initializers 

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

authenticator.NewAuthenticator(scope Construct, id *string, config AuthenticatorConfig) Authenticator
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 AuthenticatorConfig 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".
ResetId No description.
ResetLegacyIgnoreName No description.
ResetProviderAuthPort No description.
ResetProviderHost No description.
ResetProviderHostname No description.
ResetProviderIntegrationKey No description.
ResetProviderJson No description.
ResetProviderSecretKey No description.
ResetProviderSharedSecret No description.
ResetProviderUserNameTemplate No description.
ResetSettings No description.
ResetStatus 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".

ResetId 
func ResetId()
ResetLegacyIgnoreName 
func ResetLegacyIgnoreName()
ResetProviderAuthPort 
func ResetProviderAuthPort()
ResetProviderHost 
func ResetProviderHost()
ResetProviderHostname 
func ResetProviderHostname()
ResetProviderIntegrationKey 
func ResetProviderIntegrationKey()
ResetProviderJson 
func ResetProviderJson()
ResetProviderSecretKey 
func ResetProviderSecretKey()
ResetProviderSharedSecret 
func ResetProviderSharedSecret()
ResetProviderUserNameTemplate 
func ResetProviderUserNameTemplate()
ResetSettings 
func ResetSettings()
ResetStatus 
func ResetStatus()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a Authenticator resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authenticator"

authenticator.Authenticator_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/authenticator"

authenticator.Authenticator_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authenticator"

authenticator.Authenticator_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authenticator"

authenticator.Authenticator_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a Authenticator 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 Authenticator to import.

importFromIdRequired
  • Type: *string

The id of the existing Authenticator that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#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 Authenticator 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.
ProviderInstanceId *string No description.
ProviderType *string No description.
Type *string No description.
IdInput *string No description.
KeyInput *string No description.
LegacyIgnoreNameInput interface{} No description.
NameInput *string No description.
ProviderAuthPortInput *f64 No description.
ProviderHostInput *string No description.
ProviderHostnameInput *string No description.
ProviderIntegrationKeyInput *string No description.
ProviderJsonInput *string No description.
ProviderSecretKeyInput *string No description.
ProviderSharedSecretInput *string No description.
ProviderUserNameTemplateInput *string No description.
SettingsInput *string No description.
StatusInput *string No description.
Id *string No description.
Key *string No description.
LegacyIgnoreName interface{} No description.
Name *string No description.
ProviderAuthPort *f64 No description.
ProviderHost *string No description.
ProviderHostname *string No description.
ProviderIntegrationKey *string No description.
ProviderJson *string No description.
ProviderSecretKey *string No description.
ProviderSharedSecret *string No description.
ProviderUserNameTemplate *string No description.
Settings *string No description.
Status *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{}
ProviderInstanceIdRequired 
func ProviderInstanceId() *string
  • Type: *string
ProviderTypeRequired 
func ProviderType() *string
  • Type: *string
TypeRequired 
func Type() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
KeyInputOptional 
func KeyInput() *string
  • Type: *string
LegacyIgnoreNameInputOptional 
func LegacyIgnoreNameInput() interface{}
  • Type: interface{}
NameInputOptional 
func NameInput() *string
  • Type: *string
ProviderAuthPortInputOptional 
func ProviderAuthPortInput() *f64
  • Type: *f64
ProviderHostInputOptional 
func ProviderHostInput() *string
  • Type: *string
ProviderHostnameInputOptional 
func ProviderHostnameInput() *string
  • Type: *string
ProviderIntegrationKeyInputOptional 
func ProviderIntegrationKeyInput() *string
  • Type: *string
ProviderJsonInputOptional 
func ProviderJsonInput() *string
  • Type: *string
ProviderSecretKeyInputOptional 
func ProviderSecretKeyInput() *string
  • Type: *string
ProviderSharedSecretInputOptional 
func ProviderSharedSecretInput() *string
  • Type: *string
ProviderUserNameTemplateInputOptional 
func ProviderUserNameTemplateInput() *string
  • Type: *string
SettingsInputOptional 
func SettingsInput() *string
  • Type: *string
StatusInputOptional 
func StatusInput() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
KeyRequired 
func Key() *string
  • Type: *string
LegacyIgnoreNameRequired 
func LegacyIgnoreName() interface{}
  • Type: interface{}
NameRequired 
func Name() *string
  • Type: *string
ProviderAuthPortRequired 
func ProviderAuthPort() *f64
  • Type: *f64
ProviderHostRequired 
func ProviderHost() *string
  • Type: *string
ProviderHostnameRequired 
func ProviderHostname() *string
  • Type: *string
ProviderIntegrationKeyRequired 
func ProviderIntegrationKey() *string
  • Type: *string
ProviderJsonRequired 
func ProviderJson() *string
  • Type: *string
ProviderSecretKeyRequired 
func ProviderSecretKey() *string
  • Type: *string
ProviderSharedSecretRequired 
func ProviderSharedSecret() *string
  • Type: *string
ProviderUserNameTemplateRequired 
func ProviderUserNameTemplate() *string
  • Type: *string
SettingsRequired 
func Settings() *string
  • Type: *string
StatusRequired 
func Status() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

AuthenticatorConfig

Initializer 

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

&authenticator.AuthenticatorConfig {
	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{},
	Key: *string,
	Name: *string,
	Id: *string,
	LegacyIgnoreName: interface{},
	ProviderAuthPort: *f64,
	ProviderHost: *string,
	ProviderHostname: *string,
	ProviderIntegrationKey: *string,
	ProviderJson: *string,
	ProviderSecretKey: *string,
	ProviderSharedSecret: *string,
	ProviderUserNameTemplate: *string,
	Settings: *string,
	Status: *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.
Key *string A human-readable string that identifies the authenticator.
Name *string Display name of the Authenticator.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#id Authenticator#id}.
LegacyIgnoreName interface{} Name does not trigger change detection (legacy behavior).
ProviderAuthPort *f64 The RADIUS server port (for example 1812).
ProviderHost *string (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
ProviderHostname *string Server host name or IP address.
ProviderIntegrationKey *string (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
ProviderJson *string Provider JSON allows for expressive providervalues.
ProviderSecretKey *string (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
ProviderSharedSecret *string An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server.
ProviderUserNameTemplate *string Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
Settings *string Settings for the authenticator.
Status *string Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE.
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{}
KeyRequired 
Key *string
  • Type: *string

A human-readable string that identifies the authenticator.

Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#key Authenticator#key}

NameRequired 
Name *string
  • Type: *string

Display name of the Authenticator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#name Authenticator#name}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#id Authenticator#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.

LegacyIgnoreNameOptional 
LegacyIgnoreName interface{}
  • Type: interface{}

Name does not trigger change detection (legacy behavior).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#legacy_ignore_name Authenticator#legacy_ignore_name}

ProviderAuthPortOptional 
ProviderAuthPort *f64
  • Type: *f64

The RADIUS server port (for example 1812).

This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#provider_auth_port Authenticator#provider_auth_port}

ProviderHostOptional 
ProviderHost *string
  • Type: *string

(DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#provider_host Authenticator#provider_host}

ProviderHostnameOptional 
ProviderHostname *string
  • Type: *string

Server host name or IP address.

Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#provider_hostname Authenticator#provider_hostname}

ProviderIntegrationKeyOptional 
ProviderIntegrationKey *string
  • Type: *string

(DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#provider_integration_key Authenticator#provider_integration_key}

ProviderJsonOptional 
ProviderJson *string
  • Type: *string

Provider JSON allows for expressive providervalues.

This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#provider_json Authenticator#provider_json}

ProviderSecretKeyOptional 
ProviderSecretKey *string
  • Type: *string

(DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#provider_secret_key Authenticator#provider_secret_key}

ProviderSharedSecretOptional 
ProviderSharedSecret *string
  • Type: *string

An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server.

Used only for authenticators with type security_key. Conflicts with provider_json argument.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#provider_shared_secret Authenticator#provider_shared_secret}

ProviderUserNameTemplateOptional 
ProviderUserNameTemplate *string
  • Type: *string

Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#provider_user_name_template Authenticator#provider_user_name_template}

SettingsOptional 
Settings *string
  • Type: *string

Settings for the authenticator.

The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#settings Authenticator#settings}

StatusOptional 
Status *string
  • Type: *string

Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/authenticator#status Authenticator#status}