Docs Home
Okta v5.1.0 published on Wednesday, Aug 13, 2025 by Pulumi
okta.Realm
Explore with Pulumi AI
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)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:
- realm_
type str - The realm type. Valid values:
PARTNERandDEFAULT - name str
- 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 str
- The provider-assigned unique ID for this managed resource.
- is_
default bool - 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) -> Realmfunc 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.
- 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:
PARTNERandDEFAULT
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oktaTerraform Provider.