1. Packages
  2. Okta Provider
  3. API Docs
  4. Entitlement
Okta v6.0.0 published on Friday, Oct 10, 2025 by Pulumi
pulumi/pulumi-okta

okta.Entitlement

Deploy with Pulumi
okta logo
Okta v6.0.0 published on Friday, Oct 10, 2025 by Pulumi
pulumi/pulumi-okta

    Manages Entitlement. This resource allows you to create and configure an Okta Entitlement.

    Example Usage

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

const example = new okta.Entitlement("example", {name: "example"});

    import pulumi
import pulumi_okta as okta

example = okta.Entitlement("example", name="example")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewEntitlement(ctx, "example", &okta.EntitlementArgs{
			Name: pulumi.String("example"),
		})
		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.Entitlement("example", new()
    {
        Name = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Entitlement;
import com.pulumi.okta.EntitlementArgs;
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 Entitlement("example", EntitlementArgs.builder()
            .name("example")
            .build());

    }
}

    resources:
  example:
    type: okta:Entitlement
    properties:
      name: example

    Create Entitlement Resource

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

    Constructor syntax

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

@overload
def Entitlement(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                data_type: Optional[str] = None,
                external_value: Optional[str] = None,
                multi_value: Optional[bool] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                parent: Optional[EntitlementParentArgs] = None,
                parent_resource_orn: Optional[str] = None,
                value: Optional[str] = None,
                values: Optional[Sequence[EntitlementValueArgs]] = None)
    func NewEntitlement(ctx *Context, name string, args EntitlementArgs, opts ...ResourceOption) (*Entitlement, error)
    public Entitlement(string name, EntitlementArgs args, CustomResourceOptions? opts = null)
    public Entitlement(String name, EntitlementArgs args)
public Entitlement(String name, EntitlementArgs args, CustomResourceOptions options)

    type: okta:Entitlement
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 EntitlementArgs
    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 EntitlementArgs
    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 EntitlementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntitlementArgs
    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 entitlementResource = new Okta.Entitlement("entitlementResource", new()
{
    DataType = "string",
    ExternalValue = "string",
    MultiValue = false,
    Description = "string",
    Name = "string",
    Parent = new Okta.Inputs.EntitlementParentArgs
    {
        ExternalId = "string",
        Type = "string",
    },
    ParentResourceOrn = "string",
    Value = "string",
    Values = new[]
    {
        new Okta.Inputs.EntitlementValueArgs
        {
            Description = "string",
            ExternalValue = "string",
            Id = "string",
            Name = "string",
        },
    },
});

    example, err := okta.NewEntitlement(ctx, "entitlementResource", &okta.EntitlementArgs{
	DataType:      pulumi.String("string"),
	ExternalValue: pulumi.String("string"),
	MultiValue:    pulumi.Bool(false),
	Description:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	Parent: &okta.EntitlementParentArgs{
		ExternalId: pulumi.String("string"),
		Type:       pulumi.String("string"),
	},
	ParentResourceOrn: pulumi.String("string"),
	Value:             pulumi.String("string"),
	Values: okta.EntitlementValueArray{
		&okta.EntitlementValueArgs{
			Description:   pulumi.String("string"),
			ExternalValue: pulumi.String("string"),
			Id:            pulumi.String("string"),
			Name:          pulumi.String("string"),
		},
	},
})

    var entitlementResource = new Entitlement("entitlementResource", EntitlementArgs.builder()
    .dataType("string")
    .externalValue("string")
    .multiValue(false)
    .description("string")
    .name("string")
    .parent(EntitlementParentArgs.builder()
        .externalId("string")
        .type("string")
        .build())
    .parentResourceOrn("string")
    .value("string")
    .values(EntitlementValueArgs.builder()
        .description("string")
        .externalValue("string")
        .id("string")
        .name("string")
        .build())
    .build());

    entitlement_resource = okta.Entitlement("entitlementResource",
    data_type="string",
    external_value="string",
    multi_value=False,
    description="string",
    name="string",
    parent={
        "external_id": "string",
        "type": "string",
    },
    parent_resource_orn="string",
    value="string",
    values=[{
        "description": "string",
        "external_value": "string",
        "id": "string",
        "name": "string",
    }])

    const entitlementResource = new okta.Entitlement("entitlementResource", {
    dataType: "string",
    externalValue: "string",
    multiValue: false,
    description: "string",
    name: "string",
    parent: {
        externalId: "string",
        type: "string",
    },
    parentResourceOrn: "string",
    value: "string",
    values: [{
        description: "string",
        externalValue: "string",
        id: "string",
        name: "string",
    }],
});

    type: okta:Entitlement
properties:
    dataType: string
    description: string
    externalValue: string
    multiValue: false
    name: string
    parent:
        externalId: string
        type: string
    parentResourceOrn: string
    value: string
    values:
        - description: string
          externalValue: string
          id: string
          name: string

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

    DataType string
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    ExternalValue string
    The value of an entitlement property.
    MultiValue bool
    The property that determines if the entitlement property can hold multiple values.
    Description string
    The description of an entitlement property.
    Name string
    The display name for an entitlement property.
    Parent EntitlementParent
    Representation of a resource
    ParentResourceOrn string
    The Okta app instance, in ORN format.
    Value string
    The value of the entitlement property.
    Values List<EntitlementValue>
    DataType string
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    ExternalValue string
    The value of an entitlement property.
    MultiValue bool
    The property that determines if the entitlement property can hold multiple values.
    Description string
    The description of an entitlement property.
    Name string
    The display name for an entitlement property.
    Parent EntitlementParentArgs
    Representation of a resource
    ParentResourceOrn string
    The Okta app instance, in ORN format.
    Value string
    The value of the entitlement property.
    Values []EntitlementValueArgs
    dataType String
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    externalValue String
    The value of an entitlement property.
    multiValue Boolean
    The property that determines if the entitlement property can hold multiple values.
    description String
    The description of an entitlement property.
    name String
    The display name for an entitlement property.
    parent EntitlementParent
    Representation of a resource
    parentResourceOrn String
    The Okta app instance, in ORN format.
    value String
    The value of the entitlement property.
    values List<EntitlementValue>
    dataType string
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    externalValue string
    The value of an entitlement property.
    multiValue boolean
    The property that determines if the entitlement property can hold multiple values.
    description string
    The description of an entitlement property.
    name string
    The display name for an entitlement property.
    parent EntitlementParent
    Representation of a resource
    parentResourceOrn string
    The Okta app instance, in ORN format.
    value string
    The value of the entitlement property.
    values EntitlementValue[]
    data_type str
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    external_value str
    The value of an entitlement property.
    multi_value bool
    The property that determines if the entitlement property can hold multiple values.
    description str
    The description of an entitlement property.
    name str
    The display name for an entitlement property.
    parent EntitlementParentArgs
    Representation of a resource
    parent_resource_orn str
    The Okta app instance, in ORN format.
    value str
    The value of the entitlement property.
    values Sequence[EntitlementValueArgs]
    dataType String
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    externalValue String
    The value of an entitlement property.
    multiValue Boolean
    The property that determines if the entitlement property can hold multiple values.
    description String
    The description of an entitlement property.
    name String
    The display name for an entitlement property.
    parent Property Map
    Representation of a resource
    parentResourceOrn String
    The Okta app instance, in ORN format.
    value String
    The value of the entitlement property.
    values List<Property Map>

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Entitlement Resource

    Get an existing Entitlement 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?: EntitlementState, opts?: CustomResourceOptions): Entitlement
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_type: Optional[str] = None,
        description: Optional[str] = None,
        external_value: Optional[str] = None,
        multi_value: Optional[bool] = None,
        name: Optional[str] = None,
        parent: Optional[EntitlementParentArgs] = None,
        parent_resource_orn: Optional[str] = None,
        value: Optional[str] = None,
        values: Optional[Sequence[EntitlementValueArgs]] = None) -> Entitlement
    func GetEntitlement(ctx *Context, name string, id IDInput, state *EntitlementState, opts ...ResourceOption) (*Entitlement, error)
    public static Entitlement Get(string name, Input<string> id, EntitlementState? state, CustomResourceOptions? opts = null)
    public static Entitlement get(String name, Output<String> id, EntitlementState state, CustomResourceOptions options)
    resources:  _:    type: okta:Entitlement    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:
    DataType string
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    Description string
    The description of an entitlement property.
    ExternalValue string
    The value of an entitlement property.
    MultiValue bool
    The property that determines if the entitlement property can hold multiple values.
    Name string
    The display name for an entitlement property.
    Parent EntitlementParent
    Representation of a resource
    ParentResourceOrn string
    The Okta app instance, in ORN format.
    Value string
    The value of the entitlement property.
    Values List<EntitlementValue>
    DataType string
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    Description string
    The description of an entitlement property.
    ExternalValue string
    The value of an entitlement property.
    MultiValue bool
    The property that determines if the entitlement property can hold multiple values.
    Name string
    The display name for an entitlement property.
    Parent EntitlementParentArgs
    Representation of a resource
    ParentResourceOrn string
    The Okta app instance, in ORN format.
    Value string
    The value of the entitlement property.
    Values []EntitlementValueArgs
    dataType String
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    description String
    The description of an entitlement property.
    externalValue String
    The value of an entitlement property.
    multiValue Boolean
    The property that determines if the entitlement property can hold multiple values.
    name String
    The display name for an entitlement property.
    parent EntitlementParent
    Representation of a resource
    parentResourceOrn String
    The Okta app instance, in ORN format.
    value String
    The value of the entitlement property.
    values List<EntitlementValue>
    dataType string
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    description string
    The description of an entitlement property.
    externalValue string
    The value of an entitlement property.
    multiValue boolean
    The property that determines if the entitlement property can hold multiple values.
    name string
    The display name for an entitlement property.
    parent EntitlementParent
    Representation of a resource
    parentResourceOrn string
    The Okta app instance, in ORN format.
    value string
    The value of the entitlement property.
    values EntitlementValue[]
    data_type str
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    description str
    The description of an entitlement property.
    external_value str
    The value of an entitlement property.
    multi_value bool
    The property that determines if the entitlement property can hold multiple values.
    name str
    The display name for an entitlement property.
    parent EntitlementParentArgs
    Representation of a resource
    parent_resource_orn str
    The Okta app instance, in ORN format.
    value str
    The value of the entitlement property.
    values Sequence[EntitlementValueArgs]
    dataType String
    The data type of the entitlement property. If the entitlement property is multivalued, the data type is replaced with an array. Enum: "array", "string".
    description String
    The description of an entitlement property.
    externalValue String
    The value of an entitlement property.
    multiValue Boolean
    The property that determines if the entitlement property can hold multiple values.
    name String
    The display name for an entitlement property.
    parent Property Map
    Representation of a resource
    parentResourceOrn String
    The Okta app instance, in ORN format.
    value String
    The value of the entitlement property.
    values List<Property Map>

    Supporting Types

    EntitlementParent, EntitlementParentArgs

    ExternalId string
    The Okta app ID of the resource.
    Type string
    The type of resource.
    ExternalId string
    The Okta app ID of the resource.
    Type string
    The type of resource.
    externalId String
    The Okta app ID of the resource.
    type String
    The type of resource.
    externalId string
    The Okta app ID of the resource.
    type string
    The type of resource.
    external_id str
    The Okta app ID of the resource.
    type str
    The type of resource.
    externalId String
    The Okta app ID of the resource.
    type String
    The type of resource.

    EntitlementValue, EntitlementValueArgs

    Description string
    The description of an entitlement value.
    ExternalValue string
    The value of an entitlement property value.
    Id string
    Collection of entitlement values.
    Name string
    The display name for an entitlement value.
    Description string
    The description of an entitlement value.
    ExternalValue string
    The value of an entitlement property value.
    Id string
    Collection of entitlement values.
    Name string
    The display name for an entitlement value.
    description String
    The description of an entitlement value.
    externalValue String
    The value of an entitlement property value.
    id String
    Collection of entitlement values.
    name String
    The display name for an entitlement value.
    description string
    The description of an entitlement value.
    externalValue string
    The value of an entitlement property value.
    id string
    Collection of entitlement values.
    name string
    The display name for an entitlement value.
    description str
    The description of an entitlement value.
    external_value str
    The value of an entitlement property value.
    id str
    Collection of entitlement values.
    name str
    The display name for an entitlement value.
    description String
    The description of an entitlement value.
    externalValue String
    The value of an entitlement property value.
    id String
    Collection of entitlement values.
    name String
    The display name for an entitlement value.

    Import

    $ pulumi import okta:index/entitlement:Entitlement example <entitlement_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 v6.0.0 published on Friday, Oct 10, 2025 by Pulumi
    pulumi/pulumi-okta
      Meet Neo: Your AI Platform Teammate