Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. auth
  5. Server
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.auth.Server

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

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

    Example Usage

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

const example = new okta.auth.Server("example", {
    audiences: ["api://example"],
    description: "My Example Auth Server",
    name: "example",
    issuerMode: "CUSTOM_URL",
    status: "ACTIVE",
});

    import pulumi
import pulumi_okta as okta

example = okta.auth.Server("example",
    audiences=["api://example"],
    description="My Example Auth Server",
    name="example",
    issuer_mode="CUSTOM_URL",
    status="ACTIVE")

    package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth.NewServer(ctx, "example", &auth.ServerArgs{
			Audiences: pulumi.StringArray{
				pulumi.String("api://example"),
			},
			Description: pulumi.String("My Example Auth Server"),
			Name:        pulumi.String("example"),
			IssuerMode:  pulumi.String("CUSTOM_URL"),
			Status:      pulumi.String("ACTIVE"),
		})
		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 = new Okta.Auth.Server("example", new()
    {
        Audiences = new[]
        {
            "api://example",
        },
        Description = "My Example Auth Server",
        Name = "example",
        IssuerMode = "CUSTOM_URL",
        Status = "ACTIVE",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.auth.Server;
import com.pulumi.okta.auth.ServerArgs;
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) {
        var example = new Server("example", ServerArgs.builder()
            .audiences("api://example")
            .description("My Example Auth Server")
            .name("example")
            .issuerMode("CUSTOM_URL")
            .status("ACTIVE")
            .build());

    }
}

    resources:
  example:
    type: okta:auth:Server
    properties:
      audiences:
        - api://example
      description: My Example Auth Server
      name: example
      issuerMode: CUSTOM_URL
      status: ACTIVE

    Create Server Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Server(name: string, args: ServerArgs, opts?: CustomResourceOptions);
    @overload
