1. Packages
  2. Packages
  3. Okta Provider
  4. API Docs
  5. getLabel
Viewing docs for Okta v6.9.0
published on Wednesday, Jul 1, 2026 by Pulumi
okta logo
Viewing docs for Okta v6.9.0
published on Wednesday, Jul 1, 2026 by Pulumi

    Retrieves a single label

    Using getLabel

    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 getLabel(args: GetLabelArgs, opts?: InvokeOptions): Promise<GetLabelResult>
    function getLabelOutput(args: GetLabelOutputArgs, opts?: InvokeOptions): Output<GetLabelResult>
    def get_label(id: Optional[str] = None,
                  values: Optional[Sequence[GetLabelValue]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetLabelResult
    def get_label_output(id: pulumi.Input[Optional[str]] = None,
                  values: pulumi.Input[Optional[Sequence[pulumi.Input[GetLabelValueArgs]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetLabelResult]
    func LookupLabel(ctx *Context, args *LookupLabelArgs, opts ...InvokeOption) (*LookupLabelResult, error)
    func LookupLabelOutput(ctx *Context, args *LookupLabelOutputArgs, opts ...InvokeOption) LookupLabelResultOutput

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

    public static class GetLabel 
    {
        public static Task<GetLabelResult> InvokeAsync(GetLabelArgs args, InvokeOptions? opts = null)
        public static Output<GetLabelResult> Invoke(GetLabelInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLabelResult> getLabel(GetLabelArgs args, InvokeOptions options)
    public static Output<GetLabelResult> getLabel(GetLabelArgs args, InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getLabel:getLabel
      arguments:
        # arguments dictionary
    data "okta_get_label" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    The ID of the data source.
    Values List<GetLabelValue>
    List of label values
    Id string
    The ID of the data source.
    Values []GetLabelValue
    List of label values
    id string
    The ID of the data source.
    values list(object)
    List of label values
    id String
    The ID of the data source.
    values List<GetLabelValue>
    List of label values
    id string
    The ID of the data source.
    values GetLabelValue[]
    List of label values
    id str
    The ID of the data source.
    values Sequence[GetLabelValue]
    List of label values
    id String
    The ID of the data source.
    values List<Property Map>
    List of label values

    getLabel Result

    The following output properties are available:

    Id string
    The ID of the data source.
    LabelId string
    The ID of a label
    Name string
    Key name of the label
    Values List<GetLabelValue>
    List of label values
    Id string
    The ID of the data source.
    LabelId string
    The ID of a label
    Name string
    Key name of the label
    Values []GetLabelValue
    List of label values
    id string
    The ID of the data source.
    label_id string
    The ID of a label
    name string
    Key name of the label
    values list(object)
    List of label values
    id String
    The ID of the data source.
    labelId String
    The ID of a label
    name String
    Key name of the label
    values List<GetLabelValue>
    List of label values
    id string
    The ID of the data source.
    labelId string
    The ID of a label
    name string
    Key name of the label
    values GetLabelValue[]
    List of label values
    id str
    The ID of the data source.
    label_id str
    The ID of a label
    name str
    Key name of the label
    values Sequence[GetLabelValue]
    List of label values
    id String
    The ID of the data source.
    labelId String
    The ID of a label
    name String
    Key name of the label
    values List<Property Map>
    List of label values

    Supporting Types

    GetLabelValue

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

    GetLabelValueMetadata

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial