Class ServerClaim

Creates an Authorization Server Claim.

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

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
public MyStack()
{
    var example = new Okta.Auth.ServerClaim("example", new Okta.Auth.ServerClaimArgs
    {
        AuthServerId = "<auth server id>",
        ClaimType = "IDENTITY",
        Scopes = 
        {
            okta_auth_server_scope.Example.Name,
        },
        Value = "String.substringAfter(user.email, \"@\") == \"example.com\"",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ServerClaim

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Okta.Auth

Assembly: Pulumi.Okta.dll

Syntax

public class ServerClaim : CustomResource

Constructors

ServerClaim(String, ServerClaimArgs, CustomResourceOptions)

Create a ServerClaim resource with the given unique name, arguments, and options.

Declaration

public ServerClaim(string name, ServerClaimArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ServerClaimArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AlwaysIncludeInToken

Specifies whether to include claims in token, by default is is set to true.

Declaration

public Output<bool?> AlwaysIncludeInToken { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

AuthServerId

The Application's display name.

Declaration

public Output<string> AuthServerId { get; }

Property Value

Type	Description
Output<System.String>

ClaimType

Specifies whether the claim is for an access token "RESOURCE" or ID token "IDENTITY".

Declaration

public Output<string> ClaimType { get; }

Property Value

Type	Description
Output<System.String>

GroupFilterType

Specifies the type of group filter if value_type is "GROUPS". Can be set to one of the following "STARTS_WITH", "EQUALS", "CONTAINS", "REGEX".

Declaration

public Output<string> GroupFilterType { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the claim.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Scopes

The list of scopes the auth server claim is tied to.

Declaration

public Output<ImmutableArray<string>> Scopes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Status

The status of the application. It defaults to "ACTIVE".

Declaration

public Output<string> Status { get; }

Property Value

Type	Description
Output<System.String>

Value

The value of the claim.

Declaration

public Output<string> Value { get; }

Property Value

Type	Description
Output<System.String>

ValueType

The type of value of the claim. It can be set to "EXPRESSION" or "GROUPS". It defaults to "EXPRESSION".

Declaration

public Output<string> ValueType { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ServerClaimState, CustomResourceOptions)

Get an existing ServerClaim resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ServerClaim Get(string name, Input<string> id, ServerClaimState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ServerClaimState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ServerClaim