MongoDB Atlas v3.14.3, Apr 1 24

MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

mongodbatlas.getOrganizations

Explore with Pulumi AI

MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

Example Usage

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

const test = mongodbatlas.getOrganizations({
    itemsPerPage: 5,
    pageNum: 1,
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_organizations(items_per_page=5,
    page_num=1)

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.LookupOrganizations(ctx, &mongodbatlas.LookupOrganizationsArgs{
			ItemsPerPage: pulumi.IntRef(5),
			PageNum:      pulumi.IntRef(1),
		}, 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.GetOrganizations.Invoke(new()
    {
        ItemsPerPage = 5,
        PageNum = 1,
    });

});

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.GetOrganizationsArgs;
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.getOrganizations(GetOrganizationsArgs.builder()
            .itemsPerPage(5)
            .pageNum(1)
            .build());

    }
}

variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getOrganizations
      Arguments:
        itemsPerPage: 5
        pageNum: 1

Using getOrganizations

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 getOrganizations(args: GetOrganizationsArgs, opts?: InvokeOptions): Promise<GetOrganizationsResult>
function getOrganizationsOutput(args: GetOrganizationsOutputArgs, opts?: InvokeOptions): Output<GetOrganizationsResult>

def get_organizations(include_deleted_orgs: Optional[bool] = None,
                      items_per_page: Optional[int] = None,
                      name: Optional[str] = None,
                      page_num: Optional[int] = None,
                      opts: Optional[InvokeOptions] = None) -> GetOrganizationsResult
def get_organizations_output(include_deleted_orgs: Optional[pulumi.Input[bool]] = None,
                      items_per_page: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      page_num: Optional[pulumi.Input[int]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationsResult]

func LookupOrganizations(ctx *Context, args *LookupOrganizationsArgs, opts ...InvokeOption) (*LookupOrganizationsResult, error)
func LookupOrganizationsOutput(ctx *Context, args *LookupOrganizationsOutputArgs, opts ...InvokeOption) LookupOrganizationsResultOutput

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

public static class GetOrganizations 
{
    public static Task<GetOrganizationsResult> InvokeAsync(GetOrganizationsArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationsResult> Invoke(GetOrganizationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrganizationsResult> getOrganizations(GetOrganizationsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

IncludeDeletedOrgs bool: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
Name string: Human-readable label that identifies the organization.
PageNum int: The page to return. Defaults to 1.

IncludeDeletedOrgs bool: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
Name string: Human-readable label that identifies the organization.
PageNum int: The page to return. Defaults to 1.

includeDeletedOrgs Boolean: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
itemsPerPage Integer: Number of items to return per page, up to a maximum of 500. Defaults to 100.
name String: Human-readable label that identifies the organization.
pageNum Integer: The page to return. Defaults to 1.

includeDeletedOrgs boolean: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
itemsPerPage number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
name string: Human-readable label that identifies the organization.
pageNum number: The page to return. Defaults to 1.

include_deleted_orgs bool: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
items_per_page int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
name str: Human-readable label that identifies the organization.
page_num int: The page to return. Defaults to 1.

includeDeletedOrgs Boolean: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
itemsPerPage Number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
name String: Human-readable label that identifies the organization.
pageNum Number: The page to return. Defaults to 1.

getOrganizations Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Results List<GetOrganizationsResult>
TotalCount int
IncludeDeletedOrgs bool: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
ItemsPerPage int
Name string
PageNum int

Id string: The provider-assigned unique ID for this managed resource.
Results []GetOrganizationsResult
TotalCount int
IncludeDeletedOrgs bool: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
ItemsPerPage int
Name string
PageNum int

id String: The provider-assigned unique ID for this managed resource.
results List<GetOrganizationsResult>
totalCount Integer
includeDeletedOrgs Boolean: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
itemsPerPage Integer
name String
pageNum Integer

id string: The provider-assigned unique ID for this managed resource.
results GetOrganizationsResult[]
totalCount number
includeDeletedOrgs boolean: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
itemsPerPage number
name string
pageNum number

id str: The provider-assigned unique ID for this managed resource.
results Sequence[GetOrganizationsResult]
total_count int
include_deleted_orgs bool: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
items_per_page int
name str
page_num int

id String: The provider-assigned unique ID for this managed resource.
results List<Property Map>
totalCount Number
includeDeletedOrgs Boolean: Deprecated: this parameter is deprecated and will be removed in version 1.16.0
itemsPerPage Number
name String
pageNum Number

Supporting Types

GetOrganizationsResult

ApiAccessListRequired bool

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

Autogenerated Unique ID for this data source.

IsDeleted bool

Flag that indicates whether this organization has been deleted.

Links List<GetOrganizationsResultLink>

MultiFactorAuthRequired bool

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.

RestrictEmployeeAccess bool

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/.

See MongoDB Atlas API - Organizations Documentation for more information.