Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. PolicyRuleProfileEnrollment
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

okta.PolicyRuleProfileEnrollment

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

    WARNING: This feature is only available as a part of the Identity Engine. Contact support for further information.

    A profile enrollment policy is limited to one default rule. This resource does not create a rule for an enrollment policy, it allows the default policy rule to be updated.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const examplePolicyProfileEnrollment = new okta.PolicyProfileEnrollment("examplePolicyProfileEnrollment", {});
const exampleHook = new okta.inline.Hook("exampleHook", {
    status: "ACTIVE",
    type: "com.okta.user.pre-registration",
    version: "1.0.3",
    channel: {
        type: "HTTP",
        version: "1.0.0",
        uri: "https://example.com/test2",
        method: "POST",
    },
});
const exampleGroup = new okta.group.Group("exampleGroup", {description: "Group of some users"});
const examplePolicyRuleProfileEnrollment = new okta.PolicyRuleProfileEnrollment("examplePolicyRuleProfileEnrollment", {
    policyId: examplePolicyProfileEnrollment.id,
    inlineHookId: exampleHook.id,
    targetGroupId: exampleGroup.id,
    unknownUserAction: "REGISTER",
    emailVerification: true,
    access: "ALLOW",
    profileAttributes: [
        {
            name: "email",
            label: "Email",
            required: true,
        },
        {
            name: "name",
            label: "Name",
            required: true,
        },
        {
            name: "t-shirt",
            label: "T-Shirt Size",
            required: false,
        },
    ],
});

    import pulumi
import pulumi_okta as okta

example_policy_profile_enrollment = okta.PolicyProfileEnrollment("examplePolicyProfileEnrollment")
example_hook = okta.inline.Hook("exampleHook",
    status="ACTIVE",
    type="com.okta.user.pre-registration",
    version="1.0.3",
    channel={
        "type": "HTTP",
        "version": "1.0.0",
        "uri": "https://example.com/test2",
        "method": "POST",
    })
example_group = okta.group.Group("exampleGroup", description="Group of some users")
example_policy_rule_profile_enrollment = okta.PolicyRuleProfileEnrollment("examplePolicyRuleProfileEnrollment",
    policy_id=example_policy_profile_enrollment.id,
    inline_hook_id=example_hook.id,
    target_group_id=example_group.id,
    unknown_user_action="REGISTER",
    email_verification=True,
    access="ALLOW",
    profile_attributes=[
        okta.PolicyRuleProfileEnrollmentProfileAttributeArgs(
            name="email",
            label="Email",
            required=True,
        ),
        okta.PolicyRuleProfileEnrollmentProfileAttributeArgs(
            name="name",
            label="Name",
            required=True,
        ),
        okta.PolicyRuleProfileEnrollmentProfileAttributeArgs(
            name="t-shirt",
            label="T-Shirt Size",
            required=False,
        ),
    ])

    package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/group"
	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/inline"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		examplePolicyProfileEnrollment, err := okta.NewPolicyProfileEnrollment(ctx, "examplePolicyProfileEnrollment", nil)
		if err != nil {
			return err
		}
		exampleHook, err := inline.NewHook(ctx, "exampleHook", &inline.HookArgs{
			Status:  pulumi.String("ACTIVE"),
			Type:    pulumi.String("com.okta.user.pre-registration"),
			Version: pulumi.String("1.0.3"),
			Channel: pulumi.StringMap{
				"type":    pulumi.String("HTTP"),
				"version": pulumi.String("1.0.0"),
				"uri":     pulumi.String("https://example.com/test2"),
				"method":  pulumi.String("POST"),
			},
		})
		if err != nil {
			return err
		}
		exampleGroup, err := group.NewGroup(ctx, "exampleGroup", &group.GroupArgs{
			Description: pulumi.String("Group of some users"),
		})
		if err != nil {
			return err
		}
		_, err = okta.NewPolicyRuleProfileEnrollment(ctx, "examplePolicyRuleProfileEnrollment", &okta.PolicyRuleProfileEnrollmentArgs{
			PolicyId:          examplePolicyProfileEnrollment.ID(),
			InlineHookId:      exampleHook.ID(),
			TargetGroupId:     exampleGroup.ID(),
			UnknownUserAction: pulumi.String("REGISTER"),
			EmailVerification: pulumi.Bool(true),
			Access:            pulumi.String("ALLOW"),
			ProfileAttributes: okta.PolicyRuleProfileEnrollmentProfileAttributeArray{
				&okta.PolicyRuleProfileEnrollmentProfileAttributeArgs{
					Name:     pulumi.String("email"),
					Label:    pulumi.String("Email"),
					Required: pulumi.Bool(true),
				},
				&okta.PolicyRuleProfileEnrollmentProfileAttributeArgs{
					Name:     pulumi.String("name"),
					Label:    pulumi.String("Name"),
					Required: pulumi.Bool(true),
				},
				&okta.PolicyRuleProfileEnrollmentProfileAttributeArgs{
					Name:     pulumi.String("t-shirt"),
					Label:    pulumi.String("T-Shirt Size"),
					Required: pulumi.Bool(false),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var examplePolicyProfileEnrollment = new Okta.PolicyProfileEnrollment("examplePolicyProfileEnrollment");

    var exampleHook = new Okta.Inline.Hook("exampleHook", new()
    {
        Status = "ACTIVE",
        Type = "com.okta.user.pre-registration",
        Version = "1.0.3",
        Channel = 
        {
            { "type", "HTTP" },
            { "version", "1.0.0" },
            { "uri", "https://example.com/test2" },
            { "method", "POST" },
        },
    });

    var exampleGroup = new Okta.Group.Group("exampleGroup", new()
    {
        Description = "Group of some users",
    });

    var examplePolicyRuleProfileEnrollment = new Okta.PolicyRuleProfileEnrollment("examplePolicyRuleProfileEnrollment", new()
    {
        PolicyId = examplePolicyProfileEnrollment.Id,
        InlineHookId = exampleHook.Id,
        TargetGroupId = exampleGroup.Id,
        UnknownUserAction = "REGISTER",
        EmailVerification = true,
        Access = "ALLOW",
        ProfileAttributes = new[]
        {
            new Okta.Inputs.PolicyRuleProfileEnrollmentProfileAttributeArgs
            {
                Name = "email",
                Label = "Email",
                Required = true,
            },
            new Okta.Inputs.PolicyRuleProfileEnrollmentProfileAttributeArgs
            {
                Name = "name",
                Label = "Name",
                Required = true,
            },
            new Okta.Inputs.PolicyRuleProfileEnrollmentProfileAttributeArgs
            {
                Name = "t-shirt",
                Label = "T-Shirt Size",
                Required = false,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.PolicyProfileEnrollment;
import com.pulumi.okta.inline.Hook;
import com.pulumi.okta.inline.HookArgs;
import com.pulumi.okta.group.Group;
import com.pulumi.okta.group.GroupArgs;
import com.pulumi.okta.PolicyRuleProfileEnrollment;
import com.pulumi.okta.PolicyRuleProfileEnrollmentArgs;
import com.pulumi.okta.inputs.PolicyRuleProfileEnrollmentProfileAttributeArgs;
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 examplePolicyProfileEnrollment = new PolicyProfileEnrollment("examplePolicyProfileEnrollment");

        var exampleHook = new Hook("exampleHook", HookArgs.builder()        
            .status("ACTIVE")
            .type("com.okta.user.pre-registration")
            .version("1.0.3")
            .channel(Map.ofEntries(
                Map.entry("type", "HTTP"),
                Map.entry("version", "1.0.0"),
                Map.entry("uri", "https://example.com/test2"),
                Map.entry("method", "POST")
            ))
            .build());

        var exampleGroup = new Group("exampleGroup", GroupArgs.builder()        
            .description("Group of some users")
            .build());

        var examplePolicyRuleProfileEnrollment = new PolicyRuleProfileEnrollment("examplePolicyRuleProfileEnrollment", PolicyRuleProfileEnrollmentArgs.builder()        
            .policyId(examplePolicyProfileEnrollment.id())
            .inlineHookId(exampleHook.id())
            .targetGroupId(exampleGroup.id())
            .unknownUserAction("REGISTER")
            .emailVerification(true)
            .access("ALLOW")
            .profileAttributes(            
                PolicyRuleProfileEnrollmentProfileAttributeArgs.builder()
                    .name("email")
                    .label("Email")
                    .required(true)
                    .build(),
                PolicyRuleProfileEnrollmentProfileAttributeArgs.builder()
                    .name("name")
                    .label("Name")
                    .required(true)
                    .build(),
                PolicyRuleProfileEnrollmentProfileAttributeArgs.builder()
                    .name("t-shirt")
                    .label("T-Shirt Size")
                    .required(false)
                    .build())
            .build());

    }
}

    resources:
  examplePolicyProfileEnrollment:
    type: okta:PolicyProfileEnrollment
  exampleHook:
    type: okta:inline:Hook
    properties:
      status: ACTIVE
      type: com.okta.user.pre-registration
      version: 1.0.3
      channel:
        type: HTTP
        version: 1.0.0
        uri: https://example.com/test2
        method: POST
  exampleGroup:
    type: okta:group:Group
    properties:
      description: Group of some users
  examplePolicyRuleProfileEnrollment:
    type: okta:PolicyRuleProfileEnrollment
    properties:
      policyId: ${examplePolicyProfileEnrollment.id}
      inlineHookId: ${exampleHook.id}
      targetGroupId: ${exampleGroup.id}
      unknownUserAction: REGISTER
      emailVerification: true
      access: ALLOW
      profileAttributes:
        - name: email
          label: Email
          required: true
        - name: name
          label: Name
          required: true
        - name: t-shirt
          label: T-Shirt Size
          required: false

    Create PolicyRuleProfileEnrollment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PolicyRuleProfileEnrollment(name: string, args: PolicyRuleProfileEnrollmentArgs, opts?: CustomResourceOptions);
    @overload
def PolicyRuleProfileEnrollment(resource_name: str,
                                args: PolicyRuleProfileEnrollmentArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def PolicyRuleProfileEnrollment(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                policy_id: Optional[str] = None,
                                unknown_user_action: Optional[str] = None,
                                access: Optional[str] = None,
                                email_verification: Optional[bool] = None,
                                inline_hook_id: Optional[str] = None,
                                profile_attributes: Optional[Sequence[PolicyRuleProfileEnrollmentProfileAttributeArgs]] = None,
                                progressive_profiling_action: Optional[str] = None,
                                target_group_id: Optional[str] = None,
                                ui_schema_id: Optional[str] = None)
    func NewPolicyRuleProfileEnrollment(ctx *Context, name string, args PolicyRuleProfileEnrollmentArgs, opts ...ResourceOption) (*PolicyRuleProfileEnrollment, error)
    public PolicyRuleProfileEnrollment(string name, PolicyRuleProfileEnrollmentArgs args, CustomResourceOptions? opts = null)
    public PolicyRuleProfileEnrollment(String name, PolicyRuleProfileEnrollmentArgs args)
public PolicyRuleProfileEnrollment(String name, PolicyRuleProfileEnrollmentArgs args, CustomResourceOptions options)

    type: okta:PolicyRuleProfileEnrollment
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 PolicyRuleProfileEnrollmentArgs
    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 PolicyRuleProfileEnrollmentArgs
    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 PolicyRuleProfileEnrollmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyRuleProfileEnrollmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyRuleProfileEnrollmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var policyRuleProfileEnrollmentResource = new Okta.PolicyRuleProfileEnrollment("policyRuleProfileEnrollmentResource", new()
{
    PolicyId = "string",
    UnknownUserAction = "string",
    Access = "string",
    EmailVerification = false,
    InlineHookId = "string",
    ProfileAttributes = new[]
    {
        new Okta.Inputs.PolicyRuleProfileEnrollmentProfileAttributeArgs
        {
            Label = "string",
            Name = "string",
            Required = false,
        },
    },
    ProgressiveProfilingAction = "string",
    TargetGroupId = "string",
    UiSchemaId = "string",
});

    example, err := okta.NewPolicyRuleProfileEnrollment(ctx, "policyRuleProfileEnrollmentResource", &okta.PolicyRuleProfileEnrollmentArgs{
	PolicyId:          pulumi.String("string"),
	UnknownUserAction: pulumi.String("string"),
	Access:            pulumi.String("string"),
	EmailVerification: pulumi.Bool(false),
	InlineHookId:      pulumi.String("string"),
	ProfileAttributes: okta.PolicyRuleProfileEnrollmentProfileAttributeArray{
		&okta.PolicyRuleProfileEnrollmentProfileAttributeArgs{
			Label:    pulumi.String("string"),
			Name:     pulumi.String("string"),
			Required: pulumi.Bool(false),
		},
	},
	ProgressiveProfilingAction: pulumi.String("string"),
	TargetGroupId:              pulumi.String("string"),
	UiSchemaId:                 pulumi.String("string"),
})

    var policyRuleProfileEnrollmentResource = new PolicyRuleProfileEnrollment("policyRuleProfileEnrollmentResource", PolicyRuleProfileEnrollmentArgs.builder()        
    .policyId("string")
    .unknownUserAction("string")
    .access("string")
    .emailVerification(false)
    .inlineHookId("string")
    .profileAttributes(PolicyRuleProfileEnrollmentProfileAttributeArgs.builder()
        .label("string")
        .name("string")
        .required(false)
        .build())
    .progressiveProfilingAction("string")
    .targetGroupId("string")
    .uiSchemaId("string")
    .build());

    policy_rule_profile_enrollment_resource = okta.PolicyRuleProfileEnrollment("policyRuleProfileEnrollmentResource",
    policy_id="string",
    unknown_user_action="string",
    access="string",
    email_verification=False,
    inline_hook_id="string",
    profile_attributes=[okta.PolicyRuleProfileEnrollmentProfileAttributeArgs(
        label="string",
        name="string",
        required=False,
    )],
    progressive_profiling_action="string",
    target_group_id="string",
    ui_schema_id="string")

    const policyRuleProfileEnrollmentResource = new okta.PolicyRuleProfileEnrollment("policyRuleProfileEnrollmentResource", {
    policyId: "string",
    unknownUserAction: "string",
    access: "string",
    emailVerification: false,
    inlineHookId: "string",
    profileAttributes: [{
        label: "string",
        name: "string",
        required: false,
    }],
    progressiveProfilingAction: "string",
    targetGroupId: "string",
    uiSchemaId: "string",
});

    type: okta:PolicyRuleProfileEnrollment
properties:
    access: string
    emailVerification: false
    inlineHookId: string
    policyId: string
    profileAttributes:
        - label: string
          name: string
          required: false
    progressiveProfilingAction: string
    targetGroupId: string
    uiSchemaId: string
    unknownUserAction: string

    PolicyRuleProfileEnrollment Resource Properties

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

    Inputs

    The PolicyRuleProfileEnrollment resource accepts the following input properties:

    PolicyId string
    Policy ID.
    UnknownUserAction string
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    Access string
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    EmailVerification bool
    Indicates whether email verification should occur before access is granted. Default is true.
    InlineHookId string
    ID of a Registration Inline Hook.
    ProfileAttributes List<PolicyRuleProfileEnrollmentProfileAttribute>
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    ProgressiveProfilingAction string
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    TargetGroupId string
    The ID of a Group that this User should be added to.
    UiSchemaId string
    Value created by the backend. If present all policy updates must include this attribute/value.
    PolicyId string
    Policy ID.
    UnknownUserAction string
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    Access string
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    EmailVerification bool
    Indicates whether email verification should occur before access is granted. Default is true.
    InlineHookId string
    ID of a Registration Inline Hook.
    ProfileAttributes []PolicyRuleProfileEnrollmentProfileAttributeArgs
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    ProgressiveProfilingAction string
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    TargetGroupId string
    The ID of a Group that this User should be added to.
    UiSchemaId string
    Value created by the backend. If present all policy updates must include this attribute/value.
    policyId String
    Policy ID.
    unknownUserAction String
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    access String
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    emailVerification Boolean
    Indicates whether email verification should occur before access is granted. Default is true.
    inlineHookId String
    ID of a Registration Inline Hook.
    profileAttributes List<PolicyRuleProfileEnrollmentProfileAttribute>
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    progressiveProfilingAction String
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    targetGroupId String
    The ID of a Group that this User should be added to.
    uiSchemaId String
    Value created by the backend. If present all policy updates must include this attribute/value.
    policyId string
    Policy ID.
    unknownUserAction string
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    access string
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    emailVerification boolean
    Indicates whether email verification should occur before access is granted. Default is true.
    inlineHookId string
    ID of a Registration Inline Hook.
    profileAttributes PolicyRuleProfileEnrollmentProfileAttribute[]
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    progressiveProfilingAction string
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    targetGroupId string
    The ID of a Group that this User should be added to.
    uiSchemaId string
    Value created by the backend. If present all policy updates must include this attribute/value.
    policy_id str
    Policy ID.
    unknown_user_action str
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    access str
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    email_verification bool
    Indicates whether email verification should occur before access is granted. Default is true.
    inline_hook_id str
    ID of a Registration Inline Hook.
    profile_attributes Sequence[PolicyRuleProfileEnrollmentProfileAttributeArgs]
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    progressive_profiling_action str
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    target_group_id str
    The ID of a Group that this User should be added to.
    ui_schema_id str
    Value created by the backend. If present all policy updates must include this attribute/value.
    policyId String
    Policy ID.
    unknownUserAction String
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    access String
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    emailVerification Boolean
    Indicates whether email verification should occur before access is granted. Default is true.
    inlineHookId String
    ID of a Registration Inline Hook.
    profileAttributes List<Property Map>
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    progressiveProfilingAction String
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    targetGroupId String
    The ID of a Group that this User should be added to.
    uiSchemaId String
    Value created by the backend. If present all policy updates must include this attribute/value.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyRuleProfileEnrollment resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of a User Profile property
    Status string
    Status of the Rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of a User Profile property
    Status string
    Status of the Rule.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of a User Profile property
    status String
    Status of the Rule.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of a User Profile property
    status string
    Status of the Rule.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of a User Profile property
    status str
    Status of the Rule.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of a User Profile property
    status String
    Status of the Rule.

    Look up Existing PolicyRuleProfileEnrollment Resource

    Get an existing PolicyRuleProfileEnrollment 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?: PolicyRuleProfileEnrollmentState, opts?: CustomResourceOptions): PolicyRuleProfileEnrollment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access: Optional[str] = None,
        email_verification: Optional[bool] = None,
        inline_hook_id: Optional[str] = None,
        name: Optional[str] = None,
        policy_id: Optional[str] = None,
        profile_attributes: Optional[Sequence[PolicyRuleProfileEnrollmentProfileAttributeArgs]] = None,
        progressive_profiling_action: Optional[str] = None,
        status: Optional[str] = None,
        target_group_id: Optional[str] = None,
        ui_schema_id: Optional[str] = None,
        unknown_user_action: Optional[str] = None) -> PolicyRuleProfileEnrollment
    func GetPolicyRuleProfileEnrollment(ctx *Context, name string, id IDInput, state *PolicyRuleProfileEnrollmentState, opts ...ResourceOption) (*PolicyRuleProfileEnrollment, error)
    public static PolicyRuleProfileEnrollment Get(string name, Input<string> id, PolicyRuleProfileEnrollmentState? state, CustomResourceOptions? opts = null)
    public static PolicyRuleProfileEnrollment get(String name, Output<String> id, PolicyRuleProfileEnrollmentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    Access string
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    EmailVerification bool
    Indicates whether email verification should occur before access is granted. Default is true.
    InlineHookId string
    ID of a Registration Inline Hook.
    Name string
    The name of a User Profile property
    PolicyId string
    Policy ID.
    ProfileAttributes List<PolicyRuleProfileEnrollmentProfileAttribute>
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    ProgressiveProfilingAction string
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    Status string
    Status of the Rule.
    TargetGroupId string
    The ID of a Group that this User should be added to.
    UiSchemaId string
    Value created by the backend. If present all policy updates must include this attribute/value.
    UnknownUserAction string
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    Access string
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    EmailVerification bool
    Indicates whether email verification should occur before access is granted. Default is true.
    InlineHookId string
    ID of a Registration Inline Hook.
    Name string
    The name of a User Profile property
    PolicyId string
    Policy ID.
    ProfileAttributes []PolicyRuleProfileEnrollmentProfileAttributeArgs
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    ProgressiveProfilingAction string
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    Status string
    Status of the Rule.
    TargetGroupId string
    The ID of a Group that this User should be added to.
    UiSchemaId string
    Value created by the backend. If present all policy updates must include this attribute/value.
    UnknownUserAction string
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    access String
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    emailVerification Boolean
    Indicates whether email verification should occur before access is granted. Default is true.
    inlineHookId String
    ID of a Registration Inline Hook.
    name String
    The name of a User Profile property
    policyId String
    Policy ID.
    profileAttributes List<PolicyRuleProfileEnrollmentProfileAttribute>
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    progressiveProfilingAction String
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    status String
    Status of the Rule.
    targetGroupId String
    The ID of a Group that this User should be added to.
    uiSchemaId String
    Value created by the backend. If present all policy updates must include this attribute/value.
    unknownUserAction String
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    access string
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    emailVerification boolean
    Indicates whether email verification should occur before access is granted. Default is true.
    inlineHookId string
    ID of a Registration Inline Hook.
    name string
    The name of a User Profile property
    policyId string
    Policy ID.
    profileAttributes PolicyRuleProfileEnrollmentProfileAttribute[]
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    progressiveProfilingAction string
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    status string
    Status of the Rule.
    targetGroupId string
    The ID of a Group that this User should be added to.
    uiSchemaId string
    Value created by the backend. If present all policy updates must include this attribute/value.
    unknownUserAction string
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    access str
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    email_verification bool
    Indicates whether email verification should occur before access is granted. Default is true.
    inline_hook_id str
    ID of a Registration Inline Hook.
    name str
    The name of a User Profile property
    policy_id str
    Policy ID.
    profile_attributes Sequence[PolicyRuleProfileEnrollmentProfileAttributeArgs]
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    progressive_profiling_action str
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    status str
    Status of the Rule.
    target_group_id str
    The ID of a Group that this User should be added to.
    ui_schema_id str
    Value created by the backend. If present all policy updates must include this attribute/value.
    unknown_user_action str
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".
    access String
    Allow or deny access based on the rule conditions. Valid values are: "ALLOW", "DENY". Default is "ALLOW".
    emailVerification Boolean
    Indicates whether email verification should occur before access is granted. Default is true.
    inlineHookId String
    ID of a Registration Inline Hook.
    name String
    The name of a User Profile property
    policyId String
    Policy ID.
    profileAttributes List<Property Map>
    A list of attributes to prompt the user during registration or progressive profiling. Where defined on the User schema, these attributes are persisted in the User profile. Non-schema attributes may also be added, which aren't persisted to the User's profile, but are included in requests to the registration inline hook. A maximum of 10 Profile properties is supported.
    progressiveProfilingAction String
    Enabled or disabled progressive profiling action rule conditions. Valid values are: "ENABLED", "DISABLED". Default is "DISABLED".
    status String
    Status of the Rule.
    targetGroupId String
    The ID of a Group that this User should be added to.
    uiSchemaId String
    Value created by the backend. If present all policy updates must include this attribute/value.
    unknownUserAction String
    Which action should be taken if this User is new. Valid values are: "DENY", "REGISTER".

    Supporting Types

    PolicyRuleProfileEnrollmentProfileAttribute, PolicyRuleProfileEnrollmentProfileAttributeArgs

    Label string
    A display-friendly label for this property
    Name string
    The name of a User Profile property
    Required bool
    Indicates if this property is required for enrollment. Default is false.
    Label string
    A display-friendly label for this property
    Name string
    The name of a User Profile property
    Required bool
    Indicates if this property is required for enrollment. Default is false.
    label String
    A display-friendly label for this property
    name String
    The name of a User Profile property
    required Boolean
    Indicates if this property is required for enrollment. Default is false.
    label string
    A display-friendly label for this property
    name string
    The name of a User Profile property
    required boolean
    Indicates if this property is required for enrollment. Default is false.
    label str
    A display-friendly label for this property
    name str
    The name of a User Profile property
    required bool
    Indicates if this property is required for enrollment. Default is false.
    label String
    A display-friendly label for this property
    name String
    The name of a User Profile property
    required Boolean
    Indicates if this property is required for enrollment. Default is false.

    Import

    A Policy Rule can be imported via the Policy and Rule ID.

    $ pulumi import okta:index/policyRuleProfileEnrollment:PolicyRuleProfileEnrollment example &#60;policy id&#62;/&#60;rule id&#62;

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-okta