def Server(resource_name: str,
           args: ServerArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Server(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           audiences: Optional[Sequence[str]] = None,
           credentials_rotation_mode: Optional[str] = None,
           description: Optional[str] = None,
           issuer_mode: Optional[str] = None,
           name: Optional[str] = None,
           status: Optional[str] = None)
    func NewServer(ctx *Context, name string, args ServerArgs, opts ...ResourceOption) (*Server, error)
    public Server(string name, ServerArgs args, CustomResourceOptions? opts = null)
    public Server(String name, ServerArgs args)
public Server(String name, ServerArgs args, CustomResourceOptions options)

    type: okta:auth:Server
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var serverResource = new Okta.Auth.Server("serverResource", new()
{
    Audiences = new[]
    {
        "string",
    },
    CredentialsRotationMode = "string",
    Description = "string",
    IssuerMode = "string",
    Name = "string",
    Status = "string",
});

    example, err := auth.NewServer(ctx, "serverResource", &auth.ServerArgs{
	Audiences: pulumi.StringArray{
		pulumi.String("string"),
	},
	CredentialsRotationMode: pulumi.String("string"),
	Description:             pulumi.String("string"),
	IssuerMode:              pulumi.String("string"),
	Name:                    pulumi.String("string"),
	Status:                  pulumi.String("string"),
})

    var serverResource = new Server("serverResource", ServerArgs.builder()
    .audiences("string")
    .credentialsRotationMode("string")
    .description("string")
    .issuerMode("string")
    .name("string")
    .status("string")
    .build());

    server_resource = okta.auth.Server("serverResource",
    audiences=["string"],
    credentials_rotation_mode="string",
    description="string",
    issuer_mode="string",
    name="string",
    status="string")

    const serverResource = new okta.auth.Server("serverResource", {
    audiences: ["string"],
    credentialsRotationMode: "string",
    description: "string",
    issuerMode: "string",
    name: "string",
    status: "string",
});

    type: okta:auth:Server
properties:
    audiences:
        - string
    credentialsRotationMode: string
    description: string
    issuerMode: string
    name: string
    status: string

    Server Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Server resource accepts the following input properties:

    Audiences List<string>
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    CredentialsRotationMode string
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    Description string
    The description of the authorization server.
    IssuerMode string
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    Name string
    The name of the authorization server.
    Status string
    Default to ACTIVE
    Audiences []string
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    CredentialsRotationMode string
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    Description string
    The description of the authorization server.
    IssuerMode string
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    Name string
    The name of the authorization server.
    Status string
    Default to ACTIVE
    audiences List<String>
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    credentialsRotationMode String
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    description String
    The description of the authorization server.
    issuerMode String
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    name String
    The name of the authorization server.
    status String
    Default to ACTIVE
    audiences string[]
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    credentialsRotationMode string
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    description string
    The description of the authorization server.
    issuerMode string
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    name string
    The name of the authorization server.
    status string
    Default to ACTIVE
    audiences Sequence[str]
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    credentials_rotation_mode str
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    description str
    The description of the authorization server.
    issuer_mode str
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    name str
    The name of the authorization server.
    status str
    Default to ACTIVE
    audiences List<String>
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    credentialsRotationMode String
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    description String
    The description of the authorization server.
    issuerMode String
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    name String
    The name of the authorization server.
    status String
    Default to ACTIVE

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Server resource produces the following output properties:

    CredentialsLastRotated string
    The timestamp when the authorization server started to use the kid for signing tokens.
    CredentialsNextRotation string
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    Id string
    The provider-assigned unique ID for this managed resource.
    Issuer string
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    Kid string
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    CredentialsLastRotated string
    The timestamp when the authorization server started to use the kid for signing tokens.
    CredentialsNextRotation string
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    Id string
    The provider-assigned unique ID for this managed resource.
    Issuer string
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    Kid string
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    credentialsLastRotated String
    The timestamp when the authorization server started to use the kid for signing tokens.
    credentialsNextRotation String
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    id String
    The provider-assigned unique ID for this managed resource.
    issuer String
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    kid String
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    credentialsLastRotated string
    The timestamp when the authorization server started to use the kid for signing tokens.
    credentialsNextRotation string
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    id string
    The provider-assigned unique ID for this managed resource.
    issuer string
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    kid string
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    credentials_last_rotated str
    The timestamp when the authorization server started to use the kid for signing tokens.
    credentials_next_rotation str
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    id str
    The provider-assigned unique ID for this managed resource.
    issuer str
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    kid str
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    credentialsLastRotated String
    The timestamp when the authorization server started to use the kid for signing tokens.
    credentialsNextRotation String
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    id String
    The provider-assigned unique ID for this managed resource.
    issuer String
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    kid String
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.

    Look up Existing Server Resource

    Get an existing Server 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?: ServerState, opts?: CustomResourceOptions): Server
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audiences: Optional[Sequence[str]] = None,
        credentials_last_rotated: Optional[str] = None,
        credentials_next_rotation: Optional[str] = None,
        credentials_rotation_mode: Optional[str] = None,
        description: Optional[str] = None,
        issuer: Optional[str] = None,
        issuer_mode: Optional[str] = None,
        kid: Optional[str] = None,
        name: Optional[str] = None,
        status: Optional[str] = None) -> Server
    func GetServer(ctx *Context, name string, id IDInput, state *ServerState, opts ...ResourceOption) (*Server, error)
    public static Server Get(string name, Input<string> id, ServerState? state, CustomResourceOptions? opts = null)
    public static Server get(String name, Output<String> id, ServerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    Audiences List<string>
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    CredentialsLastRotated string
    The timestamp when the authorization server started to use the kid for signing tokens.
    CredentialsNextRotation string
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    CredentialsRotationMode string
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    Description string
    The description of the authorization server.
    Issuer string
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    IssuerMode string
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    Kid string
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    Name string
    The name of the authorization server.
    Status string
    Default to ACTIVE
    Audiences []string
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    CredentialsLastRotated string
    The timestamp when the authorization server started to use the kid for signing tokens.
    CredentialsNextRotation string
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    CredentialsRotationMode string
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    Description string
    The description of the authorization server.
    Issuer string
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    IssuerMode string
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    Kid string
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    Name string
    The name of the authorization server.
    Status string
    Default to ACTIVE
    audiences List<String>
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    credentialsLastRotated String
    The timestamp when the authorization server started to use the kid for signing tokens.
    credentialsNextRotation String
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    credentialsRotationMode String
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    description String
    The description of the authorization server.
    issuer String
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    issuerMode String
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    kid String
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    name String
    The name of the authorization server.
    status String
    Default to ACTIVE
    audiences string[]
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    credentialsLastRotated string
    The timestamp when the authorization server started to use the kid for signing tokens.
    credentialsNextRotation string
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    credentialsRotationMode string
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    description string
    The description of the authorization server.
    issuer string
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    issuerMode string
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    kid string
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    name string
    The name of the authorization server.
    status string
    Default to ACTIVE
    audiences Sequence[str]
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    credentials_last_rotated str
    The timestamp when the authorization server started to use the kid for signing tokens.
    credentials_next_rotation str
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    credentials_rotation_mode str
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    description str
    The description of the authorization server.
    issuer str
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    issuer_mode str
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    kid str
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    name str
    The name of the authorization server.
    status str
    Default to ACTIVE
    audiences List<String>
    The recipients that the tokens are intended for. This becomes the aud claim in an access token. Currently Okta only supports a single value here.
    credentialsLastRotated String
    The timestamp when the authorization server started to use the kid for signing tokens.
    credentialsNextRotation String
    The timestamp when the authorization server changes the key for signing tokens. Only returned when credentials_rotation_mode is AUTO.
    credentialsRotationMode String
    The key rotation mode for the authorization server. Can be AUTO or MANUAL. Default: AUTO
    description String
    The description of the authorization server.
    issuer String
    The complete URL for a Custom Authorization Server. This becomes the iss claim in an access token.
    issuerMode String
    Early Access Property. Allows you to use a custom issuer URL. It can be set to CUSTOM_URL, ORG_URL, or DYNAMIC. Default: ORG_URL
    kid String
    The ID of the JSON Web Key used for signing tokens issued by the authorization server.
    name String
    The name of the authorization server.
    status String
    Default to ACTIVE

    Import

    $ pulumi import okta:auth/server:Server example <auth_server_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta