ServerPolicyClaim

Creates an Authorization Server Policy Rule.

This resource allows you to create and configure an Authorization Server Policy Rule.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.Auth.ServerPolicyClaim("example", new Okta.Auth.ServerPolicyClaimArgs
        {
            AuthServerId = "<auth server id>",
            GrantTypeWhitelists = 
            {
                "implicit",
            },
            GroupWhitelists = 
            {
                "<group ids>",
            },
            PolicyId = "<auth server policy id>",
            Priority = 1,
            Status = "ACTIVE",
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.auth.ServerPolicyClaim("example",
    auth_server_id="<auth server id>",
    grant_type_whitelists=["implicit"],
    group_whitelists=["<group ids>"],
    policy_id="<auth server policy id>",
    priority=1,
    status="ACTIVE")

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

const example = new okta.auth.ServerPolicyClaim("example", {
    authServerId: "<auth server id>",
    grantTypeWhitelists: ["implicit"],
    groupWhitelists: ["<group ids>"],
    policyId: "<auth server policy id>",
    priority: 1,
    status: "ACTIVE",
});

Create a ServerPolicyClaim Resource

new ServerPolicyClaim(name: string, args: ServerPolicyClaimArgs, opts?: CustomResourceOptions);

def ServerPolicyClaim(resource_name, opts=None, access_token_lifetime_minutes=None, auth_server_id=None, grant_type_whitelists=None, group_blacklists=None, group_whitelists=None, inline_hook_id=None, name=None, policy_id=None, priority=None, refresh_token_lifetime_minutes=None, refresh_token_window_minutes=None, scope_whitelists=None, status=None, type=None, user_blacklists=None, user_whitelists=None, __props__=None);

func NewServerPolicyClaim(ctx *Context, name string, args ServerPolicyClaimArgs, opts ...ResourceOption) (*ServerPolicyClaim, error)

public ServerPolicyClaim(string name, ServerPolicyClaimArgs args, CustomResourceOptions? opts = null)

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

name string: The unique name of the resource.
args ServerPolicyClaimArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ServerPolicyClaim Resource Properties

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

Inputs

The ServerPolicyClaim resource accepts the following input properties:

AuthServerId string: Auth Server ID.
GrantTypeWhitelists List<string>: Accepted grant type values, "authorization_code", "implicit", "password"
PolicyId string: Auth Server Policy ID.
Priority int: Priority of the auth server policy rule.
AccessTokenLifetimeMinutes int: Lifetime of access token. Can be set to a value between 5 and 1440.
GroupBlacklists List<string>
GroupWhitelists List<string>
InlineHookId string: The ID of the inline token to trigger.
Name string: Auth Server Policy Rule name.
RefreshTokenLifetimeMinutes int: Lifetime of refresh token.
RefreshTokenWindowMinutes int
ScopeWhitelists List<string>: Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with "*".
Status string: The status of the Auth Server Policy Rule.
Type string: The type of the Auth Server Policy Rule.
UserBlacklists List<string>
UserWhitelists List<string>

AuthServerId string: Auth Server ID.
GrantTypeWhitelists []string: Accepted grant type values, "authorization_code", "implicit", "password"
PolicyId string: Auth Server Policy ID.
Priority int: Priority of the auth server policy rule.
AccessTokenLifetimeMinutes int: Lifetime of access token. Can be set to a value between 5 and 1440.
GroupBlacklists []string
GroupWhitelists []string
InlineHookId string: The ID of the inline token to trigger.
Name string: Auth Server Policy Rule name.
RefreshTokenLifetimeMinutes int: Lifetime of refresh token.
RefreshTokenWindowMinutes int
ScopeWhitelists []string: Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with "*".
Status string: The status of the Auth Server Policy Rule.
Type string: The type of the Auth Server Policy Rule.
UserBlacklists []string
UserWhitelists []string

authServerId string: Auth Server ID.
grantTypeWhitelists string[]: Accepted grant type values, "authorization_code", "implicit", "password"
policyId string: Auth Server Policy ID.
priority number: Priority of the auth server policy rule.
accessTokenLifetimeMinutes number: Lifetime of access token. Can be set to a value between 5 and 1440.
groupBlacklists string[]
groupWhitelists string[]
inlineHookId string: The ID of the inline token to trigger.
name string: Auth Server Policy Rule name.
refreshTokenLifetimeMinutes number: Lifetime of refresh token.
refreshTokenWindowMinutes number
scopeWhitelists string[]: Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with "*".
status string: The status of the Auth Server Policy Rule.
type string: The type of the Auth Server Policy Rule.
userBlacklists string[]
userWhitelists string[]

auth_server_id str: Auth Server ID.
grant_type_whitelists List[str]: Accepted grant type values, "authorization_code", "implicit", "password"
policy_id str: Auth Server Policy ID.
priority float: Priority of the auth server policy rule.
access_token_lifetime_minutes float: Lifetime of access token. Can be set to a value between 5 and 1440.
group_blacklists List[str]
group_whitelists List[str]
inline_hook_id str: The ID of the inline token to trigger.
name str: Auth Server Policy Rule name.
refresh_token_lifetime_minutes float: Lifetime of refresh token.
refresh_token_window_minutes float
scope_whitelists List[str]: Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with "*".
status str: The status of the Auth Server Policy Rule.
type str: The type of the Auth Server Policy Rule.
user_blacklists List[str]
user_whitelists List[str]

Outputs

All input properties are implicitly available as output properties. Additionally, the ServerPolicyClaim 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 ServerPolicyClaim Resource

Get an existing ServerPolicyClaim 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?: ServerPolicyClaimState, opts?: CustomResourceOptions): ServerPolicyClaim

static get(resource_name, id, opts=None, access_token_lifetime_minutes=None, auth_server_id=None, grant_type_whitelists=None, group_blacklists=None, group_whitelists=None, inline_hook_id=None, name=None, policy_id=None, priority=None, refresh_token_lifetime_minutes=None, refresh_token_window_minutes=None, scope_whitelists=None, status=None, type=None, user_blacklists=None, user_whitelists=None, __props__=None);

func GetServerPolicyClaim(ctx *Context, name string, id IDInput, state *ServerPolicyClaimState, opts ...ResourceOption) (*ServerPolicyClaim, error)

public static ServerPolicyClaim Get(string name, Input<string> id, ServerPolicyClaimState? 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:

AccessTokenLifetimeMinutes int: Lifetime of access token. Can be set to a value between 5 and 1440.
AuthServerId string: Auth Server ID.
GrantTypeWhitelists List<string>: Accepted grant type values, "authorization_code", "implicit", "password"
GroupBlacklists List<string>
GroupWhitelists List<string>
InlineHookId string: The ID of the inline token to trigger.
Name string: Auth Server Policy Rule name.
PolicyId string: Auth Server Policy ID.
Priority int: Priority of the auth server policy rule.
RefreshTokenLifetimeMinutes int: Lifetime of refresh token.
RefreshTokenWindowMinutes int
ScopeWhitelists List<string>: Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with "*".
Status string: The status of the Auth Server Policy Rule.
Type string: The type of the Auth Server Policy Rule.
UserBlacklists List<string>
UserWhitelists List<string>

AccessTokenLifetimeMinutes int: Lifetime of access token. Can be set to a value between 5 and 1440.
AuthServerId string: Auth Server ID.
GrantTypeWhitelists []string: Accepted grant type values, "authorization_code", "implicit", "password"
GroupBlacklists []string
GroupWhitelists []string
InlineHookId string: The ID of the inline token to trigger.
Name string: Auth Server Policy Rule name.
PolicyId string: Auth Server Policy ID.
Priority int: Priority of the auth server policy rule.
RefreshTokenLifetimeMinutes int: Lifetime of refresh token.
RefreshTokenWindowMinutes int
ScopeWhitelists []string: Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with "*".
Status string: The status of the Auth Server Policy Rule.
Type string: The type of the Auth Server Policy Rule.
UserBlacklists []string
UserWhitelists []string

accessTokenLifetimeMinutes number: Lifetime of access token. Can be set to a value between 5 and 1440.
authServerId string: Auth Server ID.
grantTypeWhitelists string[]: Accepted grant type values, "authorization_code", "implicit", "password"
groupBlacklists string[]
groupWhitelists string[]
inlineHookId string: The ID of the inline token to trigger.
name string: Auth Server Policy Rule name.
policyId string: Auth Server Policy ID.
priority number: Priority of the auth server policy rule.
refreshTokenLifetimeMinutes number: Lifetime of refresh token.
refreshTokenWindowMinutes number
scopeWhitelists string[]: Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with "*".
status string: The status of the Auth Server Policy Rule.
type string: The type of the Auth Server Policy Rule.
userBlacklists string[]
userWhitelists string[]

access_token_lifetime_minutes float: Lifetime of access token. Can be set to a value between 5 and 1440.
auth_server_id str: Auth Server ID.
grant_type_whitelists List[str]: Accepted grant type values, "authorization_code", "implicit", "password"
group_blacklists List[str]
group_whitelists List[str]
inline_hook_id str: The ID of the inline token to trigger.
name str: Auth Server Policy Rule name.
policy_id str: Auth Server Policy ID.
priority float: Priority of the auth server policy rule.
refresh_token_lifetime_minutes float: Lifetime of refresh token.
refresh_token_window_minutes float
scope_whitelists List[str]: Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with "*".
status str: The status of the Auth Server Policy Rule.
type str: The type of the Auth Server Policy Rule.
user_blacklists List[str]
user_whitelists List[str]

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud