Class Server

Creates an Authorization Server.

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

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
public MyStack()
{
    var example = new Okta.Auth.Server("example", new Okta.Auth.ServerArgs
    {
        Audiences = 
        {
            "api://example",
        },
        Description = "My Example Auth Server",
        IssuerMode = "CUSTOM_URL",
        Status = "ACTIVE",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Server

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 Server : CustomResource

Constructors

Server(String, ServerArgs, CustomResourceOptions)

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

Declaration

public Server(string name, ServerArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

Audiences

The recipients that the tokens are intended for. This becomes the aud claim in an access token.

Declaration

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

Property Value

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

CredentialsLastRotated

The timestamp when the authorization server started to use the kid for signing tokens.

Declaration

public Output<string> CredentialsLastRotated { get; }

Property Value

Type	Description
Output<System.String>

CredentialsNextRotation

The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is "AUTO".

Declaration

public Output<string> CredentialsNextRotation { get; }

Property Value

Type	Description
Output<System.String>

CredentialsRotationMode

The key rotation mode for the authorization server. Can be "AUTO" or "MANUAL".

Declaration

public Output<string> CredentialsRotationMode { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the authorization server.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Issuer

The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.

Declaration

public Output<string> Issuer { get; }

Property Value

Type	Description
Output<System.String>

IssuerMode

Allows you to use a custom issuer URL. It can be set to "CUSTOM_URL" or "ORG_URL"

Declaration

public Output<string> IssuerMode { get; }

Property Value

Type	Description
Output<System.String>

Kid

The ID of the JSON Web Key used for signing tokens issued by the authorization server.

Declaration

public Output<string> Kid { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the authorization server.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Status

The status of the auth server. It defaults to "ACTIVE"

Declaration

public Output<string> Status { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static Server Get(string name, Input<string> id, ServerState 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.
ServerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Server