Okta v4.8.2 published on Wednesday, May 22, 2024 by Pulumi
okta.getOrgMetadata
Explore with Pulumi AI
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.getOrgMetadata({});
import pulumi
import pulumi_okta as okta
test = okta.get_org_metadata()
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := okta.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.GetOrgMetadata.Invoke();
});
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.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 = OktaFunctions.getOrgMetadata();
}
}
variables:
test:
fn::invoke:
Function: okta: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[GetOrgMetadataDomains] = None,
settings: Optional[GetOrgMetadataSettings] = None,
opts: Optional[InvokeOptions] = None) -> GetOrgMetadataResult
def get_org_metadata_output(domains: Optional[pulumi.Input[GetOrgMetadataDomainsArgs]] = None,
settings: Optional[pulumi.Input[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
Get
Org Metadata Domains - The URIs for the org's configured domains.
- Settings
Get
Org Metadata Settings - The wellknown org settings (safe for public consumption).
- Domains
Get
Org Metadata Domains - The URIs for the org's configured domains.
- Settings
Get
Org Metadata Settings - The wellknown org settings (safe for public consumption).
- domains
Get
Org Metadata Domains - The URIs for the org's configured domains.
- settings
Get
Org Metadata Settings - The wellknown org settings (safe for public consumption).
- domains
Get
Org Metadata Domains - The URIs for the org's configured domains.
- settings
Get
Org Metadata Settings - The wellknown org settings (safe for public consumption).
- domains
Get
Org Metadata Domains - The URIs for the org's configured domains.
- settings
Get
Org Metadata Settings - 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
Get
Org Metadata Domains - The URIs for the org's configured domains.
- Settings
Get
Org Metadata Settings - 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
Get
Org Metadata Domains - The URIs for the org's configured domains.
- Settings
Get
Org Metadata Settings - 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
Get
Org Metadata Domains - The URIs for the org's configured domains.
- settings
Get
Org Metadata Settings - 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
Get
Org Metadata Domains - The URIs for the org's configured domains.
- settings
Get
Org Metadata Settings - 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
Get
Org Metadata Domains - The URIs for the org's configured domains.
- settings
Get
Org Metadata Settings - 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
- Analytics
Collection boolEnabled - Bug
Reporting boolEnabled - Om
Enabled bool - Whether the legacy Okta Mobile application is enabled for the org
- Analytics
Collection boolEnabled - Bug
Reporting boolEnabled - Om
Enabled bool - Whether the legacy Okta Mobile application is enabled for the org
- analytics
Collection BooleanEnabled - bug
Reporting BooleanEnabled - om
Enabled Boolean - Whether the legacy Okta Mobile application is enabled for the org
- analytics
Collection booleanEnabled - bug
Reporting booleanEnabled - om
Enabled boolean - Whether the legacy Okta Mobile application is enabled for the org
- analytics_
collection_ boolenabled - bug_
reporting_ boolenabled - om_
enabled bool - Whether the legacy Okta Mobile application is enabled for the org
- analytics
Collection BooleanEnabled - bug
Reporting BooleanEnabled - om
Enabled 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.