authserverpolicyrule

package
v13.7.0 Latest Latest
Warning

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

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

README

okta_auth_server_policy_rule

Refer to the Terraform Registry for docs: okta_auth_server_policy_rule.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AuthServerPolicyRule_GenerateConfigForImport 

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

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

func AuthServerPolicyRule_IsConstruct 

func AuthServerPolicyRule_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 AuthServerPolicyRule_IsTerraformElement 

func AuthServerPolicyRule_IsTerraformElement(x interface{}) *bool

Experimental.

func AuthServerPolicyRule_IsTerraformResource 

func AuthServerPolicyRule_IsTerraformResource(x interface{}) *bool

Experimental.

func AuthServerPolicyRule_TfResourceType 

func AuthServerPolicyRule_TfResourceType() *string

func NewAuthServerPolicyRule_Override 

func NewAuthServerPolicyRule_Override(a AuthServerPolicyRule, scope constructs.Construct, id *string, config *AuthServerPolicyRuleConfig)

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule okta_auth_server_policy_rule} Resource.

Types

type AuthServerPolicyRule 

type AuthServerPolicyRule interface {
	cdktf.TerraformResource
	AccessTokenLifetimeMinutes() *float64
	SetAccessTokenLifetimeMinutes(val *float64)
	AccessTokenLifetimeMinutesInput() *float64
	AuthServerId() *string
	SetAuthServerId(val *string)
	AuthServerIdInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	GrantTypeWhitelist() *[]*string
	SetGrantTypeWhitelist(val *[]*string)
	GrantTypeWhitelistInput() *[]*string
	GroupBlacklist() *[]*string
	SetGroupBlacklist(val *[]*string)
	GroupBlacklistInput() *[]*string
	GroupWhitelist() *[]*string
	SetGroupWhitelist(val *[]*string)
	GroupWhitelistInput() *[]*string
	Id() *string
	SetId(val *string)
	IdInput() *string
	InlineHookId() *string
	SetInlineHookId(val *string)
	InlineHookIdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	PolicyId() *string
	SetPolicyId(val *string)
	PolicyIdInput() *string
	Priority() *float64
	SetPriority(val *float64)
	PriorityInput() *float64
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	RefreshTokenLifetimeMinutes() *float64
	SetRefreshTokenLifetimeMinutes(val *float64)
	RefreshTokenLifetimeMinutesInput() *float64
	RefreshTokenWindowMinutes() *float64
	SetRefreshTokenWindowMinutes(val *float64)
	RefreshTokenWindowMinutesInput() *float64
	ScopeWhitelist() *[]*string
	SetScopeWhitelist(val *[]*string)
	ScopeWhitelistInput() *[]*string
	Status() *string
	SetStatus(val *string)
	StatusInput() *string
	SystemAttribute() cdktf.IResolvable
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	UserBlacklist() *[]*string
	SetUserBlacklist(val *[]*string)
	UserBlacklistInput() *[]*string
	UserWhitelist() *[]*string
	SetUserWhitelist(val *[]*string)
	UserWhitelistInput() *[]*string
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *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.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// 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.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAccessTokenLifetimeMinutes()
	ResetGroupBlacklist()
	ResetGroupWhitelist()
	ResetId()
	ResetInlineHookId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetRefreshTokenLifetimeMinutes()
	ResetRefreshTokenWindowMinutes()
	ResetScopeWhitelist()
	ResetStatus()
	ResetType()
	ResetUserBlacklist()
	ResetUserWhitelist()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() 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.13.0/docs/resources/auth_server_policy_rule okta_auth_server_policy_rule}.

func NewAuthServerPolicyRule 

func NewAuthServerPolicyRule(scope constructs.Construct, id *string, config *AuthServerPolicyRuleConfig) AuthServerPolicyRule

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule okta_auth_server_policy_rule} Resource.

type AuthServerPolicyRuleConfig 

type AuthServerPolicyRuleConfig 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"`
	// Auth server ID.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#auth_server_id AuthServerPolicyRule#auth_server_id}
	AuthServerId *string `field:"required" json:"authServerId" yaml:"authServerId"`
	// Accepted grant type values, `authorization_code`, `implicit`, `password`, `client_credentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interaction_code` (*OIE only*).
	//
	// For `implicit` value either `user_whitelist` or `group_whitelist` should be set.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#grant_type_whitelist AuthServerPolicyRule#grant_type_whitelist}
	GrantTypeWhitelist *[]*string `field:"required" json:"grantTypeWhitelist" yaml:"grantTypeWhitelist"`
	// Auth server policy rule name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#name AuthServerPolicyRule#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// Auth server policy ID.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#policy_id AuthServerPolicyRule#policy_id}
	PolicyId *string `field:"required" json:"policyId" yaml:"policyId"`
	// Priority of the auth server policy rule.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#priority AuthServerPolicyRule#priority}
	Priority *float64 `field:"required" json:"priority" yaml:"priority"`
	// Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#access_token_lifetime_minutes AuthServerPolicyRule#access_token_lifetime_minutes}
	AccessTokenLifetimeMinutes *float64 `field:"optional" json:"accessTokenLifetimeMinutes" yaml:"accessTokenLifetimeMinutes"`
	// Specifies a set of Groups whose Users are to be excluded.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#group_blacklist AuthServerPolicyRule#group_blacklist}
	GroupBlacklist *[]*string `field:"optional" json:"groupBlacklist" yaml:"groupBlacklist"`
	// Specifies a set of Groups whose Users are to be included.
	//
	// Can be set to Group ID or to the following: `EVERYONE`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#group_whitelist AuthServerPolicyRule#group_whitelist}
	GroupWhitelist *[]*string `field:"optional" json:"groupWhitelist" yaml:"groupWhitelist"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#id AuthServerPolicyRule#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"`
	// The ID of the inline token to trigger.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#inline_hook_id AuthServerPolicyRule#inline_hook_id}
	InlineHookId *string `field:"optional" json:"inlineHookId" yaml:"inlineHookId"`
	// Lifetime of refresh token.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#refresh_token_lifetime_minutes AuthServerPolicyRule#refresh_token_lifetime_minutes}
	RefreshTokenLifetimeMinutes *float64 `field:"optional" json:"refreshTokenLifetimeMinutes" yaml:"refreshTokenLifetimeMinutes"`
	// Window in which a refresh token can be used.
	//
	// It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refresh_token_window_minutes` must be between `access_token_lifetime_minutes` and `refresh_token_lifetime_minutes`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#refresh_token_window_minutes AuthServerPolicyRule#refresh_token_window_minutes}
	RefreshTokenWindowMinutes *float64 `field:"optional" json:"refreshTokenWindowMinutes" yaml:"refreshTokenWindowMinutes"`
	// Scopes allowed for this policy rule.
	//
	// They can be whitelisted by name or all can be whitelisted with ` * `
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#scope_whitelist AuthServerPolicyRule#scope_whitelist}
	ScopeWhitelist *[]*string `field:"optional" json:"scopeWhitelist" yaml:"scopeWhitelist"`
	// Default to `ACTIVE`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#status AuthServerPolicyRule#status}
	Status *string `field:"optional" json:"status" yaml:"status"`
	// Auth server policy rule type, unlikely this will be anything other then the default.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#type AuthServerPolicyRule#type}
	Type *string `field:"optional" json:"type" yaml:"type"`
	// Specifies a set of Users to be excluded.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#user_blacklist AuthServerPolicyRule#user_blacklist}
	UserBlacklist *[]*string `field:"optional" json:"userBlacklist" yaml:"userBlacklist"`
	// Specifies a set of Users to be included.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.13.0/docs/resources/auth_server_policy_rule#user_whitelist AuthServerPolicyRule#user_whitelist}
	UserWhitelist *[]*string `field:"optional" json:"userWhitelist" yaml:"userWhitelist"`
}

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.