Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. Realm
Okta v5.2.0 published on Thursday, Sep 4, 2025 by Pulumi
pulumi/pulumi-okta

okta.Realm

Explore with Pulumi AI

okta logo
Okta v5.2.0 published on Thursday, Sep 4, 2025 by Pulumi
pulumi/pulumi-okta

    Creates an Okta Realm. This resource allows you to create and configure an Okta Realm.

    Example Usage

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

const example = new okta.Realm("example", {
    name: "Example Realm",
    realmType: "DEFAULT",
});

    import pulumi
import pulumi_okta as okta

example = okta.Realm("example",
    name="Example Realm",
    realm_type="DEFAULT")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewRealm(ctx, "example", &okta.RealmArgs{
			Name:      pulumi.String("Example Realm"),
			RealmType: pulumi.String("DEFAULT"),
		})
		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.Realm("example", new()
    {
        Name = "Example Realm",
        RealmType = "DEFAULT",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Realm;
import com.pulumi.okta.RealmArgs;
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 Realm("example", RealmArgs.builder()
            .name("Example Realm")
            .realmType("DEFAULT")
            .build());

    }
}

    resources:
  example:
    type: okta:Realm
    properties:
      name: Example Realm
      realmType: DEFAULT

    Create Realm Resource

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

    Constructor syntax

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

@overload
def Realm(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          realm_type: Optional[str] = None,
          name: Optional[str] = None)
    func NewRealm(ctx *Context, name string, args RealmArgs, opts ...ResourceOption) (*Realm, error)
    public Realm(string name, RealmArgs args, CustomResourceOptions? opts = null)
    public Realm(String name, RealmArgs args)
public Realm(String name, RealmArgs args, CustomResourceOptions options)

    type: okta:Realm
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 RealmArgs
    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 RealmArgs
    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 RealmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RealmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RealmArgs
    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 realmResource = new Okta.Realm("realmResource", new()
{
    RealmType = "string",
    Name = "string",
});

    example, err := okta.NewRealm(ctx, "realmResource", &okta.RealmArgs{
	RealmType: pulumi.String("string"),
	Name:      pulumi.String("string"),
})

    var realmResource = new Realm("realmResource", RealmArgs.builder()
    .realmType("string")
    .name("string")
    .build());

    realm_resource = okta.Realm("realmResource",
    realm_type="string",
    name="string")

    const realmResource = new okta.Realm("realmResource", {
    realmType: "string",
    name: "string",
});

    type: okta:Realm
properties:
    name: string
    realmType: string

    Realm 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 Realm resource accepts the following input properties:

    RealmType string
    The realm type. Valid values: PARTNER and DEFAULT
    Name string
    The name of the Okta Realm.
    RealmType string
    The realm type. Valid values: PARTNER and DEFAULT
    Name string
    The name of the Okta Realm.
    realmType String
    The realm type. Valid values: PARTNER and DEFAULT
    name String
    The name of the Okta Realm.
    realmType string
    The realm type. Valid values: PARTNER and DEFAULT
    name string
    The name of the Okta Realm.
    realm_type str
    The realm type. Valid values: PARTNER and DEFAULT
    name str
    The name of the Okta Realm.
    realmType String
    The realm type. Valid values: PARTNER and DEFAULT
    name String
    The name of the Okta Realm.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Indicates whether the realm is the default realm.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Indicates whether the realm is the default realm.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Indicates whether the realm is the default realm.
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Indicates whether the realm is the default realm.
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Indicates whether the realm is the default realm.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Indicates whether the realm is the default realm.

    Look up Existing Realm Resource

    Get an existing Realm 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?: RealmState, opts?: CustomResourceOptions): Realm
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        is_default: Optional[bool] = None,
        name: Optional[str] = None,
        realm_type: Optional[str] = None) -> Realm
    func GetRealm(ctx *Context, name string, id IDInput, state *RealmState, opts ...ResourceOption) (*Realm, error)
    public static Realm Get(string name, Input<string> id, RealmState? state, CustomResourceOptions? opts = null)
    public static Realm get(String name, Output<String> id, RealmState state, CustomResourceOptions options)
    resources:  _:    type: okta:Realm    get:      id: ${id}
    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:
    IsDefault bool
    Indicates whether the realm is the default realm.
    Name string
    The name of the Okta Realm.
    RealmType string
    The realm type. Valid values: PARTNER and DEFAULT
    IsDefault bool
    Indicates whether the realm is the default realm.
    Name string
    The name of the Okta Realm.
    RealmType string
    The realm type. Valid values: PARTNER and DEFAULT
    isDefault Boolean
    Indicates whether the realm is the default realm.
    name String
    The name of the Okta Realm.
    realmType String
    The realm type. Valid values: PARTNER and DEFAULT
    isDefault boolean
    Indicates whether the realm is the default realm.
    name string
    The name of the Okta Realm.
    realmType string
    The realm type. Valid values: PARTNER and DEFAULT
    is_default bool
    Indicates whether the realm is the default realm.
    name str
    The name of the Okta Realm.
    realm_type str
    The realm type. Valid values: PARTNER and DEFAULT
    isDefault Boolean
    Indicates whether the realm is the default realm.
    name String
    The name of the Okta Realm.
    realmType String
    The realm type. Valid values: PARTNER and DEFAULT

    Import

    $ pulumi import okta:index/realm:Realm example <realm_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 v5.2.0 published on Thursday, Sep 4, 2025 by Pulumi
    pulumi/pulumi-okta