1. Packages
  2. Okta Provider
  3. API Docs
  4. getEntitlement
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.getEntitlement

okta logo
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    Get the entitlement belonging to an Okta organization.

    Example Usage

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

const test = okta.getEntitlement({
    id: "<entitlement id>",
});

    import pulumi
import pulumi_okta as okta

test = okta.get_entitlement(id="<entitlement id>")

    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.LookupEntitlement(ctx, &okta.LookupEntitlementArgs{
			Id: "<entitlement id>",
		}, nil)
		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 test = Okta.GetEntitlement.Invoke(new()
    {
        Id = "<entitlement id>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetEntitlementArgs;
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) {
        final var test = OktaFunctions.getEntitlement(GetEntitlementArgs.builder()
            .id("<entitlement id>")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: okta:getEntitlement
      arguments:
        id: <entitlement id>

    Using getEntitlement

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEntitlement(args: GetEntitlementArgs, opts?: InvokeOptions): Promise<GetEntitlementResult>
function getEntitlementOutput(args: GetEntitlementOutputArgs, opts?: InvokeOptions): Output<GetEntitlementResult>
    def get_entitlement(id: Optional[str] = None,
                    parent: Optional[GetEntitlementParent] = None,
                    values: Optional[Sequence[GetEntitlementValue]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEntitlementResult
def get_entitlement_output(id: Optional[pulumi.Input[str]] = None,
                    parent: Optional[pulumi.Input[GetEntitlementParentArgs]] = None,
                    values: Optional[pulumi.Input[Sequence[pulumi.Input[GetEntitlementValueArgs]]]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEntitlementResult]
    func LookupEntitlement(ctx *Context, args *LookupEntitlementArgs, opts ...InvokeOption) (*LookupEntitlementResult, error)
func LookupEntitlementOutput(ctx *Context, args *LookupEntitlementOutputArgs, opts ...InvokeOption) LookupEntitlementResultOutput

    > Note: This function is named LookupEntitlement in the Go SDK.

    public static class GetEntitlement 
{
    public static Task<GetEntitlementResult> InvokeAsync(GetEntitlementArgs args, InvokeOptions? opts = null)
    public static Output<GetEntitlementResult> Invoke(GetEntitlementInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEntitlementResult> getEntitlement(GetEntitlementArgs args, InvokeOptions options)
public static Output<GetEntitlementResult> getEntitlement(GetEntitlementArgs args, InvokeOptions options)

    fn::invoke:
  function: okta:index/getEntitlement:getEntitlement
  arguments:
    # arguments dictionary

    The following arguments are supported:

    id String
    The ID of this resource.
    parent Property Map
    values List<Property Map>

    getEntitlement Result

    The following output properties are available:

    dataType String
    externalValue String
    id String
    The ID of this resource.
    multiValue Boolean
    name String
    parentResourceOrn String
    parent Property Map
    values List<Property Map>

    Supporting Types

    GetEntitlementParent

    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.

    GetEntitlementValue

    Description string
    The description of an entitlement value.
    ExternalId string
    The id of the entitlement value.
    ExternalValue string
    The value of an entitlement property value.
    Id string
    The ID of this resource.
    Name string
    The name of the entitlement value.
    Description string
    The description of an entitlement value.
    ExternalId string
    The id of the entitlement value.
    ExternalValue string
    The value of an entitlement property value.
    Id string
    The ID of this resource.
    Name string
    The name of the entitlement value.
    description String
    The description of an entitlement value.
    externalId String
    The id of the entitlement value.
    externalValue String
    The value of an entitlement property value.
    id String
    The ID of this resource.
    name String
    The name of the entitlement value.
    description string
    The description of an entitlement value.
    externalId string
    The id of the entitlement value.
    externalValue string
    The value of an entitlement property value.
    id string
    The ID of this resource.
    name string
    The name of the entitlement value.
    description str
    The description of an entitlement value.
    external_id str
    The id of the entitlement value.
    external_value str
    The value of an entitlement property value.
    id str
    The ID of this resource.
    name str
    The name of the entitlement value.
    description String
    The description of an entitlement value.
    externalId String
    The id of the entitlement value.
    externalValue String
    The value of an entitlement property value.
    id String
    The ID of this resource.
    name String
    The name of the entitlement value.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Viewing docs for Okta v6.3.1
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-okta
      Try Pulumi Cloud free. Your team will thank you.