com.pulumi.okta.AuthenticatorArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of okta Show documentation
Show all versions of okta Show documentation
A Pulumi package for creating and managing okta resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.okta;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class AuthenticatorArgs extends com.pulumi.resources.ResourceArgs {
public static final AuthenticatorArgs Empty = new AuthenticatorArgs();
/**
* 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`
*
*/
@Import(name="key", required=true)
private Output key;
/**
* @return 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`
*
*/
public Output key() {
return this.key;
}
/**
* Name does not trigger change detection (legacy behavior)
*
*/
@Import(name="legacyIgnoreName")
private @Nullable Output legacyIgnoreName;
/**
* @return Name does not trigger change detection (legacy behavior)
*
*/
public Optional> legacyIgnoreName() {
return Optional.ofNullable(this.legacyIgnoreName);
}
/**
* Display name of the Authenticator
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Display name of the Authenticator
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* 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.
*
*/
@Import(name="providerAuthPort")
private @Nullable Output providerAuthPort;
/**
* @return 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.
*
*/
public Optional> providerAuthPort() {
return Optional.ofNullable(this.providerAuthPort);
}
/**
* (DUO specific) - The Duo Security API hostname. Conflicts with `provider_json` argument.
*
*/
@Import(name="providerHost")
private @Nullable Output providerHost;
/**
* @return (DUO specific) - The Duo Security API hostname. Conflicts with `provider_json` argument.
*
*/
public Optional> providerHost() {
return Optional.ofNullable(this.providerHost);
}
/**
* Server host name or IP address. Default is `localhost`. Used only for authenticators with type `security_key`. Conflicts with `provider_json` argument.
*
*/
@Import(name="providerHostname")
private @Nullable Output providerHostname;
/**
* @return Server host name or IP address. Default is `localhost`. Used only for authenticators with type `security_key`. Conflicts with `provider_json` argument.
*
*/
public Optional> providerHostname() {
return Optional.ofNullable(this.providerHostname);
}
/**
* (DUO specific) - The Duo Security integration key. Conflicts with `provider_json` argument.
*
*/
@Import(name="providerIntegrationKey")
private @Nullable Output providerIntegrationKey;
/**
* @return (DUO specific) - The Duo Security integration key. Conflicts with `provider_json` argument.
*
*/
public Optional> providerIntegrationKey() {
return Optional.ofNullable(this.providerIntegrationKey);
}
/**
* Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The [CreateProvider](https://developer.okta.com/docs/reference/api/authenticators-admin/#request) illustrates detailed provider values for a Duo authenticator. [Provider values](https://developer.okta.com/docs/reference/api/authenticators-admin/#authenticators-administration-api-object)are listed in Okta API.
*
*/
@Import(name="providerJson")
private @Nullable Output providerJson;
/**
* @return Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The [CreateProvider](https://developer.okta.com/docs/reference/api/authenticators-admin/#request) illustrates detailed provider values for a Duo authenticator. [Provider values](https://developer.okta.com/docs/reference/api/authenticators-admin/#authenticators-administration-api-object)are listed in Okta API.
*
*/
public Optional> providerJson() {
return Optional.ofNullable(this.providerJson);
}
/**
* (DUO specific) - The Duo Security secret key. Conflicts with `provider_json` argument.
*
*/
@Import(name="providerSecretKey")
private @Nullable Output providerSecretKey;
/**
* @return (DUO specific) - The Duo Security secret key. Conflicts with `provider_json` argument.
*
*/
public Optional> providerSecretKey() {
return Optional.ofNullable(this.providerSecretKey);
}
/**
* 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.
*
*/
@Import(name="providerSharedSecret")
private @Nullable Output providerSharedSecret;
/**
* @return 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.
*
*/
public Optional> providerSharedSecret() {
return Optional.ofNullable(this.providerSharedSecret);
}
/**
* Username template expected by the provider. Used only for authenticators with type `security_key`. Conflicts with `provider_json` argument.
*
*/
@Import(name="providerUserNameTemplate")
private @Nullable Output providerUserNameTemplate;
/**
* @return Username template expected by the provider. Used only for authenticators with type `security_key`. Conflicts with `provider_json` argument.
*
*/
public Optional> providerUserNameTemplate() {
return Optional.ofNullable(this.providerUserNameTemplate);
}
/**
* Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type `security_key`
*
*/
@Import(name="settings")
private @Nullable Output settings;
/**
* @return Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type `security_key`
*
*/
public Optional> settings() {
return Optional.ofNullable(this.settings);
}
/**
* Authenticator status: `ACTIVE` or `INACTIVE`. Default: `ACTIVE`
*
*/
@Import(name="status")
private @Nullable Output status;
/**
* @return Authenticator status: `ACTIVE` or `INACTIVE`. Default: `ACTIVE`
*
*/
public Optional> status() {
return Optional.ofNullable(this.status);
}
private AuthenticatorArgs() {}
private AuthenticatorArgs(AuthenticatorArgs $) {
this.key = $.key;
this.legacyIgnoreName = $.legacyIgnoreName;
this.name = $.name;
this.providerAuthPort = $.providerAuthPort;
this.providerHost = $.providerHost;
this.providerHostname = $.providerHostname;
this.providerIntegrationKey = $.providerIntegrationKey;
this.providerJson = $.providerJson;
this.providerSecretKey = $.providerSecretKey;
this.providerSharedSecret = $.providerSharedSecret;
this.providerUserNameTemplate = $.providerUserNameTemplate;
this.settings = $.settings;
this.status = $.status;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(AuthenticatorArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private AuthenticatorArgs $;
public Builder() {
$ = new AuthenticatorArgs();
}
public Builder(AuthenticatorArgs defaults) {
$ = new AuthenticatorArgs(Objects.requireNonNull(defaults));
}
/**
* @param key 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`
*
* @return builder
*
*/
public Builder key(Output key) {
$.key = key;
return this;
}
/**
* @param key 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`
*
* @return builder
*
*/
public Builder key(String key) {
return key(Output.of(key));
}
/**
* @param legacyIgnoreName Name does not trigger change detection (legacy behavior)
*
* @return builder
*
*/
public Builder legacyIgnoreName(@Nullable Output legacyIgnoreName) {
$.legacyIgnoreName = legacyIgnoreName;
return this;
}
/**
* @param legacyIgnoreName Name does not trigger change detection (legacy behavior)
*
* @return builder
*
*/
public Builder legacyIgnoreName(Boolean legacyIgnoreName) {
return legacyIgnoreName(Output.of(legacyIgnoreName));
}
/**
* @param name Display name of the Authenticator
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name Display name of the Authenticator
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param providerAuthPort 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.
*
* @return builder
*
*/
public Builder providerAuthPort(@Nullable Output providerAuthPort) {
$.providerAuthPort = providerAuthPort;
return this;
}
/**
* @param providerAuthPort 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.
*
* @return builder
*
*/
public Builder providerAuthPort(Integer providerAuthPort) {
return providerAuthPort(Output.of(providerAuthPort));
}
/**
* @param providerHost (DUO specific) - The Duo Security API hostname. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerHost(@Nullable Output providerHost) {
$.providerHost = providerHost;
return this;
}
/**
* @param providerHost (DUO specific) - The Duo Security API hostname. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerHost(String providerHost) {
return providerHost(Output.of(providerHost));
}
/**
* @param providerHostname Server host name or IP address. Default is `localhost`. Used only for authenticators with type `security_key`. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerHostname(@Nullable Output providerHostname) {
$.providerHostname = providerHostname;
return this;
}
/**
* @param providerHostname Server host name or IP address. Default is `localhost`. Used only for authenticators with type `security_key`. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerHostname(String providerHostname) {
return providerHostname(Output.of(providerHostname));
}
/**
* @param providerIntegrationKey (DUO specific) - The Duo Security integration key. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerIntegrationKey(@Nullable Output providerIntegrationKey) {
$.providerIntegrationKey = providerIntegrationKey;
return this;
}
/**
* @param providerIntegrationKey (DUO specific) - The Duo Security integration key. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerIntegrationKey(String providerIntegrationKey) {
return providerIntegrationKey(Output.of(providerIntegrationKey));
}
/**
* @param providerJson Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The [CreateProvider](https://developer.okta.com/docs/reference/api/authenticators-admin/#request) illustrates detailed provider values for a Duo authenticator. [Provider values](https://developer.okta.com/docs/reference/api/authenticators-admin/#authenticators-administration-api-object)are listed in Okta API.
*
* @return builder
*
*/
public Builder providerJson(@Nullable Output providerJson) {
$.providerJson = providerJson;
return this;
}
/**
* @param providerJson Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The [CreateProvider](https://developer.okta.com/docs/reference/api/authenticators-admin/#request) illustrates detailed provider values for a Duo authenticator. [Provider values](https://developer.okta.com/docs/reference/api/authenticators-admin/#authenticators-administration-api-object)are listed in Okta API.
*
* @return builder
*
*/
public Builder providerJson(String providerJson) {
return providerJson(Output.of(providerJson));
}
/**
* @param providerSecretKey (DUO specific) - The Duo Security secret key. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerSecretKey(@Nullable Output providerSecretKey) {
$.providerSecretKey = providerSecretKey;
return this;
}
/**
* @param providerSecretKey (DUO specific) - The Duo Security secret key. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerSecretKey(String providerSecretKey) {
return providerSecretKey(Output.of(providerSecretKey));
}
/**
* @param providerSharedSecret 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.
*
* @return builder
*
*/
public Builder providerSharedSecret(@Nullable Output providerSharedSecret) {
$.providerSharedSecret = providerSharedSecret;
return this;
}
/**
* @param providerSharedSecret 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.
*
* @return builder
*
*/
public Builder providerSharedSecret(String providerSharedSecret) {
return providerSharedSecret(Output.of(providerSharedSecret));
}
/**
* @param providerUserNameTemplate Username template expected by the provider. Used only for authenticators with type `security_key`. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerUserNameTemplate(@Nullable Output providerUserNameTemplate) {
$.providerUserNameTemplate = providerUserNameTemplate;
return this;
}
/**
* @param providerUserNameTemplate Username template expected by the provider. Used only for authenticators with type `security_key`. Conflicts with `provider_json` argument.
*
* @return builder
*
*/
public Builder providerUserNameTemplate(String providerUserNameTemplate) {
return providerUserNameTemplate(Output.of(providerUserNameTemplate));
}
/**
* @param settings Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type `security_key`
*
* @return builder
*
*/
public Builder settings(@Nullable Output settings) {
$.settings = settings;
return this;
}
/**
* @param settings Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type `security_key`
*
* @return builder
*
*/
public Builder settings(String settings) {
return settings(Output.of(settings));
}
/**
* @param status Authenticator status: `ACTIVE` or `INACTIVE`. Default: `ACTIVE`
*
* @return builder
*
*/
public Builder status(@Nullable Output status) {
$.status = status;
return this;
}
/**
* @param status Authenticator status: `ACTIVE` or `INACTIVE`. Default: `ACTIVE`
*
* @return builder
*
*/
public Builder status(String status) {
return status(Output.of(status));
}
public AuthenticatorArgs build() {
if ($.key == null) {
throw new MissingRequiredPropertyException("AuthenticatorArgs", "key");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy