RuleIdpDiscovery
Creates an IdP Discovery Policy Rule.
This resource allows you to create and configure an IdP Discovery Policy Rule.
Example Usage
using Pulumi;
using Okta = Pulumi.Okta;
class MyStack : Stack
{
public MyStack()
{
var example = new Okta.Policy.RuleIdpDiscovery("example", new Okta.Policy.RuleIdpDiscoveryArgs
{
IdpId = "<idp id>",
IdpType = "SAML2",
Policyid = "<policy id>",
Priority = 1,
UserIdentifierAttribute = "company",
UserIdentifierPatterns =
{
new Okta.Policy.Inputs.RuleIdpDiscoveryUserIdentifierPatternArgs
{
MatchType = "EQUALS",
Value = "Articulate",
},
},
UserIdentifierType = "ATTRIBUTE",
});
}
}
Coming soon!
import pulumi
import pulumi_okta as okta
example = okta.policy.RuleIdpDiscovery("example",
idp_id="<idp id>",
idp_type="SAML2",
policyid="<policy id>",
priority=1,
user_identifier_attribute="company",
user_identifier_patterns=[{
"match_type": "EQUALS",
"value": "Articulate",
}],
user_identifier_type="ATTRIBUTE")import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = new okta.policy.RuleIdpDiscovery("example", {
idpId: "<idp id>",
idpType: "SAML2",
policyid: "<policy id>",
priority: 1,
userIdentifierAttribute: "company",
userIdentifierPatterns: [{
matchType: "EQUALS",
value: "Articulate",
}],
userIdentifierType: "ATTRIBUTE",
});Create a RuleIdpDiscovery Resource
new RuleIdpDiscovery(name: string, args: RuleIdpDiscoveryArgs, opts?: CustomResourceOptions);def RuleIdpDiscovery(resource_name, opts=None, app_excludes=None, app_includes=None, idp_id=None, idp_type=None, name=None, network_connection=None, network_excludes=None, network_includes=None, platform_includes=None, policyid=None, priority=None, status=None, user_identifier_attribute=None, user_identifier_patterns=None, user_identifier_type=None, __props__=None);func NewRuleIdpDiscovery(ctx *Context, name string, args RuleIdpDiscoveryArgs, opts ...ResourceOption) (*RuleIdpDiscovery, error)public RuleIdpDiscovery(string name, RuleIdpDiscoveryArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args RuleIdpDiscoveryArgs
- 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 RuleIdpDiscoveryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RuleIdpDiscoveryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
RuleIdpDiscovery Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The RuleIdpDiscovery resource accepts the following input properties:
- Policyid string
Policy ID.
- App
Excludes List<RuleIdp Discovery App Exclude Args> Applications to exclude in discovery rule
- App
Includes List<RuleIdp Discovery App Include Args> Applications to include in discovery rule
- Idp
Id string - Idp
Type string - 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.- Platform
Includes List<RuleIdp Discovery Platform Include Args> - 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.
- Status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- User
Identifier stringAttribute - User
Identifier List<RulePatterns Idp Discovery User Identifier Pattern Args> - User
Identifier stringType
- Policyid string
Policy ID.
- App
Excludes []RuleIdp Discovery App Exclude Applications to exclude in discovery rule
- App
Includes []RuleIdp Discovery App Include Applications to include in discovery rule
- Idp
Id string - Idp
Type string - 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.- Platform
Includes []RuleIdp Discovery Platform Include - 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.
- Status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- User
Identifier stringAttribute - User
Identifier []RulePatterns Idp Discovery User Identifier Pattern - User
Identifier stringType
- policyid string
Policy ID.
- app
Excludes RuleIdp Discovery App Exclude[] Applications to exclude in discovery rule
- app
Includes RuleIdp Discovery App Include[] Applications to include in discovery rule
- idp
Id string - idp
Type string - 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.- platform
Includes RuleIdp Discovery Platform Include[] - 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.
- status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- user
Identifier stringAttribute - user
Identifier RulePatterns Idp Discovery User Identifier Pattern[] - user
Identifier stringType
- policyid str
Policy ID.
- app_
excludes List[RuleIdp Discovery App Exclude] Applications to exclude in discovery rule
- app_
includes List[RuleIdp Discovery App Include] Applications to include in discovery rule
- idp_
id str - idp_
type str - 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.- platform_
includes List[RuleIdp Discovery Platform Include] - 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.
- status str
Policy Rule Status:
"ACTIVE"or"INACTIVE".- user_
identifier_ strattribute - user_
identifier_ List[Rulepatterns Idp Discovery User Identifier Pattern] - user_
identifier_ strtype
Outputs
All input properties are implicitly available as output properties. Additionally, the RuleIdpDiscovery resource produces the following output properties:
Look up an Existing RuleIdpDiscovery Resource
Get an existing RuleIdpDiscovery 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?: RuleIdpDiscoveryState, opts?: CustomResourceOptions): RuleIdpDiscoverystatic get(resource_name, id, opts=None, app_excludes=None, app_includes=None, idp_id=None, idp_type=None, name=None, network_connection=None, network_excludes=None, network_includes=None, platform_includes=None, policyid=None, priority=None, status=None, user_identifier_attribute=None, user_identifier_patterns=None, user_identifier_type=None, __props__=None);func GetRuleIdpDiscovery(ctx *Context, name string, id IDInput, state *RuleIdpDiscoveryState, opts ...ResourceOption) (*RuleIdpDiscovery, error)public static RuleIdpDiscovery Get(string name, Input<string> id, RuleIdpDiscoveryState? 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:
- App
Excludes List<RuleIdp Discovery App Exclude Args> Applications to exclude in discovery rule
- App
Includes List<RuleIdp Discovery App Include Args> Applications to include in discovery rule
- Idp
Id string - Idp
Type string - 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.- Platform
Includes List<RuleIdp Discovery Platform Include Args> - 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.
- Status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- User
Identifier stringAttribute - User
Identifier List<RulePatterns Idp Discovery User Identifier Pattern Args> - User
Identifier stringType
- App
Excludes []RuleIdp Discovery App Exclude Applications to exclude in discovery rule
- App
Includes []RuleIdp Discovery App Include Applications to include in discovery rule
- Idp
Id string - Idp
Type string - 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.- Platform
Includes []RuleIdp Discovery Platform Include - 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.
- Status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- User
Identifier stringAttribute - User
Identifier []RulePatterns Idp Discovery User Identifier Pattern - User
Identifier stringType
- app
Excludes RuleIdp Discovery App Exclude[] Applications to exclude in discovery rule
- app
Includes RuleIdp Discovery App Include[] Applications to include in discovery rule
- idp
Id string - idp
Type string - 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.- platform
Includes RuleIdp Discovery Platform Include[] - 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.
- status string
Policy Rule Status:
"ACTIVE"or"INACTIVE".- user
Identifier stringAttribute - user
Identifier RulePatterns Idp Discovery User Identifier Pattern[] - user
Identifier stringType
- app_
excludes List[RuleIdp Discovery App Exclude] Applications to exclude in discovery rule
- app_
includes List[RuleIdp Discovery App Include] Applications to include in discovery rule
- idp_
id str - idp_
type str - 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.- platform_
includes List[RuleIdp Discovery Platform Include] - 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.
- status str
Policy Rule Status:
"ACTIVE"or"INACTIVE".- user_
identifier_ strattribute - user_
identifier_ List[Rulepatterns Idp Discovery User Identifier Pattern] - user_
identifier_ strtype
Supporting Types
RuleIdpDiscoveryAppExclude
RuleIdpDiscoveryAppInclude
RuleIdpDiscoveryPlatformInclude
RuleIdpDiscoveryUserIdentifierPattern
Package Details
- Repository
- https://github.com/pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oktaTerraform Provider.