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

okta.AuthServerDefault

Explore with Pulumi AI

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

    Configures Default Authorization Server. This resource allows you to configure Default Authorization Server.

    Example Usage

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

const example = new okta.AuthServerDefault("example", {
    audiences: ["api://default"],
    description: "Default Authorization Server for your Applications",
});

    import pulumi
import pulumi_okta as okta

example = okta.AuthServerDefault("example",
    audiences=["api://default"],
    description="Default Authorization Server for your Applications")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewAuthServerDefault(ctx, "example", &okta.AuthServerDefaultArgs{
			Audiences: pulumi.StringArray{
				pulumi.String("api://default"),
			},
			Description: pulumi.String("Default Authorization Server for your Applications"),
		})
		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.AuthServerDefault("example", new()
    {
        Audiences = new[]
        {
            "api://default",
        },
        Description = "Default Authorization Server for your Applications",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.AuthServerDefault;
import com.pulumi.okta.AuthServerDefaultArgs;
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 AuthServerDefault("example", AuthServerDefaultArgs.builder()
            .audiences("api://default")
            .description("Default Authorization Server for your Applications")
            .build());

    }
}

    resources:
  example:
    type: okta:AuthServerDefault
    properties:
      audiences:
        - api://default
      description: Default Authorization Server for your Applications

    Create AuthServerDefault Resource

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

    Constructor syntax

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

@overload
def AuthServerDefault(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 NewAuthServerDefault(ctx *Context, name string, args *AuthServerDefaultArgs, opts ...ResourceOption) (*AuthServerDefault, error)
    public AuthServerDefault(string name, AuthServerDefaultArgs? args = null, CustomResourceOptions? opts = null)
    public AuthServerDefault(String name, AuthServerDefaultArgs args)
public AuthServerDefault(String name, AuthServerDefaultArgs args, CustomResourceOptions options)

    type: okta:AuthServerDefault
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 AuthServerDefaultArgs
    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 AuthServerDefaultArgs
    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 AuthServerDefaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthServerDefaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthServerDefaultArgs
    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 authServerDefaultResource = new Okta.AuthServerDefault("authServerDefaultResource", new()
{
    Audiences = new[]
    {
        "string",
    },
    CredentialsRotationMode = "string",
    Description = "string",
    IssuerMode = "string",
    Name = "string",
    Status = "string",
});

    example, err := okta.NewAuthServerDefault(ctx, "authServerDefaultResource", &okta.AuthServerDefaultArgs{
	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 authServerDefaultResource = new AuthServerDefault("authServerDefaultResource", AuthServerDefaultArgs.builder()
    .audiences("string")
    .credentialsRotationMode("string")
    .description("string")
    .issuerMode("string")
    .name("string")
    .status("string")
    .build());

    auth_server_default_resource = okta.AuthServerDefault("authServerDefaultResource",
    audiences=["string"],
    credentials_rotation_mode="string",
    description="string",
    issuer_mode="string",
    name="string",
    status="string")

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

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

    AuthServerDefault 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 AuthServerDefault 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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    status String
    Default to ACTIVE

    Outputs

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

    Get an existing AuthServerDefault 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?: AuthServerDefaultState, opts?: CustomResourceOptions): AuthServerDefault
    @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) -> AuthServerDefault
    func GetAuthServerDefault(ctx *Context, name string, id IDInput, state *AuthServerDefaultState, opts ...ResourceOption) (*AuthServerDefault, error)
    public static AuthServerDefault Get(string name, Input<string> id, AuthServerDefaultState? state, CustomResourceOptions? opts = null)
    public static AuthServerDefault get(String name, Output<String> id, AuthServerDefaultState 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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    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: MANUAL.Credential rotation mode, in many cases you cannot set this to MANUAL, the API will ignore the value and you will get a perpetual diff. This should rarely be used.
    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. Not necessary but left for backwards capacity with legacy implementation.
    status String
    Default to ACTIVE

    Import

    $ pulumi import okta:index/authServerDefault:AuthServerDefault example <default>

    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