1. Packages
  2. Packages
  3. Okta Provider
  4. API Docs
  5. getEntityRiskPolicy
Viewing docs for Okta v6.6.0
published on Wednesday, Apr 29, 2026 by Pulumi
okta logo
Viewing docs for Okta v6.6.0
published on Wednesday, Apr 29, 2026 by Pulumi

    Retrieves the Entity Risk Policy. This is a system policy that is automatically created when Identity Threat Protection (ITP) is enabled. There is exactly one Entity Risk Policy per organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.getEntityRiskPolicy({});
    // Use the policy ID to create rules
    const exampleEntityRiskPolicyRule = new okta.EntityRiskPolicyRule("example", {
        policyId: example.then(example => example.id),
        name: "High Risk Response",
        riskLevel: "HIGH",
        terminateAllSessions: true,
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.get_entity_risk_policy()
    # Use the policy ID to create rules
    example_entity_risk_policy_rule = okta.EntityRiskPolicyRule("example",
        policy_id=example.id,
        name="High Risk Response",
        risk_level="HIGH",
        terminate_all_sessions=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := okta.GetEntityRiskPolicy(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		// Use the policy ID to create rules
    		_, err = okta.NewEntityRiskPolicyRule(ctx, "example", &okta.EntityRiskPolicyRuleArgs{
    			PolicyId:             pulumi.String(pulumi.String(example.Id)),
    			Name:                 pulumi.String("High Risk Response"),
    			RiskLevel:            pulumi.String("HIGH"),
    			TerminateAllSessions: pulumi.Bool(true),
    		})
    		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 example = Okta.Index.GetEntityRiskPolicy.Invoke();
    
        // Use the policy ID to create rules
        var exampleEntityRiskPolicyRule = new Okta.Index.EntityRiskPolicyRule("example", new()
        {
            PolicyId = example.Apply(getEntityRiskPolicyResult => getEntityRiskPolicyResult.Id),
            Name = "High Risk Response",
            RiskLevel = "HIGH",
            TerminateAllSessions = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    import com.pulumi.okta.EntityRiskPolicyRule;
    import com.pulumi.okta.EntityRiskPolicyRuleArgs;
    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) {
            final var example = OktaFunctions.getEntityRiskPolicy(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
    
            // Use the policy ID to create rules
            var exampleEntityRiskPolicyRule = new EntityRiskPolicyRule("exampleEntityRiskPolicyRule", EntityRiskPolicyRuleArgs.builder()
                .policyId(example.id())
                .name("High Risk Response")
                .riskLevel("HIGH")
                .terminateAllSessions(true)
                .build());
    
        }
    }
    
    resources:
      # Use the policy ID to create rules
      exampleEntityRiskPolicyRule:
        type: okta:EntityRiskPolicyRule
        name: example
        properties:
          policyId: ${example.id}
          name: High Risk Response
          riskLevel: HIGH
          terminateAllSessions: true
    variables:
      example:
        fn::invoke:
          function: okta:getEntityRiskPolicy
          arguments: {}
    

    Using getEntityRiskPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEntityRiskPolicy(opts?: InvokeOptions): Promise<GetEntityRiskPolicyResult>
    function getEntityRiskPolicyOutput(opts?: InvokeOptions): Output<GetEntityRiskPolicyResult>
    def get_entity_risk_policy(opts: Optional[InvokeOptions] = None) -> GetEntityRiskPolicyResult
    def get_entity_risk_policy_output(opts: Optional[InvokeOptions] = None) -> Output[GetEntityRiskPolicyResult]
    func GetEntityRiskPolicy(ctx *Context, opts ...InvokeOption) (*GetEntityRiskPolicyResult, error)
    func GetEntityRiskPolicyOutput(ctx *Context, opts ...InvokeOption) GetEntityRiskPolicyResultOutput

    > Note: This function is named GetEntityRiskPolicy in the Go SDK.

    public static class GetEntityRiskPolicy 
    {
        public static Task<GetEntityRiskPolicyResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetEntityRiskPolicyResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEntityRiskPolicyResult> getEntityRiskPolicy(InvokeOptions options)
    public static Output<GetEntityRiskPolicyResult> getEntityRiskPolicy(InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getEntityRiskPolicy:getEntityRiskPolicy
      arguments:
        # arguments dictionary

    getEntityRiskPolicy Result

    The following output properties are available:

    Id string
    The ID of the Entity Risk Policy.
    Name string
    Name of the Entity Risk Policy.
    Status string
    Status of the policy: ACTIVE or INACTIVE.
    Id string
    The ID of the Entity Risk Policy.
    Name string
    Name of the Entity Risk Policy.
    Status string
    Status of the policy: ACTIVE or INACTIVE.
    id String
    The ID of the Entity Risk Policy.
    name String
    Name of the Entity Risk Policy.
    status String
    Status of the policy: ACTIVE or INACTIVE.
    id string
    The ID of the Entity Risk Policy.
    name string
    Name of the Entity Risk Policy.
    status string
    Status of the policy: ACTIVE or INACTIVE.
    id str
    The ID of the Entity Risk Policy.
    name str
    Name of the Entity Risk Policy.
    status str
    Status of the policy: ACTIVE or INACTIVE.
    id String
    The ID of the Entity Risk Policy.
    name String
    Name of the Entity Risk Policy.
    status String
    Status of the policy: ACTIVE or INACTIVE.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Viewing docs for Okta v6.6.0
    published on Wednesday, Apr 29, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.