RuleSignon
Creates a Sign On Policy Rule.
Create a RuleSignon Resource
new RuleSignon(name: string, args: RuleSignonArgs, opts?: CustomResourceOptions);def RuleSignon(resource_name, opts=None, access=None, authtype=None, mfa_lifetime=None, mfa_prompt=None, mfa_remember_device=None, mfa_required=None, name=None, network_connection=None, network_excludes=None, network_includes=None, policyid=None, priority=None, session_idle=None, session_lifetime=None, session_persistent=None, status=None, users_excludeds=None, __props__=None);func NewRuleSignon(ctx *Context, name string, args RuleSignonArgs, opts ...ResourceOption) (*RuleSignon, error)public RuleSignon(string name, RuleSignonArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args RuleSignonArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RuleSignonArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RuleSignonArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
RuleSignon Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The RuleSignon resource accepts the following input properties:
- Policyid string
Policy ID.
- Access string
Allow or deny access based on the rule conditions:
"ALLOW"or"DENY". The default is"ALLOW".- Authtype string
Authentication entrypoint:
"ANY"or"RADIUS".- Mfa
Lifetime int Elapsed time before the next MFA challenge.
- Mfa
Prompt string Prompt for MFA based on the device used, a factor session lifetime, or every sign on attempt:
"DEVICE","SESSION"or"ALWAYS".- Mfa
Remember boolDevice Remember MFA device. The default
false.- Mfa
Required bool Require MFA. By default is
false.- Name string
Policy Rule Name.
- Network
Connection string Network selection mode:
"ANYWHERE","ZONE","ON_NETWORK", or"OFF_NETWORK".- Network
Excludes List<string> The network zones to exclude. Conflicts with
network_includes.- Network
Includes List<string> The network zones to include. Conflicts with
network_excludes.- Priority int
Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last/lowest if not there.
- Session
Idle int Max minutes a session can be idle.“,
- Session
Lifetime int Max minutes a session is active: Disable = 0.
- Session
Persistent bool Whether session cookies will last across browser sessions. Okta Administrators can never have persistent session cookies.
- Status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- Users
Excludeds List<string> Set of User IDs to Exclude
- Policyid string
Policy ID.
- Access string
Allow or deny access based on the rule conditions:
"ALLOW"or"DENY". The default is"ALLOW".- Authtype string
Authentication entrypoint:
"ANY"or"RADIUS".- Mfa
Lifetime int Elapsed time before the next MFA challenge.
- Mfa
Prompt string Prompt for MFA based on the device used, a factor session lifetime, or every sign on attempt:
"DEVICE","SESSION"or"ALWAYS".- Mfa
Remember boolDevice Remember MFA device. The default
false.- Mfa
Required bool Require MFA. By default is
false.- Name string
Policy Rule Name.
- Network
Connection string Network selection mode:
"ANYWHERE","ZONE","ON_NETWORK", or"OFF_NETWORK".- Network
Excludes []string The network zones to exclude. Conflicts with
network_includes.- Network
Includes []string The network zones to include. Conflicts with
network_excludes.- Priority int
Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last/lowest if not there.
- Session
Idle int Max minutes a session can be idle.“,
- Session
Lifetime int Max minutes a session is active: Disable = 0.
- Session
Persistent bool Whether session cookies will last across browser sessions. Okta Administrators can never have persistent session cookies.
- Status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- Users
Excludeds []string Set of User IDs to Exclude
- policyid string
Policy ID.
- access string
Allow or deny access based on the rule conditions:
"ALLOW"or"DENY". The default is"ALLOW".- authtype string
Authentication entrypoint:
"ANY"or"RADIUS".- mfa
Lifetime number Elapsed time before the next MFA challenge.
- mfa
Prompt string Prompt for MFA based on the device used, a factor session lifetime, or every sign on attempt:
"DEVICE","SESSION"or"ALWAYS".- mfa
Remember booleanDevice Remember MFA device. The default
false.- mfa
Required boolean Require MFA. By default is
false.- name string
Policy Rule Name.
- network
Connection string Network selection mode:
"ANYWHERE","ZONE","ON_NETWORK", or"OFF_NETWORK".- network
Excludes string[] The network zones to exclude. Conflicts with
network_includes.- network
Includes string[] The network zones to include. Conflicts with
network_excludes.- priority number
Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last/lowest if not there.
- session
Idle number Max minutes a session can be idle.“,
- session
Lifetime number Max minutes a session is active: Disable = 0.
- session
Persistent boolean Whether session cookies will last across browser sessions. Okta Administrators can never have persistent session cookies.
- status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- users
Excludeds string[] Set of User IDs to Exclude
- policyid str
Policy ID.
- access str
Allow or deny access based on the rule conditions:
"ALLOW"or"DENY". The default is"ALLOW".- authtype str
Authentication entrypoint:
"ANY"or"RADIUS".- mfa_
lifetime float Elapsed time before the next MFA challenge.
- mfa_
prompt str Prompt for MFA based on the device used, a factor session lifetime, or every sign on attempt:
"DEVICE","SESSION"or"ALWAYS".- mfa_
remember_ booldevice Remember MFA device. The default
false.- mfa_
required bool Require MFA. By default is
false.- name str
Policy Rule Name.
- network_
connection str Network selection mode:
"ANYWHERE","ZONE","ON_NETWORK", or"OFF_NETWORK".- network_
excludes List[str] The network zones to exclude. Conflicts with
network_includes.- network_
includes List[str] The network zones to include. Conflicts with
network_excludes.- priority float
Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last/lowest if not there.
- session_
idle float Max minutes a session can be idle.“,
- session_
lifetime float Max minutes a session is active: Disable = 0.
- session_
persistent bool Whether session cookies will last across browser sessions. Okta Administrators can never have persistent session cookies.
- status str
Policy Rule Status:
"ACTIVE"or"INACTIVE".- users_
excludeds List[str] Set of User IDs to Exclude
Outputs
All input properties are implicitly available as output properties. Additionally, the RuleSignon resource produces the following output properties:
Look up an Existing RuleSignon Resource
Get an existing RuleSignon resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RuleSignonState, opts?: CustomResourceOptions): RuleSignonstatic get(resource_name, id, opts=None, access=None, authtype=None, mfa_lifetime=None, mfa_prompt=None, mfa_remember_device=None, mfa_required=None, name=None, network_connection=None, network_excludes=None, network_includes=None, policyid=None, priority=None, session_idle=None, session_lifetime=None, session_persistent=None, status=None, users_excludeds=None, __props__=None);func GetRuleSignon(ctx *Context, name string, id IDInput, state *RuleSignonState, opts ...ResourceOption) (*RuleSignon, error)public static RuleSignon Get(string name, Input<string> id, RuleSignonState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Access string
Allow or deny access based on the rule conditions:
"ALLOW"or"DENY". The default is"ALLOW".- Authtype string
Authentication entrypoint:
"ANY"or"RADIUS".- Mfa
Lifetime int Elapsed time before the next MFA challenge.
- Mfa
Prompt string Prompt for MFA based on the device used, a factor session lifetime, or every sign on attempt:
"DEVICE","SESSION"or"ALWAYS".- Mfa
Remember boolDevice Remember MFA device. The default
false.- Mfa
Required bool Require MFA. By default is
false.- Name string
Policy Rule Name.
- Network
Connection string Network selection mode:
"ANYWHERE","ZONE","ON_NETWORK", or"OFF_NETWORK".- Network
Excludes List<string> The network zones to exclude. Conflicts with
network_includes.- Network
Includes List<string> The network zones to include. Conflicts with
network_excludes.- Policyid string
Policy ID.
- Priority int
Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last/lowest if not there.
- Session
Idle int Max minutes a session can be idle.“,
- Session
Lifetime int Max minutes a session is active: Disable = 0.
- Session
Persistent bool Whether session cookies will last across browser sessions. Okta Administrators can never have persistent session cookies.
- Status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- Users
Excludeds List<string> Set of User IDs to Exclude
- Access string
Allow or deny access based on the rule conditions:
"ALLOW"or"DENY". The default is"ALLOW".- Authtype string
Authentication entrypoint:
"ANY"or"RADIUS".- Mfa
Lifetime int Elapsed time before the next MFA challenge.
- Mfa
Prompt string Prompt for MFA based on the device used, a factor session lifetime, or every sign on attempt:
"DEVICE","SESSION"or"ALWAYS".- Mfa
Remember boolDevice Remember MFA device. The default
false.- Mfa
Required bool Require MFA. By default is
false.- Name string
Policy Rule Name.
- Network
Connection string Network selection mode:
"ANYWHERE","ZONE","ON_NETWORK", or"OFF_NETWORK".- Network
Excludes []string The network zones to exclude. Conflicts with
network_includes.- Network
Includes []string The network zones to include. Conflicts with
network_excludes.- Policyid string
Policy ID.
- Priority int
Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last/lowest if not there.
- Session
Idle int Max minutes a session can be idle.“,
- Session
Lifetime int Max minutes a session is active: Disable = 0.
- Session
Persistent bool Whether session cookies will last across browser sessions. Okta Administrators can never have persistent session cookies.
- Status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- Users
Excludeds []string Set of User IDs to Exclude
- access string
Allow or deny access based on the rule conditions:
"ALLOW"or"DENY". The default is"ALLOW".- authtype string
Authentication entrypoint:
"ANY"or"RADIUS".- mfa
Lifetime number Elapsed time before the next MFA challenge.
- mfa
Prompt string Prompt for MFA based on the device used, a factor session lifetime, or every sign on attempt:
"DEVICE","SESSION"or"ALWAYS".- mfa
Remember booleanDevice Remember MFA device. The default
false.- mfa
Required boolean Require MFA. By default is
false.- name string
Policy Rule Name.
- network
Connection string Network selection mode:
"ANYWHERE","ZONE","ON_NETWORK", or"OFF_NETWORK".- network
Excludes string[] The network zones to exclude. Conflicts with
network_includes.- network
Includes string[] The network zones to include. Conflicts with
network_excludes.- policyid string
Policy ID.
- priority number
Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last/lowest if not there.
- session
Idle number Max minutes a session can be idle.“,
- session
Lifetime number Max minutes a session is active: Disable = 0.
- session
Persistent boolean Whether session cookies will last across browser sessions. Okta Administrators can never have persistent session cookies.
- status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- users
Excludeds string[] Set of User IDs to Exclude
- access str
Allow or deny access based on the rule conditions:
"ALLOW"or"DENY". The default is"ALLOW".- authtype str
Authentication entrypoint:
"ANY"or"RADIUS".- mfa_
lifetime float Elapsed time before the next MFA challenge.
- mfa_
prompt str Prompt for MFA based on the device used, a factor session lifetime, or every sign on attempt:
"DEVICE","SESSION"or"ALWAYS".- mfa_
remember_ booldevice Remember MFA device. The default
false.- mfa_
required bool Require MFA. By default is
false.- name str
Policy Rule Name.
- network_
connection str Network selection mode:
"ANYWHERE","ZONE","ON_NETWORK", or"OFF_NETWORK".- network_
excludes List[str] The network zones to exclude. Conflicts with
network_includes.- network_
includes List[str] The network zones to include. Conflicts with
network_excludes.- policyid str
Policy ID.
- priority float
Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last/lowest if not there.
- session_
idle float Max minutes a session can be idle.“,
- session_
lifetime float Max minutes a session is active: Disable = 0.
- session_
persistent bool Whether session cookies will last across browser sessions. Okta Administrators can never have persistent session cookies.
- status str
Policy Rule Status:
"ACTIVE"or"INACTIVE".- users_
excludeds List[str] Set of User IDs to Exclude
Package Details
- Repository
- https://github.com/pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oktaTerraform Provider.