Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. Index
  5. getOrgMetadata
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

okta.Index.getOrgMetadata

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

    Retrieves the well-known org metadata, which includes the id, configured custom domains, authentication pipeline, and various other org settings.

    Example Usage

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

const test = okta.Index.getOrgMetadata({});

    import pulumi
import pulumi_okta as okta

test = okta.Index.get_org_metadata()

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Index.GetOrgMetadata(ctx, nil, 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.Index.GetOrgMetadata.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Index.IndexFunctions;
import com.pulumi.okta.Index.inputs.GetOrgMetadataArgs;
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 = IndexFunctions.getOrgMetadata();

    }
}

    variables:
  test:
    fn::invoke:
      Function: okta:Index:getOrgMetadata
      Arguments: {}

    Using getOrgMetadata

    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 getOrgMetadata(args: GetOrgMetadataArgs, opts?: InvokeOptions): Promise<GetOrgMetadataResult>
function getOrgMetadataOutput(args: GetOrgMetadataOutputArgs, opts?: InvokeOptions): Output<GetOrgMetadataResult>
    def get_org_metadata(domains: Optional[_index.GetOrgMetadataDomains] = None,
                     settings: Optional[_index.GetOrgMetadataSettings] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOrgMetadataResult
def get_org_metadata_output(domains: Optional[pulumi.Input[_index.GetOrgMetadataDomainsArgs]] = None,
                     settings: Optional[pulumi.Input[_index.GetOrgMetadataSettingsArgs]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOrgMetadataResult]
    func GetOrgMetadata(ctx *Context, args *GetOrgMetadataArgs, opts ...InvokeOption) (*GetOrgMetadataResult, error)
func GetOrgMetadataOutput(ctx *Context, args *GetOrgMetadataOutputArgs, opts ...InvokeOption) GetOrgMetadataResultOutput

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

    public static class GetOrgMetadata 
{
    public static Task<GetOrgMetadataResult> InvokeAsync(GetOrgMetadataArgs args, InvokeOptions? opts = null)
    public static Output<GetOrgMetadataResult> Invoke(GetOrgMetadataInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOrgMetadataResult> getOrgMetadata(GetOrgMetadataArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: okta:Index/getOrgMetadata:getOrgMetadata
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Domains GetOrgMetadataDomains
    The URIs for the org's configured domains.
    Settings GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    Domains GetOrgMetadataDomains
    The URIs for the org's configured domains.
    Settings GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    domains GetOrgMetadataDomains
    The URIs for the org's configured domains.
    settings GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    domains GetOrgMetadataDomains
    The URIs for the org's configured domains.
    settings GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    domains index.GetOrgMetadataDomains
    The URIs for the org's configured domains.
    settings index.GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    domains Property Map
    The URIs for the org's configured domains.
    settings Property Map
    The wellknown org settings (safe for public consumption).

    getOrgMetadata Result

    The following output properties are available:

    Id string
    The unique identifier of the Org.
    Pipeline string
    The authentication pipeline of the org. idx means the org is using the Identity Engine, while v1 means the org is using the Classic authentication pipeline.
    Domains GetOrgMetadataDomains
    The URIs for the org's configured domains.
    Settings GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    Id string
    The unique identifier of the Org.
    Pipeline string
    The authentication pipeline of the org. idx means the org is using the Identity Engine, while v1 means the org is using the Classic authentication pipeline.
    Domains GetOrgMetadataDomains
    The URIs for the org's configured domains.
    Settings GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    id String
    The unique identifier of the Org.
    pipeline String
    The authentication pipeline of the org. idx means the org is using the Identity Engine, while v1 means the org is using the Classic authentication pipeline.
    domains GetOrgMetadataDomains
    The URIs for the org's configured domains.
    settings GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    id string
    The unique identifier of the Org.
    pipeline string
    The authentication pipeline of the org. idx means the org is using the Identity Engine, while v1 means the org is using the Classic authentication pipeline.
    domains GetOrgMetadataDomains
    The URIs for the org's configured domains.
    settings GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    id str
    The unique identifier of the Org.
    pipeline str
    The authentication pipeline of the org. idx means the org is using the Identity Engine, while v1 means the org is using the Classic authentication pipeline.
    domains index.GetOrgMetadataDomains
    The URIs for the org's configured domains.
    settings index.GetOrgMetadataSettings
    The wellknown org settings (safe for public consumption).
    id String
    The unique identifier of the Org.
    pipeline String
    The authentication pipeline of the org. idx means the org is using the Identity Engine, while v1 means the org is using the Classic authentication pipeline.
    domains Property Map
    The URIs for the org's configured domains.
    settings Property Map
    The wellknown org settings (safe for public consumption).

    Supporting Types

    GetOrgMetadataDomains

    Alternate string
    Custom Domain Org URI
    Organization string
    Standard Org URI
    Alternate string
    Custom Domain Org URI
    Organization string
    Standard Org URI
    alternate String
    Custom Domain Org URI
    organization String
    Standard Org URI
    alternate string
    Custom Domain Org URI
    organization string
    Standard Org URI
    alternate str
    Custom Domain Org URI
    organization str
    Standard Org URI
    alternate String
    Custom Domain Org URI
    organization String
    Standard Org URI

    GetOrgMetadataSettings

    AnalyticsCollectionEnabled bool
    BugReportingEnabled bool
    OmEnabled bool
    Whether the legacy Okta Mobile application is enabled for the org
    AnalyticsCollectionEnabled bool
    BugReportingEnabled bool
    OmEnabled bool
    Whether the legacy Okta Mobile application is enabled for the org
    analyticsCollectionEnabled Boolean
    bugReportingEnabled Boolean
    omEnabled Boolean
    Whether the legacy Okta Mobile application is enabled for the org
    analyticsCollectionEnabled boolean
    bugReportingEnabled boolean
    omEnabled boolean
    Whether the legacy Okta Mobile application is enabled for the org
    analytics_collection_enabled bool
    bug_reporting_enabled bool
    om_enabled bool
    Whether the legacy Okta Mobile application is enabled for the org
    analyticsCollectionEnabled Boolean
    bugReportingEnabled Boolean
    omEnabled Boolean
    Whether the legacy Okta Mobile application is enabled for the org

    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 v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-okta