Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Okta Provider
  4. API Docs
  5. Label
Viewing docs for Okta v6.9.0
published on Wednesday, Jul 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.Label

okta logo
Viewing docs for Okta v6.9.0
published on Wednesday, Jul 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    Manages an okta.Label resource.

    Create Label Resource

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

    Constructor syntax

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

@overload
def Label(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          name: Optional[str] = None,
          values: Optional[Sequence[LabelValueArgs]] = None)
    func NewLabel(ctx *Context, name string, args *LabelArgs, opts ...ResourceOption) (*Label, error)
    public Label(string name, LabelArgs? args = null, CustomResourceOptions? opts = null)
    public Label(String name, LabelArgs args)
public Label(String name, LabelArgs args, CustomResourceOptions options)

    type: okta:Label
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "okta_label" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args LabelArgs
    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 LabelArgs
    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 LabelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LabelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LabelArgs
    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 labelResource = new Okta.Label("labelResource", new()
{
    Name = "string",
    Values = new[]
    {
        new Okta.Inputs.LabelValueArgs
        {
            Name = "string",
            LabelValueId = "string",
            Metadata = new Okta.Inputs.LabelValueMetadataArgs
            {
                AdditionalProperties = 
                {
                    { "string", "string" },
                },
            },
        },
    },
});

    example, err := okta.NewLabel(ctx, "labelResource", &okta.LabelArgs{
	Name: pulumi.String("string"),
	Values: okta.LabelValueArray{
		&okta.LabelValueArgs{
			Name:         pulumi.String("string"),
			LabelValueId: pulumi.String("string"),
			Metadata: &okta.LabelValueMetadataArgs{
				AdditionalProperties: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
			},
		},
	},
})

    resource "okta_label" "labelResource" {
  lifecycle {
    create_before_destroy = true
  }
  name = "string"
  values {
    name           = "string"
    label_value_id = "string"
    metadata = {
      additional_properties = {
        "string" = "string"
      }
    }
  }
}

    var labelResource = new Label("labelResource", LabelArgs.builder()
    .name("string")
    .values(LabelValueArgs.builder()
        .name("string")
        .labelValueId("string")
        .metadata(LabelValueMetadataArgs.builder()
            .additionalProperties(Map.of("string", "string"))
            .build())
        .build())
    .build());

    label_resource = okta.Label("labelResource",
    name="string",
    values=[{
        "name": "string",
        "label_value_id": "string",
        "metadata": {
            "additional_properties": {
                "string": "string",
            },
        },
    }])

    const labelResource = new okta.Label("labelResource", {
    name: "string",
    values: [{
        name: "string",
        labelValueId: "string",
        metadata: {
            additionalProperties: {
                string: "string",
            },
        },
    }],
});

    type: okta:Label
properties:
    name: string
    values:
        - labelValueId: string
          metadata:
            additionalProperties:
                string: string
          name: string

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

    Name string
    Key name of the label
    Values List<LabelValue>
    List of label values
    Name string
    Key name of the label
    Values []LabelValueArgs
    List of label values
    name string
    Key name of the label
    values list(object)
    List of label values
    name String
    Key name of the label
    values List<LabelValue>
    List of label values
    name string
    Key name of the label
    values LabelValue[]
    List of label values
    name str
    Key name of the label
    values Sequence[LabelValueArgs]
    List of label values
    name String
    Key name of the label
    values List<Property Map>
    List of label values

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LabelId string
    The ID of a label
    Id string
    The provider-assigned unique ID for this managed resource.
    LabelId string
    The ID of a label
    id string
    The provider-assigned unique ID for this managed resource.
    label_id string
    The ID of a label
    id String
    The provider-assigned unique ID for this managed resource.
    labelId String
    The ID of a label
    id string
    The provider-assigned unique ID for this managed resource.
    labelId string
    The ID of a label
    id str
    The provider-assigned unique ID for this managed resource.
    label_id str
    The ID of a label
    id String
    The provider-assigned unique ID for this managed resource.
    labelId String
    The ID of a label

    Look up Existing Label Resource

    Get an existing Label 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?: LabelState, opts?: CustomResourceOptions): Label
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        label_id: Optional[str] = None,
        name: Optional[str] = None,
        values: Optional[Sequence[LabelValueArgs]] = None) -> Label
    func GetLabel(ctx *Context, name string, id IDInput, state *LabelState, opts ...ResourceOption) (*Label, error)
    public static Label Get(string name, Input<string> id, LabelState? state, CustomResourceOptions? opts = null)
    public static Label get(String name, Output<String> id, LabelState state, CustomResourceOptions options)
    resources:  _:    type: okta:Label    get:      id: ${id}
    import {
  to = okta_label.example
  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:
    LabelId string
    The ID of a label
    Name string
    Key name of the label
    Values List<LabelValue>
    List of label values
    LabelId string
    The ID of a label
    Name string
    Key name of the label
    Values []LabelValueArgs
    List of label values
    label_id string
    The ID of a label
    name string
    Key name of the label
    values list(object)
    List of label values
    labelId String
    The ID of a label
    name String
    Key name of the label
    values List<LabelValue>
    List of label values
    labelId string
    The ID of a label
    name string
    Key name of the label
    values LabelValue[]
    List of label values
    label_id str
    The ID of a label
    name str
    Key name of the label
    values Sequence[LabelValueArgs]
    List of label values
    labelId String
    The ID of a label
    name String
    Key name of the label
    values List<Property Map>
    List of label values

    Supporting Types

    LabelValue, LabelValueArgs

    Name string
    Key name of the label
    LabelValueId string
    The ID of a label value
    Metadata LabelValueMetadata
    Metadata for a label value
    Name string
    Key name of the label
    LabelValueId string
    The ID of a label value
    Metadata LabelValueMetadata
    Metadata for a label value
    name string
    Key name of the label
    label_value_id string
    The ID of a label value
    metadata object
    Metadata for a label value
    name String
    Key name of the label
    labelValueId String
    The ID of a label value
    metadata LabelValueMetadata
    Metadata for a label value
    name string
    Key name of the label
    labelValueId string
    The ID of a label value
    metadata LabelValueMetadata
    Metadata for a label value
    name str
    Key name of the label
    label_value_id str
    The ID of a label value
    metadata LabelValueMetadata
    Metadata for a label value
    name String
    Key name of the label
    labelValueId String
    The ID of a label value
    metadata Property Map
    Metadata for a label value

    LabelValueMetadata, LabelValueMetadataArgs

    AdditionalProperties Dictionary<string, string>
    Additional metadata properties for the label value.
    AdditionalProperties map[string]string
    Additional metadata properties for the label value.
    additional_properties map(string)
    Additional metadata properties for the label value.
    additionalProperties Map<String,String>
    Additional metadata properties for the label value.
    additionalProperties {[key: string]: string}
    Additional metadata properties for the label value.
    additional_properties Mapping[str, str]
    Additional metadata properties for the label value.
    additionalProperties Map<String>
    Additional metadata properties for the label 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.9.0
    published on Wednesday, Jul 1, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-okta

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial