getOrg

Control Plane v0.0.84, Mar 20 26

Viewing docs for Control Plane v0.0.84
published on Friday, Mar 20, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-cpln

Viewing docs for Control Plane v0.0.84
published on Friday, Mar 20, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-cpln

Outputs

The following attributes are exported:

id (String) The unique identifier for this org.
cpln_id (String) The ID, in GUID format, of the org.
name (String) The name of org.
description (String) Description of the org.
tags (Map of String) Key-value map of resource tags.
self_link (String) Full link to this resource. Can be referenced by other resources.
observability (Block List, Max: 1) (see below).
account_id (String) The associated account ID that was used when creating the org.
invitees (Set of String) Email addresses that received invitations to join the org and were assigned to the superusers group.
session_timeout_seconds (Int) The idle time (in seconds) after which the console UI signs out the user. Default: 900.
auth_config (Block List, Max: 1) (see below).
security (Block List, Max: 1) (see below).
status (List of Object) (see below).

`observability`

The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.

Read-Only:

logs_retention_days (Number) Log retention days. Default: 30.
metrics_retention_days (Number) Metrics retention days. Default: 30.
traces_retention_days (Number) Traces retention days. Default: 30.
default_alert_emails (Set of String) These emails are configured as alert recipients in Grafana when the grafana-default-email contact delivery type is Email.

`auth_config`

Configuration settings related to authentication within the org.

Read-Only:

domain_auto_members (Set of String) List of domains that auto-provision users when authenticating using SAML.
saml_only (Boolean) Enforces SAML-only authentication.

`security`

Read-Only:

threat_detection (Block List, Max: 1) (see below).

`security.threat_detection`

Read-Only:

enabled (Boolean) Indicates whether threat detection information is forwarded.
minimum_severity (String) Any threats with this severity and more severe are sent. Others are ignored. Valid values: warning, error, or critical.
syslog (Block List, Max: 1) (see below).

`security.threat_detection.syslog`

Read-Only:

port (Number) The port to send syslog messages to.
transport (String) The transport-layer protocol used for syslog messages. If tcp is chosen, messages are sent with TLS. Default: tcp.
host (String) The hostname to send syslog messages to.

`status`

Status of the org.

Read-Only:

account_link (String) The link of the account the org belongs to.
active (Boolean) Indicates whether the org is active or not.
endpoint_prefix (String)

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cpln from "@pulumiverse/cpln";

const org = cpln.getOrg({});
export const orgSummary = {
    name: org.then(org => org.name),
    cplnId: org.then(org => org.cplnId),
    accountId: org.then(org => org.accountId),
    sessionTimeoutSec: org.then(org => org.sessionTimeoutSeconds),
    observability: org.then(org => org.observability),
};

import pulumi
import pulumi_cpln as cpln

org = cpln.get_org()
pulumi.export("orgSummary", {
    "name": org.name,
    "cplnId": org.cpln_id,
    "accountId": org.account_id,
    "sessionTimeoutSec": org.session_timeout_seconds,
    "observability": org.observability,
})

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("orgSummary", pulumi.Map{
			"name":              org.Name,
			"cplnId":            org.CplnId,
			"accountId":         org.AccountId,
			"sessionTimeoutSec": org.SessionTimeoutSeconds,
			"observability":     org.Observability,
		})
		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?>
    {
        ["orgSummary"] = 
        {
            { "name", org.Apply(getOrgResult => getOrgResult.Name) },
            { "cplnId", org.Apply(getOrgResult => getOrgResult.CplnId) },
            { "accountId", org.Apply(getOrgResult => getOrgResult.AccountId) },
            { "sessionTimeoutSec", org.Apply(getOrgResult => getOrgResult.SessionTimeoutSeconds) },
            { "observability", org.Apply(getOrgResult => getOrgResult.Observability) },
        },
    };
});

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("orgSummary", Map.ofEntries(
            Map.entry("name", org.name()),
            Map.entry("cplnId", org.cplnId()),
            Map.entry("accountId", org.accountId()),
            Map.entry("sessionTimeoutSec", org.sessionTimeoutSeconds()),
            Map.entry("observability", org.observability())
        ));
    }
}

variables:
  org:
    fn::invoke:
      function: cpln:getOrg
      arguments: {}
outputs:
  orgSummary:
    name: ${org.name}
    cplnId: ${org.cplnId}
    accountId: ${org.accountId}
    sessionTimeoutSec: ${org.sessionTimeoutSeconds}
    observability: ${org.observability}

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:

AuthConfig Pulumiverse.Cpln.Inputs.GetOrgAuthConfig
Observability Pulumiverse.Cpln.Inputs.GetOrgObservability
Security Pulumiverse.Cpln.Inputs.GetOrgSecurity

AuthConfig GetOrgAuthConfig
Observability GetOrgObservability
Security GetOrgSecurity

authConfig GetOrgAuthConfig
observability GetOrgObservability
security GetOrgSecurity

authConfig GetOrgAuthConfig
observability GetOrgObservability
security GetOrgSecurity

auth_config GetOrgAuthConfig
observability GetOrgObservability
security GetOrgSecurity

authConfig Property Map
observability Property Map
security Property Map

getOrg Result

The following output properties are available:

AccountId string
CplnId string
Description string
Id string
Invitees List<string>
Name string
SelfLink string
SessionTimeoutSeconds int
Statuses List<Pulumiverse.Cpln.Outputs.GetOrgStatus>
Tags Dictionary<string, string>
AuthConfig Pulumiverse.Cpln.Outputs.GetOrgAuthConfig
Observability Pulumiverse.Cpln.Outputs.GetOrgObservability
Security Pulumiverse.Cpln.Outputs.GetOrgSecurity

AccountId string
CplnId string
Description string
Id string
Invitees []string
Name string
SelfLink string
SessionTimeoutSeconds int
Statuses []GetOrgStatus
Tags map[string]string
AuthConfig GetOrgAuthConfig
Observability GetOrgObservability
Security GetOrgSecurity

accountId String
cplnId String
description String
id String
invitees List<String>
name String
selfLink String
sessionTimeoutSeconds Integer
statuses List<GetOrgStatus>
tags Map<String,String>
authConfig GetOrgAuthConfig
observability GetOrgObservability
security GetOrgSecurity

accountId string
cplnId string
description string
id string
invitees string[]
name string
selfLink string
sessionTimeoutSeconds number
statuses GetOrgStatus[]
tags {[key: string]: string}
authConfig GetOrgAuthConfig
observability GetOrgObservability
security GetOrgSecurity

account_id str
cpln_id str
description str
id str
invitees Sequence[str]
name str
self_link str
session_timeout_seconds int
statuses Sequence[GetOrgStatus]
tags Mapping[str, str]
auth_config GetOrgAuthConfig
observability GetOrgObservability
security GetOrgSecurity

accountId String
cplnId String
description String
id String
invitees List<String>
name String
selfLink String
sessionTimeoutSeconds Number
statuses List<Property Map>
tags Map<String>
authConfig Property Map
observability Property Map
security Property Map

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

ThreatDetection Pulumiverse.Cpln.Inputs.GetOrgSecurityThreatDetection

ThreatDetection GetOrgSecurityThreatDetection

threatDetection GetOrgSecurityThreatDetection

threatDetection GetOrgSecurityThreatDetection

threat_detection GetOrgSecurityThreatDetection

threatDetection Property Map

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.
EndpointPrefix string

AccountLink string: The link of the account the org belongs to.
Active bool: Indicates whether the org is active or not.
EndpointPrefix string

accountLink String: The link of the account the org belongs to.
active Boolean: Indicates whether the org is active or not.
endpointPrefix String

accountLink string: The link of the account the org belongs to.
active boolean: Indicates whether the org is active or not.
endpointPrefix string

account_link str: The link of the account the org belongs to.
active bool: Indicates whether the org is active or not.
endpoint_prefix str

accountLink String: The link of the account the org belongs to.
active Boolean: Indicates whether the org is active or not.
endpointPrefix String

Package Details

Repository: cpln pulumiverse/pulumi-cpln
License: Apache-2.0
Notes: This Pulumi package is based on the cpln Terraform Provider.

Viewing docs for Control Plane v0.0.84
published on Friday, Mar 20, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-cpln

cpln.getOrg

On this page

On this page

Outputs

`observability`

`auth_config`

`security`

`security.threat_detection`

`security.threat_detection.syslog`

`status`

Example Usage

Using getOrg

getOrg Result

Supporting Types

GetOrgAuthConfig

GetOrgObservability

GetOrgSecurity

GetOrgSecurityThreatDetection

GetOrgSecurityThreatDetectionSyslog

GetOrgStatus

Package Details

On this page

On this page