1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. getOrg
Control Plane v0.0.60 published on Thursday, Jul 3, 2025 by pulumiverse

cpln.getOrg

Explore with Pulumi AI

cpln logo
Control Plane v0.0.60 published on Thursday, Jul 3, 2025 by pulumiverse

    Output the ID and name of the current org.

    Outputs

    The following attributes are exported:

    • cpln_id (String) The ID, in GUID format, of the org.
    • name (String) The name of org.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cpln from "@pulumiverse/cpln";
    
    const org = cpln.getOrg({});
    export const orgId = org.then(org => org.id);
    export const orgName = org.then(org => org.name);
    
    import pulumi
    import pulumi_cpln as cpln
    
    org = cpln.get_org()
    pulumi.export("orgId", org.id)
    pulumi.export("orgName", org.name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-cpln/sdk/go/cpln"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		org, err := cpln.LookupOrg(ctx, &cpln.LookupOrgArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("orgId", org.Id)
    		ctx.Export("orgName", org.Name)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cpln = Pulumi.Cpln;
    
    return await Deployment.RunAsync(() => 
    {
        var org = Cpln.GetOrg.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["orgId"] = org.Apply(getOrgResult => getOrgResult.Id),
            ["orgName"] = org.Apply(getOrgResult => getOrgResult.Name),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cpln.CplnFunctions;
    import com.pulumi.cpln.inputs.GetOrgArgs;
    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 org = CplnFunctions.getOrg(GetOrgArgs.builder()
                .build());
    
            ctx.export("orgId", org.id());
            ctx.export("orgName", org.name());
        }
    }
    
    variables:
      org:
        fn::invoke:
          function: cpln:getOrg
          arguments: {}
    outputs:
      orgId: ${org.id}
      orgName: ${org.name}
    

    Using getOrg

    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 getOrg(args: GetOrgArgs, opts?: InvokeOptions): Promise<GetOrgResult>
    function getOrgOutput(args: GetOrgOutputArgs, opts?: InvokeOptions): Output<GetOrgResult>
    def get_org(auth_config: Optional[GetOrgAuthConfig] = None,
                observability: Optional[GetOrgObservability] = None,
                security: Optional[GetOrgSecurity] = None,
                opts: Optional[InvokeOptions] = None) -> GetOrgResult
    def get_org_output(auth_config: Optional[pulumi.Input[GetOrgAuthConfigArgs]] = None,
                observability: Optional[pulumi.Input[GetOrgObservabilityArgs]] = None,
                security: Optional[pulumi.Input[GetOrgSecurityArgs]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetOrgResult]
    func LookupOrg(ctx *Context, args *LookupOrgArgs, opts ...InvokeOption) (*LookupOrgResult, error)
    func LookupOrgOutput(ctx *Context, args *LookupOrgOutputArgs, opts ...InvokeOption) LookupOrgResultOutput

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

    public static class GetOrg 
    {
        public static Task<GetOrgResult> InvokeAsync(GetOrgArgs args, InvokeOptions? opts = null)
        public static Output<GetOrgResult> Invoke(GetOrgInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrgResult> getOrg(GetOrgArgs args, InvokeOptions options)
    public static Output<GetOrgResult> getOrg(GetOrgArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cpln:index/getOrg:getOrg
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getOrg Result

    The following output properties are available:

    Supporting Types

    GetOrgAuthConfig

    DomainAutoMembers List<string>
    List of domains which will auto-provision users when authenticating using SAML.
    SamlOnly bool
    Enforce SAML only authentication.
    DomainAutoMembers []string
    List of domains which will auto-provision users when authenticating using SAML.
    SamlOnly bool
    Enforce SAML only authentication.
    domainAutoMembers List<String>
    List of domains which will auto-provision users when authenticating using SAML.
    samlOnly Boolean
    Enforce SAML only authentication.
    domainAutoMembers string[]
    List of domains which will auto-provision users when authenticating using SAML.
    samlOnly boolean
    Enforce SAML only authentication.
    domain_auto_members Sequence[str]
    List of domains which will auto-provision users when authenticating using SAML.
    saml_only bool
    Enforce SAML only authentication.
    domainAutoMembers List<String>
    List of domains which will auto-provision users when authenticating using SAML.
    samlOnly Boolean
    Enforce SAML only authentication.

    GetOrgObservability

    DefaultAlertEmails List<string>
    These emails are configured as alert recipients in Grafana when the 'grafana-default-email' contact delivery type is 'Email'.
    LogsRetentionDays int
    Log retention days. Default: 30
    MetricsRetentionDays int
    Metrics retention days. Default: 30
    TracesRetentionDays int
    Traces retention days. Default: 30
    DefaultAlertEmails []string
    These emails are configured as alert recipients in Grafana when the 'grafana-default-email' contact delivery type is 'Email'.
    LogsRetentionDays int
    Log retention days. Default: 30
    MetricsRetentionDays int
    Metrics retention days. Default: 30
    TracesRetentionDays int
    Traces retention days. Default: 30
    defaultAlertEmails List<String>
    These emails are configured as alert recipients in Grafana when the 'grafana-default-email' contact delivery type is 'Email'.
    logsRetentionDays Integer
    Log retention days. Default: 30
    metricsRetentionDays Integer
    Metrics retention days. Default: 30
    tracesRetentionDays Integer
    Traces retention days. Default: 30
    defaultAlertEmails string[]
    These emails are configured as alert recipients in Grafana when the 'grafana-default-email' contact delivery type is 'Email'.
    logsRetentionDays number
    Log retention days. Default: 30
    metricsRetentionDays number
    Metrics retention days. Default: 30
    tracesRetentionDays number
    Traces retention days. Default: 30
    default_alert_emails Sequence[str]
    These emails are configured as alert recipients in Grafana when the 'grafana-default-email' contact delivery type is 'Email'.
    logs_retention_days int
    Log retention days. Default: 30
    metrics_retention_days int
    Metrics retention days. Default: 30
    traces_retention_days int
    Traces retention days. Default: 30
    defaultAlertEmails List<String>
    These emails are configured as alert recipients in Grafana when the 'grafana-default-email' contact delivery type is 'Email'.
    logsRetentionDays Number
    Log retention days. Default: 30
    metricsRetentionDays Number
    Metrics retention days. Default: 30
    tracesRetentionDays Number
    Traces retention days. Default: 30

    GetOrgSecurity

    GetOrgSecurityThreatDetection

    Enabled bool
    Indicates whether threat detection should be forwarded or not.
    MinimumSeverity string
    Any threats with this severity and more severe will be sent. Others will be ignored. Valid values: warning, error, or critical.
    Syslog Pulumiverse.Cpln.Inputs.GetOrgSecurityThreatDetectionSyslog
    Configuration for syslog forwarding.
    Enabled bool
    Indicates whether threat detection should be forwarded or not.
    MinimumSeverity string
    Any threats with this severity and more severe will be sent. Others will be ignored. Valid values: warning, error, or critical.
    Syslog GetOrgSecurityThreatDetectionSyslog
    Configuration for syslog forwarding.
    enabled Boolean
    Indicates whether threat detection should be forwarded or not.
    minimumSeverity String
    Any threats with this severity and more severe will be sent. Others will be ignored. Valid values: warning, error, or critical.
    syslog GetOrgSecurityThreatDetectionSyslog
    Configuration for syslog forwarding.
    enabled boolean
    Indicates whether threat detection should be forwarded or not.
    minimumSeverity string
    Any threats with this severity and more severe will be sent. Others will be ignored. Valid values: warning, error, or critical.
    syslog GetOrgSecurityThreatDetectionSyslog
    Configuration for syslog forwarding.
    enabled bool
    Indicates whether threat detection should be forwarded or not.
    minimum_severity str
    Any threats with this severity and more severe will be sent. Others will be ignored. Valid values: warning, error, or critical.
    syslog GetOrgSecurityThreatDetectionSyslog
    Configuration for syslog forwarding.
    enabled Boolean
    Indicates whether threat detection should be forwarded or not.
    minimumSeverity String
    Any threats with this severity and more severe will be sent. Others will be ignored. Valid values: warning, error, or critical.
    syslog Property Map
    Configuration for syslog forwarding.

    GetOrgSecurityThreatDetectionSyslog

    Host string
    The hostname to send syslog messages to.
    Port int
    The port to send syslog messages to.
    Transport string
    The transport-layer protocol to send the syslog messages over. If TCP is chosen, messages will be sent with TLS. Default: tcp.
    Host string
    The hostname to send syslog messages to.
    Port int
    The port to send syslog messages to.
    Transport string
    The transport-layer protocol to send the syslog messages over. If TCP is chosen, messages will be sent with TLS. Default: tcp.
    host String
    The hostname to send syslog messages to.
    port Integer
    The port to send syslog messages to.
    transport String
    The transport-layer protocol to send the syslog messages over. If TCP is chosen, messages will be sent with TLS. Default: tcp.
    host string
    The hostname to send syslog messages to.
    port number
    The port to send syslog messages to.
    transport string
    The transport-layer protocol to send the syslog messages over. If TCP is chosen, messages will be sent with TLS. Default: tcp.
    host str
    The hostname to send syslog messages to.
    port int
    The port to send syslog messages to.
    transport str
    The transport-layer protocol to send the syslog messages over. If TCP is chosen, messages will be sent with TLS. Default: tcp.
    host String
    The hostname to send syslog messages to.
    port Number
    The port to send syslog messages to.
    transport String
    The transport-layer protocol to send the syslog messages over. If TCP is chosen, messages will be sent with TLS. Default: tcp.

    GetOrgStatus

    AccountLink string
    The link of the account the org belongs to.
    Active bool
    Indicates whether the org is active or not.
    AccountLink string
    The link of the account the org belongs to.
    Active bool
    Indicates whether the org is active or not.
    accountLink String
    The link of the account the org belongs to.
    active Boolean
    Indicates whether the org is active or not.
    accountLink string
    The link of the account the org belongs to.
    active boolean
    Indicates whether the org is active or not.
    account_link str
    The link of the account the org belongs to.
    active bool
    Indicates whether the org is active or not.
    accountLink String
    The link of the account the org belongs to.
    active Boolean
    Indicates whether the org is active or not.

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.60 published on Thursday, Jul 3, 2025 by pulumiverse