onelogin.AppRules
Explore with Pulumi AI
Manage App Rule resources.
This resource allows you to create and configure App Rules.
Example Usage
Strict Ordering
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.onelogin.AppRules;
import com.pulumi.onelogin.AppRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var check = new AppRules("check", AppRulesArgs.builder()
.appId(onelogin_saml_apps.my_saml_app().id())
.position(1)
.enabled(true)
.match("all")
.conditions(AppRulesConditionArgs.builder()
.operator("ri")
.source("has_role")
.value("340475")
.build())
.actions(AppRulesActionArgs.builder()
.action("set_amazonusername")
.expression(".*")
.values("member_of")
.build())
.build());
}
}
resources:
check:
type: onelogin:AppRules
properties:
appId: ${onelogin_saml_apps.my_saml_app.id}
position: 1
enabled: true
match: all
conditions:
operator: ri
source: has_role
value: '340475'
actions:
action: set_amazonusername
expression: .*
values:
- member_of
Dependency Based Ordering
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.onelogin.AppRules;
import com.pulumi.onelogin.AppRulesArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new AppRules("test", AppRulesArgs.builder()
.appId(onelogin_saml_apps.my_saml_app().id())
.enabled(true)
.match("all")
.conditions(AppRulesConditionArgs.builder()
.operator("ri")
.source("has_role")
.value("340475")
.build())
.actions(AppRulesActionArgs.builder()
.action("set_amazonusername")
.expression(".*")
.values("member_of")
.build())
.build());
var check = new AppRules("check", AppRulesArgs.builder()
.appId(onelogin_saml_apps.my_saml_app().id())
.enabled(true)
.match("all")
.conditions(AppRulesConditionArgs.builder()
.operator("ri")
.source("has_role")
.value("340475")
.build())
.actions(AppRulesActionArgs.builder()
.action("set_amazonusername")
.expression(".*")
.values("member_of")
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(test)
.build());
}
}
resources:
test:
type: onelogin:AppRules
properties:
appId: ${onelogin_saml_apps.my_saml_app.id}
enabled: true
match: all
conditions:
operator: ri
source: has_role
value: '340475'
actions:
action: set_amazonusername
expression: .*
values:
- member_of
check:
type: onelogin:AppRules
properties:
appId: ${onelogin_saml_apps.my_saml_app.id}
enabled: true
match: all
conditions:
operator: ri
source: has_role
value: '340475'
actions:
action: set_amazonusername
expression: .*
values:
- member_of
options:
dependsOn:
- ${test}
Create AppRules Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppRules(name: string, args: AppRulesArgs, opts?: CustomResourceOptions);
@overload
def AppRules(resource_name: str,
args: AppRulesArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AppRules(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
match: Optional[str] = None,
actions: Optional[Sequence[AppRulesActionArgs]] = None,
app_rules_id: Optional[str] = None,
conditions: Optional[Sequence[AppRulesConditionArgs]] = None,
enabled: Optional[bool] = None,
name: Optional[str] = None,
position: Optional[float] = None)
func NewAppRules(ctx *Context, name string, args AppRulesArgs, opts ...ResourceOption) (*AppRules, error)
public AppRules(string name, AppRulesArgs args, CustomResourceOptions? opts = null)
public AppRules(String name, AppRulesArgs args)
public AppRules(String name, AppRulesArgs args, CustomResourceOptions options)
type: onelogin:AppRules
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AppRulesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AppRulesArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AppRulesArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppRulesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppRulesArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var appRulesResource = new Onelogin.AppRules("appRulesResource", new()
{
AppId = "string",
Match = "string",
Actions = new[]
{
new Onelogin.Inputs.AppRulesActionArgs
{
Action = "string",
Values = new[]
{
"string",
},
Expression = "string",
Macro = "string",
Scriplet = "string",
},
},
AppRulesId = "string",
Conditions = new[]
{
new Onelogin.Inputs.AppRulesConditionArgs
{
Operator = "string",
Source = "string",
Value = "string",
},
},
Enabled = false,
Name = "string",
Position = 0,
});
example, err := onelogin.NewAppRules(ctx, "appRulesResource", &onelogin.AppRulesArgs{
AppId: pulumi.String("string"),
Match: pulumi.String("string"),
Actions: onelogin.AppRulesActionArray{
&onelogin.AppRulesActionArgs{
Action: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Expression: pulumi.String("string"),
Macro: pulumi.String("string"),
Scriplet: pulumi.String("string"),
},
},
AppRulesId: pulumi.String("string"),
Conditions: onelogin.AppRulesConditionArray{
&onelogin.AppRulesConditionArgs{
Operator: pulumi.String("string"),
Source: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Enabled: pulumi.Bool(false),
Name: pulumi.String("string"),
Position: pulumi.Float64(0),
})
var appRulesResource = new AppRules("appRulesResource", AppRulesArgs.builder()
.appId("string")
.match("string")
.actions(AppRulesActionArgs.builder()
.action("string")
.values("string")
.expression("string")
.macro("string")
.scriplet("string")
.build())
.appRulesId("string")
.conditions(AppRulesConditionArgs.builder()
.operator("string")
.source("string")
.value("string")
.build())
.enabled(false)
.name("string")
.position(0.0)
.build());
app_rules_resource = onelogin.AppRules("appRulesResource",
app_id="string",
match="string",
actions=[{
"action": "string",
"values": ["string"],
"expression": "string",
"macro": "string",
"scriplet": "string",
}],
app_rules_id="string",
conditions=[{
"operator": "string",
"source": "string",
"value": "string",
}],
enabled=False,
name="string",
position=0)
const appRulesResource = new onelogin.AppRules("appRulesResource", {
appId: "string",
match: "string",
actions: [{
action: "string",
values: ["string"],
expression: "string",
macro: "string",
scriplet: "string",
}],
appRulesId: "string",
conditions: [{
operator: "string",
source: "string",
value: "string",
}],
enabled: false,
name: "string",
position: 0,
});
type: onelogin:AppRules
properties:
actions:
- action: string
expression: string
macro: string
scriplet: string
values:
- string
appId: string
appRulesId: string
conditions:
- operator: string
source: string
value: string
enabled: false
match: string
name: string
position: 0
AppRules Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AppRules resource accepts the following input properties:
- App
Id string - The id of the App resource to which the rule should belong.
- Match string
- Indicates how conditions should be matched. Must be one of
all
orany
. - Actions
List<App
Rules Action> - An array of actions that will be applied to the users that are matched by the conditions.
- App
Rules stringId - Conditions
List<App
Rules Condition> - An array of conditions that the user must meet in order for the rule to be applied.
- Enabled bool
- Indicate if the rule should go into effect.
- Name string
- The Rule's name
- Position double
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- App
Id string - The id of the App resource to which the rule should belong.
- Match string
- Indicates how conditions should be matched. Must be one of
all
orany
. - Actions
[]App
Rules Action Args - An array of actions that will be applied to the users that are matched by the conditions.
- App
Rules stringId - Conditions
[]App
Rules Condition Args - An array of conditions that the user must meet in order for the rule to be applied.
- Enabled bool
- Indicate if the rule should go into effect.
- Name string
- The Rule's name
- Position float64
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- app
Id String - The id of the App resource to which the rule should belong.
- match String
- Indicates how conditions should be matched. Must be one of
all
orany
. - actions
List<App
Rules Action> - An array of actions that will be applied to the users that are matched by the conditions.
- app
Rules StringId - conditions
List<App
Rules Condition> - An array of conditions that the user must meet in order for the rule to be applied.
- enabled Boolean
- Indicate if the rule should go into effect.
- name String
- The Rule's name
- position Double
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- app
Id string - The id of the App resource to which the rule should belong.
- match string
- Indicates how conditions should be matched. Must be one of
all
orany
. - actions
App
Rules Action[] - An array of actions that will be applied to the users that are matched by the conditions.
- app
Rules stringId - conditions
App
Rules Condition[] - An array of conditions that the user must meet in order for the rule to be applied.
- enabled boolean
- Indicate if the rule should go into effect.
- name string
- The Rule's name
- position number
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- app_
id str - The id of the App resource to which the rule should belong.
- match str
- Indicates how conditions should be matched. Must be one of
all
orany
. - actions
Sequence[App
Rules Action Args] - An array of actions that will be applied to the users that are matched by the conditions.
- app_
rules_ strid - conditions
Sequence[App
Rules Condition Args] - An array of conditions that the user must meet in order for the rule to be applied.
- enabled bool
- Indicate if the rule should go into effect.
- name str
- The Rule's name
- position float
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- app
Id String - The id of the App resource to which the rule should belong.
- match String
- Indicates how conditions should be matched. Must be one of
all
orany
. - actions List<Property Map>
- An array of actions that will be applied to the users that are matched by the conditions.
- app
Rules StringId - conditions List<Property Map>
- An array of conditions that the user must meet in order for the rule to be applied.
- enabled Boolean
- Indicate if the rule should go into effect.
- name String
- The Rule's name
- position Number
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
Outputs
All input properties are implicitly available as output properties. Additionally, the AppRules resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing AppRules Resource
Get an existing AppRules 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?: AppRulesState, opts?: CustomResourceOptions): AppRules
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
actions: Optional[Sequence[AppRulesActionArgs]] = None,
app_id: Optional[str] = None,
app_rules_id: Optional[str] = None,
conditions: Optional[Sequence[AppRulesConditionArgs]] = None,
enabled: Optional[bool] = None,
match: Optional[str] = None,
name: Optional[str] = None,
position: Optional[float] = None) -> AppRules
func GetAppRules(ctx *Context, name string, id IDInput, state *AppRulesState, opts ...ResourceOption) (*AppRules, error)
public static AppRules Get(string name, Input<string> id, AppRulesState? state, CustomResourceOptions? opts = null)
public static AppRules get(String name, Output<String> id, AppRulesState state, CustomResourceOptions options)
resources: _: type: onelogin:AppRules get: id: ${id}
- 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.
- 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.
- Actions
List<App
Rules Action> - An array of actions that will be applied to the users that are matched by the conditions.
- App
Id string - The id of the App resource to which the rule should belong.
- App
Rules stringId - Conditions
List<App
Rules Condition> - An array of conditions that the user must meet in order for the rule to be applied.
- Enabled bool
- Indicate if the rule should go into effect.
- Match string
- Indicates how conditions should be matched. Must be one of
all
orany
. - Name string
- The Rule's name
- Position double
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- Actions
[]App
Rules Action Args - An array of actions that will be applied to the users that are matched by the conditions.
- App
Id string - The id of the App resource to which the rule should belong.
- App
Rules stringId - Conditions
[]App
Rules Condition Args - An array of conditions that the user must meet in order for the rule to be applied.
- Enabled bool
- Indicate if the rule should go into effect.
- Match string
- Indicates how conditions should be matched. Must be one of
all
orany
. - Name string
- The Rule's name
- Position float64
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- actions
List<App
Rules Action> - An array of actions that will be applied to the users that are matched by the conditions.
- app
Id String - The id of the App resource to which the rule should belong.
- app
Rules StringId - conditions
List<App
Rules Condition> - An array of conditions that the user must meet in order for the rule to be applied.
- enabled Boolean
- Indicate if the rule should go into effect.
- match String
- Indicates how conditions should be matched. Must be one of
all
orany
. - name String
- The Rule's name
- position Double
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- actions
App
Rules Action[] - An array of actions that will be applied to the users that are matched by the conditions.
- app
Id string - The id of the App resource to which the rule should belong.
- app
Rules stringId - conditions
App
Rules Condition[] - An array of conditions that the user must meet in order for the rule to be applied.
- enabled boolean
- Indicate if the rule should go into effect.
- match string
- Indicates how conditions should be matched. Must be one of
all
orany
. - name string
- The Rule's name
- position number
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- actions
Sequence[App
Rules Action Args] - An array of actions that will be applied to the users that are matched by the conditions.
- app_
id str - The id of the App resource to which the rule should belong.
- app_
rules_ strid - conditions
Sequence[App
Rules Condition Args] - An array of conditions that the user must meet in order for the rule to be applied.
- enabled bool
- Indicate if the rule should go into effect.
- match str
- Indicates how conditions should be matched. Must be one of
all
orany
. - name str
- The Rule's name
- position float
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
- actions List<Property Map>
- An array of actions that will be applied to the users that are matched by the conditions.
- app
Id String - The id of the App resource to which the rule should belong.
- app
Rules StringId - conditions List<Property Map>
- An array of conditions that the user must meet in order for the rule to be applied.
- enabled Boolean
- Indicate if the rule should go into effect.
- match String
- Indicates how conditions should be matched. Must be one of
all
orany
. - name String
- The Rule's name
- position Number
- Indicates the ordering of the rule. When not supplied the rule will be put at the end of the list on create and managed by the provider. '0' can be supplied to consistently push this rule to the end of the list on every update.
Supporting Types
AppRulesAction, AppRulesActionArgs
- Action string
- The action to apply. See List Actions for possible values. Note: The action
set_role_from_existing
may also be used, however doing so will always clear theexpression
field as it is not accepted when mapping a rule from existing roles. - Values List<string>
- An array of strings. Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action. See List Action Values for possible values. In most cases only a single item will be accepted in the array.
- Expression string
- A regular expression to extract a value. Applies to provisionable, multi-selects, and string actions.
- Macro string
- A template to construct a value. Applies to default, string, and list actions.
- Scriplet string
- Action string
- The action to apply. See List Actions for possible values. Note: The action
set_role_from_existing
may also be used, however doing so will always clear theexpression
field as it is not accepted when mapping a rule from existing roles. - Values []string
- An array of strings. Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action. See List Action Values for possible values. In most cases only a single item will be accepted in the array.
- Expression string
- A regular expression to extract a value. Applies to provisionable, multi-selects, and string actions.
- Macro string
- A template to construct a value. Applies to default, string, and list actions.
- Scriplet string
- action String
- The action to apply. See List Actions for possible values. Note: The action
set_role_from_existing
may also be used, however doing so will always clear theexpression
field as it is not accepted when mapping a rule from existing roles. - values List<String>
- An array of strings. Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action. See List Action Values for possible values. In most cases only a single item will be accepted in the array.
- expression String
- A regular expression to extract a value. Applies to provisionable, multi-selects, and string actions.
- macro String
- A template to construct a value. Applies to default, string, and list actions.
- scriplet String
- action string
- The action to apply. See List Actions for possible values. Note: The action
set_role_from_existing
may also be used, however doing so will always clear theexpression
field as it is not accepted when mapping a rule from existing roles. - values string[]
- An array of strings. Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action. See List Action Values for possible values. In most cases only a single item will be accepted in the array.
- expression string
- A regular expression to extract a value. Applies to provisionable, multi-selects, and string actions.
- macro string
- A template to construct a value. Applies to default, string, and list actions.
- scriplet string
- action str
- The action to apply. See List Actions for possible values. Note: The action
set_role_from_existing
may also be used, however doing so will always clear theexpression
field as it is not accepted when mapping a rule from existing roles. - values Sequence[str]
- An array of strings. Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action. See List Action Values for possible values. In most cases only a single item will be accepted in the array.
- expression str
- A regular expression to extract a value. Applies to provisionable, multi-selects, and string actions.
- macro str
- A template to construct a value. Applies to default, string, and list actions.
- scriplet str
- action String
- The action to apply. See List Actions for possible values. Note: The action
set_role_from_existing
may also be used, however doing so will always clear theexpression
field as it is not accepted when mapping a rule from existing roles. - values List<String>
- An array of strings. Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action. See List Action Values for possible values. In most cases only a single item will be accepted in the array.
- expression String
- A regular expression to extract a value. Applies to provisionable, multi-selects, and string actions.
- macro String
- A template to construct a value. Applies to default, string, and list actions.
- scriplet String
AppRulesCondition, AppRulesConditionArgs
- Operator string
- A valid operator for the selected condition source. See List Condition Operators for possible values.
- Source string
- The source field to check. See List Conditions for possible values.
- Value string
- A plain text string or valid value for the selected condition source. See List Condition Values for possible values.
- Operator string
- A valid operator for the selected condition source. See List Condition Operators for possible values.
- Source string
- The source field to check. See List Conditions for possible values.
- Value string
- A plain text string or valid value for the selected condition source. See List Condition Values for possible values.
- operator String
- A valid operator for the selected condition source. See List Condition Operators for possible values.
- source String
- The source field to check. See List Conditions for possible values.
- value String
- A plain text string or valid value for the selected condition source. See List Condition Values for possible values.
- operator string
- A valid operator for the selected condition source. See List Condition Operators for possible values.
- source string
- The source field to check. See List Conditions for possible values.
- value string
- A plain text string or valid value for the selected condition source. See List Condition Values for possible values.
- operator str
- A valid operator for the selected condition source. See List Condition Operators for possible values.
- source str
- The source field to check. See List Conditions for possible values.
- value str
- A plain text string or valid value for the selected condition source. See List Condition Values for possible values.
- operator String
- A valid operator for the selected condition source. See List Condition Operators for possible values.
- source String
- The source field to check. See List Conditions for possible values.
- value String
- A plain text string or valid value for the selected condition source. See List Condition Values for possible values.
Import
ant Note Regarding Position
The position field indicates the order in which rules are applied. They behave like progressive filters and as such, their positioning is strictly enforced. Your options for this field are to either:
Accept any ordering - Do not fill out any position field and each rule will be inserted in the order received by the API.
Strict Ordering - Enter a position number for each app rule. You’ll need to ensure there are no duplicates and no gaps in numbering.
Dependency based ordering - Use the
depends_on
field to specify an app rule’s predecessor to ensure rules are received by the API in the order in which they should be applied. e.g.depends_on = [onelogin_app_rules.test]
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- onelogin onelogin/terraform-provider-onelogin
- License
- Notes
- This Pulumi package is based on the
onelogin
Terraform Provider.