Rule

Creates an Okta Group Rule.

This resource allows you to create and configure an Okta Group Rule.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.Group.Rule("example", new Okta.Group.RuleArgs
        {
            ExpressionType = "urn:okta:expression:1.0",
            ExpressionValue = "String.startsWith(user.firstName,\"andy\")",
            GroupAssignments = 
            {
                "<group id>",
            },
            Status = "ACTIVE",
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.group.Rule("example",
    expression_type="urn:okta:expression:1.0",
    expression_value="String.startsWith(user.firstName,\"andy\")",
    group_assignments=["<group id>"],
    status="ACTIVE")
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.group.Rule("example", {
    expressionType: "urn:okta:expression:1.0",
    expressionValue: "String.startsWith(user.firstName,\"andy\")",
    groupAssignments: ["<group id>"],
    status: "ACTIVE",
});

Create a Rule Resource

new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
def Rule(resource_name, opts=None, expression_type=None, expression_value=None, group_assignments=None, name=None, status=None, __props__=None);
func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RuleArgs
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 RuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Rule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Rule resource accepts the following input properties:

ExpressionValue string

The expression value.

GroupAssignments List<string>

The list of group ids to assign the users to.

ExpressionType string

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

Name string

The name of the Group Rule.

Status string

The status of the group rule.

ExpressionValue string

The expression value.

GroupAssignments []string

The list of group ids to assign the users to.

ExpressionType string

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

Name string

The name of the Group Rule.

Status string

The status of the group rule.

expressionValue string

The expression value.

groupAssignments string[]

The list of group ids to assign the users to.

expressionType string

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

name string

The name of the Group Rule.

status string

The status of the group rule.

expression_value str

The expression value.

group_assignments List[str]

The list of group ids to assign the users to.

expression_type str

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

name str

The name of the Group Rule.

status str

The status of the group rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the Rule 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing Rule Resource

Get an existing Rule 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?: RuleState, opts?: CustomResourceOptions): Rule
static get(resource_name, id, opts=None, expression_type=None, expression_value=None, group_assignments=None, name=None, status=None, __props__=None);
func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)
public static Rule Get(string name, Input<string> id, RuleState? 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:

ExpressionType string

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

ExpressionValue string

The expression value.

GroupAssignments List<string>

The list of group ids to assign the users to.

Name string

The name of the Group Rule.

Status string

The status of the group rule.

ExpressionType string

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

ExpressionValue string

The expression value.

GroupAssignments []string

The list of group ids to assign the users to.

Name string

The name of the Group Rule.

Status string

The status of the group rule.

expressionType string

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

expressionValue string

The expression value.

groupAssignments string[]

The list of group ids to assign the users to.

name string

The name of the Group Rule.

status string

The status of the group rule.

expression_type str

The expression type to use to invoke the rule. The default is "urn:okta:expression:1.0".

expression_value str

The expression value.

group_assignments List[str]

The list of group ids to assign the users to.

name str

The name of the Group Rule.

status str

The status of the group rule.

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes
This Pulumi package is based on the okta Terraform Provider.