Skip to content

Latest commit

 

History

History
1614 lines (1007 loc) · 71 KB

authenticator.java.md

File metadata and controls

1614 lines (1007 loc) · 71 KB
Raw

authenticator Submodule

Constructs

Authenticator

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

Initializers 

import com.hashicorp.cdktf.providers.okta.authenticator.Authenticator;

Authenticator.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .key(java.lang.String)
    .name(java.lang.String)
//  .id(java.lang.String)
//  .providerAuthPort(java.lang.Number)
//  .providerHost(java.lang.String)
//  .providerHostname(java.lang.String)
//  .providerIntegrationKey(java.lang.String)
//  .providerJson(java.lang.String)
//  .providerSecretKey(java.lang.String)
//  .providerSharedSecret(java.lang.String)
//  .providerUserNameTemplate(java.lang.String)
//  .settings(java.lang.String)
//  .status(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
key java.lang.String A human-readable string that identifies the authenticator.
name java.lang.String Display name of the Authenticator.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/authenticator#id Authenticator#id}.
providerAuthPort java.lang.Number The RADIUS server port (for example 1812).
providerHost java.lang.String (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
providerHostname java.lang.String Server host name or IP address.
providerIntegrationKey java.lang.String (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
providerJson java.lang.String Provider JSON allows for expressive providervalues.
providerSecretKey java.lang.String (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
providerSharedSecret java.lang.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 java.lang.String Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
settings java.lang.String Settings for the authenticator.
status java.lang.String Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
keyRequired
  • Type: java.lang.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.8.1/docs/resources/authenticator#key Authenticator#key}

nameRequired
  • Type: java.lang.String

Display name of the Authenticator.

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

idOptional
  • Type: java.lang.String

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

providerAuthPortOptional
  • Type: java.lang.Number

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.8.1/docs/resources/authenticator#provider_auth_port Authenticator#provider_auth_port}

providerHostOptional
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_host Authenticator#provider_host}

providerHostnameOptional
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_hostname Authenticator#provider_hostname}

providerIntegrationKeyOptional
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_integration_key Authenticator#provider_integration_key}

providerJsonOptional
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_json Authenticator#provider_json}

providerSecretKeyOptional
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_secret_key Authenticator#provider_secret_key}

providerSharedSecretOptional
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_shared_secret Authenticator#provider_shared_secret}

providerUserNameTemplateOptional
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_user_name_template Authenticator#provider_user_name_template}

settingsOptional
  • Type: java.lang.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.8.1/docs/resources/authenticator#settings Authenticator#settings}

statusOptional
  • Type: java.lang.String

Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE.

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

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.
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 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.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: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

resetId 
public void resetId()
resetProviderAuthPort 
public void resetProviderAuthPort()
resetProviderHost 
public void resetProviderHost()
resetProviderHostname 
public void resetProviderHostname()
resetProviderIntegrationKey 
public void resetProviderIntegrationKey()
resetProviderJson 
public void resetProviderJson()
resetProviderSecretKey 
public void resetProviderSecretKey()
resetProviderSharedSecret 
public void resetProviderSharedSecret()
resetProviderUserNameTemplate 
public void resetProviderUserNameTemplate()
resetSettings 
public void resetSettings()
resetStatus 
public void 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 com.hashicorp.cdktf.providers.okta.authenticator.Authenticator;

Authenticator.isConstruct(java.lang.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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.okta.authenticator.Authenticator;

Authenticator.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.okta.authenticator.Authenticator;

Authenticator.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.okta.authenticator.Authenticator;

Authenticator.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Authenticator.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing Authenticator that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
providerInstanceId java.lang.String No description.
providerType java.lang.String No description.
type java.lang.String No description.
idInput java.lang.String No description.
keyInput java.lang.String No description.
nameInput java.lang.String No description.
providerAuthPortInput java.lang.Number No description.
providerHostInput java.lang.String No description.
providerHostnameInput java.lang.String No description.
providerIntegrationKeyInput java.lang.String No description.
providerJsonInput java.lang.String No description.
providerSecretKeyInput java.lang.String No description.
providerSharedSecretInput java.lang.String No description.
providerUserNameTemplateInput java.lang.String No description.
settingsInput java.lang.String No description.
statusInput java.lang.String No description.
id java.lang.String No description.
key java.lang.String No description.
name java.lang.String No description.
providerAuthPort java.lang.Number No description.
providerHost java.lang.String No description.
providerHostname java.lang.String No description.
providerIntegrationKey java.lang.String No description.
providerJson java.lang.String No description.
providerSecretKey java.lang.String No description.
providerSharedSecret java.lang.String No description.
providerUserNameTemplate java.lang.String No description.
settings java.lang.String No description.
status java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
providerInstanceIdRequired 
public java.lang.String getProviderInstanceId();
  • Type: java.lang.String
providerTypeRequired 
public java.lang.String getProviderType();
  • Type: java.lang.String
typeRequired 
public java.lang.String getType();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
keyInputOptional 
public java.lang.String getKeyInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
providerAuthPortInputOptional 
public java.lang.Number getProviderAuthPortInput();
  • Type: java.lang.Number
providerHostInputOptional 
public java.lang.String getProviderHostInput();
  • Type: java.lang.String
providerHostnameInputOptional 
public java.lang.String getProviderHostnameInput();
  • Type: java.lang.String
providerIntegrationKeyInputOptional 
public java.lang.String getProviderIntegrationKeyInput();
  • Type: java.lang.String
providerJsonInputOptional 
public java.lang.String getProviderJsonInput();
  • Type: java.lang.String
providerSecretKeyInputOptional 
public java.lang.String getProviderSecretKeyInput();
  • Type: java.lang.String
providerSharedSecretInputOptional 
public java.lang.String getProviderSharedSecretInput();
  • Type: java.lang.String
providerUserNameTemplateInputOptional 
public java.lang.String getProviderUserNameTemplateInput();
  • Type: java.lang.String
settingsInputOptional 
public java.lang.String getSettingsInput();
  • Type: java.lang.String
statusInputOptional 
public java.lang.String getStatusInput();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
keyRequired 
public java.lang.String getKey();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
providerAuthPortRequired 
public java.lang.Number getProviderAuthPort();
  • Type: java.lang.Number
providerHostRequired 
public java.lang.String getProviderHost();
  • Type: java.lang.String
providerHostnameRequired 
public java.lang.String getProviderHostname();
  • Type: java.lang.String
providerIntegrationKeyRequired 
public java.lang.String getProviderIntegrationKey();
  • Type: java.lang.String
providerJsonRequired 
public java.lang.String getProviderJson();
  • Type: java.lang.String
providerSecretKeyRequired 
public java.lang.String getProviderSecretKey();
  • Type: java.lang.String
providerSharedSecretRequired 
public java.lang.String getProviderSharedSecret();
  • Type: java.lang.String
providerUserNameTemplateRequired 
public java.lang.String getProviderUserNameTemplate();
  • Type: java.lang.String
settingsRequired 
public java.lang.String getSettings();
  • Type: java.lang.String
statusRequired 
public java.lang.String getStatus();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

AuthenticatorConfig

Initializer 

import com.hashicorp.cdktf.providers.okta.authenticator.AuthenticatorConfig;

AuthenticatorConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .key(java.lang.String)
    .name(java.lang.String)
//  .id(java.lang.String)
//  .providerAuthPort(java.lang.Number)
//  .providerHost(java.lang.String)
//  .providerHostname(java.lang.String)
//  .providerIntegrationKey(java.lang.String)
//  .providerJson(java.lang.String)
//  .providerSecretKey(java.lang.String)
//  .providerSharedSecret(java.lang.String)
//  .providerUserNameTemplate(java.lang.String)
//  .settings(java.lang.String)
//  .status(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
key java.lang.String A human-readable string that identifies the authenticator.
name java.lang.String Display name of the Authenticator.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/authenticator#id Authenticator#id}.
providerAuthPort java.lang.Number The RADIUS server port (for example 1812).
providerHost java.lang.String (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
providerHostname java.lang.String Server host name or IP address.
providerIntegrationKey java.lang.String (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
providerJson java.lang.String Provider JSON allows for expressive providervalues.
providerSecretKey java.lang.String (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
providerSharedSecret java.lang.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 java.lang.String Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
settings java.lang.String Settings for the authenticator.
status java.lang.String Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
keyRequired 
public java.lang.String getKey();
  • Type: java.lang.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.8.1/docs/resources/authenticator#key Authenticator#key}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Display name of the Authenticator.

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

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

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

providerAuthPortOptional 
public java.lang.Number getProviderAuthPort();
  • Type: java.lang.Number

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.8.1/docs/resources/authenticator#provider_auth_port Authenticator#provider_auth_port}

providerHostOptional 
public java.lang.String getProviderHost();
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_host Authenticator#provider_host}

providerHostnameOptional 
public java.lang.String getProviderHostname();
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_hostname Authenticator#provider_hostname}

providerIntegrationKeyOptional 
public java.lang.String getProviderIntegrationKey();
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_integration_key Authenticator#provider_integration_key}

providerJsonOptional 
public java.lang.String getProviderJson();
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_json Authenticator#provider_json}

providerSecretKeyOptional 
public java.lang.String getProviderSecretKey();
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_secret_key Authenticator#provider_secret_key}

providerSharedSecretOptional 
public java.lang.String getProviderSharedSecret();
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_shared_secret Authenticator#provider_shared_secret}

providerUserNameTemplateOptional 
public java.lang.String getProviderUserNameTemplate();
  • Type: java.lang.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.8.1/docs/resources/authenticator#provider_user_name_template Authenticator#provider_user_name_template}

settingsOptional 
public java.lang.String getSettings();
  • Type: java.lang.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.8.1/docs/resources/authenticator#settings Authenticator#settings}

statusOptional 
public java.lang.String getStatus();
  • Type: java.lang.String

Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE.

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