Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getOrganization
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getOrganization

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    mongodbatlas.Organization describe 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>",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_organization(org_id="<org_id>")

    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
	})
}

    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>",
    });

});

    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());

    }
}

    variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getOrganization
      Arguments:
        orgId: <org_id>

    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>
    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]
    func LookupOrganization(ctx *Context, args *LookupOrganizationArgs, opts ...InvokeOption) (*LookupOrganizationResult, error)
func LookupOrganizationOutput(ctx *Context, args *LookupOrganizationOutputArgs, opts ...InvokeOption) LookupOrganizationResultOutput

    > 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)
}
    public static CompletableFuture<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: mongodbatlas:index/getOrganization:getOrganization
  arguments:
    # arguments dictionary

    The following arguments are supported:

    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization.
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization.
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization.
    orgId 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.
    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.
    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.
    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.
    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.
    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.
    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 string
    Rel string
    Href string
    Rel string
    href String
    rel String
    href string
    rel string
    href str
    rel str
    href String
    rel String

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas