Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getOrganization
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getOrganization

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.Organization

mongodbatlas.Organization describes all MongoDB Atlas Organizations. This represents organizations that have been created.

Example Usage

Using project_id attribute to query

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

const test = mongodbatlas.getOrganization({
    orgId: "<org_id>",
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_organization(org_id="<org_id>")
Copy
package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.LookupOrganization(ctx, &mongodbatlas.LookupOrganizationArgs{
			OrgId: "<org_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = Mongodbatlas.GetOrganization.Invoke(new()
    {
        OrgId = "<org_id>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetOrganizationArgs;
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 = MongodbatlasFunctions.getOrganization(GetOrganizationArgs.builder()
            .orgId("<org_id>")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getOrganization
      arguments:
        orgId: <org_id>
Copy

Using getOrganization

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 getOrganization(args: GetOrganizationArgs, opts?: InvokeOptions): Promise<GetOrganizationResult>
function getOrganizationOutput(args: GetOrganizationOutputArgs, opts?: InvokeOptions): Output<GetOrganizationResult>
Copy
def get_organization(org_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOrganizationResult
def get_organization_output(org_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationResult]
Copy
func LookupOrganization(ctx *Context, args *LookupOrganizationArgs, opts ...InvokeOption) (*LookupOrganizationResult, error)
func LookupOrganizationOutput(ctx *Context, args *LookupOrganizationOutputArgs, opts ...InvokeOption) LookupOrganizationResultOutput
Copy

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

public static class GetOrganization 
{
    public static Task<GetOrganizationResult> InvokeAsync(GetOrganizationArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationResult> Invoke(GetOrganizationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
public static Output<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getOrganization:getOrganization
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OrgId This property is required. string
Unique 24-hexadecimal digit string that identifies the organization.
OrgId This property is required. string
Unique 24-hexadecimal digit string that identifies the organization.
orgId This property is required. String
Unique 24-hexadecimal digit string that identifies the organization.
orgId This property is required. string
Unique 24-hexadecimal digit string that identifies the organization.
org_id This property is required. str
Unique 24-hexadecimal digit string that identifies the organization.
orgId This property is required. String
Unique 24-hexadecimal digit string that identifies the organization.

getOrganization Result

The following output properties are available:

ApiAccessListRequired bool
(Optional) Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
GenAiFeaturesEnabled bool
(Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to true. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
Id string
The provider-assigned unique ID for this managed resource.
IsDeleted bool
Flag that indicates whether this organization has been deleted.
Links List<GetOrganizationLink>
MultiFactorAuthRequired bool
(Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
Name string
Human-readable label that identifies the organization.
OrgId string
RestrictEmployeeAccess bool
(Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
ApiAccessListRequired bool
(Optional) Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
GenAiFeaturesEnabled bool
(Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to true. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
Id string
The provider-assigned unique ID for this managed resource.
IsDeleted bool
Flag that indicates whether this organization has been deleted.
Links []GetOrganizationLink
MultiFactorAuthRequired bool
(Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
Name string
Human-readable label that identifies the organization.
OrgId string
RestrictEmployeeAccess bool
(Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
apiAccessListRequired Boolean
(Optional) Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
genAiFeaturesEnabled Boolean
(Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to true. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
id String
The provider-assigned unique ID for this managed resource.
isDeleted Boolean
Flag that indicates whether this organization has been deleted.
links List<GetOrganizationLink>
multiFactorAuthRequired Boolean
(Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
name String
Human-readable label that identifies the organization.
orgId String
restrictEmployeeAccess Boolean
(Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
apiAccessListRequired boolean
(Optional) Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
genAiFeaturesEnabled boolean
(Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to true. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
id string
The provider-assigned unique ID for this managed resource.
isDeleted boolean
Flag that indicates whether this organization has been deleted.
links GetOrganizationLink[]
multiFactorAuthRequired boolean
(Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
name string
Human-readable label that identifies the organization.
orgId string
restrictEmployeeAccess boolean
(Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
api_access_list_required bool
(Optional) Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
gen_ai_features_enabled bool
(Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to true. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
id str
The provider-assigned unique ID for this managed resource.
is_deleted bool
Flag that indicates whether this organization has been deleted.
links Sequence[GetOrganizationLink]
multi_factor_auth_required bool
(Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
name str
Human-readable label that identifies the organization.
org_id str
restrict_employee_access bool
(Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
apiAccessListRequired Boolean
(Optional) Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
genAiFeaturesEnabled Boolean
(Optional) Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and defaults to true. With this setting on, Project Owners may be able to enable or disable individual AI features at the project level. To learn more, see https://www.mongodb.com/docs/generative-ai-faq/.
id String
The provider-assigned unique ID for this managed resource.
isDeleted Boolean
Flag that indicates whether this organization has been deleted.
links List<Property Map>
multiFactorAuthRequired Boolean
(Optional) Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
name String
Human-readable label that identifies the organization.
orgId String
restrictEmployeeAccess Boolean
(Optional) Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.

Supporting Types

Href This property is required. string
Rel This property is required. string
Href This property is required. string
Rel This property is required. string
href This property is required. String
rel This property is required. String
href This property is required. string
rel This property is required. string
href This property is required. str
rel This property is required. str
href This property is required. String
rel This property is required. String

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas