Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. Organization
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.Organization

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    # Resource: mongodbatlas.Organization

    mongodbatlas.Organization provides programmatic management (including creation) of a MongoDB Atlas Organization resource.

    IMPORTANT NOTE: When you establish an Atlas organization using this resource, it automatically generates a set of initial public and private Programmatic API Keys. These key values are vital to store because you’ll need to use them to grant access to the newly created Atlas organization. To use this resource, role_names for new API Key must have the ORG_OWNER role specified.

    IMPORTANT NOTE: To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key’s organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation.

    NOTE Import command is currently not supported for this resource.

    Example Usage

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

const test = new mongodbatlas.Organization("test", {
    orgOwnerId: "6205e5fffff79cde6f",
    name: "testCreateORG",
    description: "test API key from Org Creation Test",
    roleNames: ["ORG_OWNER"],
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Organization("test",
    org_owner_id="6205e5fffff79cde6f",
    name="testCreateORG",
    description="test API key from Org Creation Test",
    role_names=["ORG_OWNER"])

    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.NewOrganization(ctx, "test", &mongodbatlas.OrganizationArgs{
			OrgOwnerId:  pulumi.String("6205e5fffff79cde6f"),
			Name:        pulumi.String("testCreateORG"),
			Description: pulumi.String("test API key from Org Creation Test"),
			RoleNames: pulumi.StringArray{
				pulumi.String("ORG_OWNER"),
			},
		})
		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 = new Mongodbatlas.Organization("test", new()
    {
        OrgOwnerId = "6205e5fffff79cde6f",
        Name = "testCreateORG",
        Description = "test API key from Org Creation Test",
        RoleNames = new[]
        {
            "ORG_OWNER",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Organization;
import com.pulumi.mongodbatlas.OrganizationArgs;
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) {
        var test = new Organization("test", OrganizationArgs.builder()
            .orgOwnerId("6205e5fffff79cde6f")
            .name("testCreateORG")
            .description("test API key from Org Creation Test")
            .roleNames("ORG_OWNER")
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:Organization
    properties:
      orgOwnerId: 6205e5fffff79cde6f
      name: testCreateORG
      description: test API key from Org Creation Test
      roleNames:
        - ORG_OWNER

    Create Organization Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Organization(name: string, args: OrganizationArgs, opts?: CustomResourceOptions);
    @overload
def Organization(resource_name: str,
                 args: OrganizationArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Organization(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 description: Optional[str] = None,
                 org_owner_id: Optional[str] = None,
                 role_names: Optional[Sequence[str]] = None,
                 api_access_list_required: Optional[bool] = None,
                 federation_settings_id: Optional[str] = None,
                 multi_factor_auth_required: Optional[bool] = None,
                 name: Optional[str] = None,
                 restrict_employee_access: Optional[bool] = None)
    func NewOrganization(ctx *Context, name string, args OrganizationArgs, opts ...ResourceOption) (*Organization, error)
    public Organization(string name, OrganizationArgs args, CustomResourceOptions? opts = null)
    public Organization(String name, OrganizationArgs args)
public Organization(String name, OrganizationArgs args, CustomResourceOptions options)

    type: mongodbatlas:Organization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var organizationResource = new Mongodbatlas.Organization("organizationResource", new()
{
    Description = "string",
    OrgOwnerId = "string",
    RoleNames = new[]
    {
        "string",
    },
    ApiAccessListRequired = false,
    FederationSettingsId = "string",
    MultiFactorAuthRequired = false,
    Name = "string",
    RestrictEmployeeAccess = false,
});

    example, err := mongodbatlas.NewOrganization(ctx, "organizationResource", &mongodbatlas.OrganizationArgs{
	Description: pulumi.String("string"),
	OrgOwnerId:  pulumi.String("string"),
	RoleNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiAccessListRequired:   pulumi.Bool(false),
	FederationSettingsId:    pulumi.String("string"),
	MultiFactorAuthRequired: pulumi.Bool(false),
	Name:                    pulumi.String("string"),
	RestrictEmployeeAccess:  pulumi.Bool(false),
})

    var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()
    .description("string")
    .orgOwnerId("string")
    .roleNames("string")
    .apiAccessListRequired(false)
    .federationSettingsId("string")
    .multiFactorAuthRequired(false)
    .name("string")
    .restrictEmployeeAccess(false)
    .build());

    organization_resource = mongodbatlas.Organization("organizationResource",
    description="string",
    org_owner_id="string",
    role_names=["string"],
    api_access_list_required=False,
    federation_settings_id="string",
    multi_factor_auth_required=False,
    name="string",
    restrict_employee_access=False)

    const organizationResource = new mongodbatlas.Organization("organizationResource", {
    description: "string",
    orgOwnerId: "string",
    roleNames: ["string"],
    apiAccessListRequired: false,
    federationSettingsId: "string",
    multiFactorAuthRequired: false,
    name: "string",
    restrictEmployeeAccess: false,
});

    type: mongodbatlas:Organization
properties:
    apiAccessListRequired: false
    description: string
    federationSettingsId: string
    multiFactorAuthRequired: false
    name: string
    orgOwnerId: string
    restrictEmployeeAccess: false
    roleNames:
        - string

    Organization Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Organization resource accepts the following input properties:

    Description string
    OrgOwnerId string
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    RoleNames List<string>
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    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.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    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/.
    Description string
    OrgOwnerId string
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    RoleNames []string
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    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.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    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/.
    description String
    orgOwnerId String
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    roleNames List<String>
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    apiAccessListRequired Boolean
    Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    multiFactorAuthRequired Boolean
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    restrictEmployeeAccess Boolean
    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/.
    description string
    orgOwnerId string
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    roleNames string[]
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    apiAccessListRequired boolean
    Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
    federationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    multiFactorAuthRequired boolean
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    restrictEmployeeAccess boolean
    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/.
    description str
    org_owner_id str
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    role_names Sequence[str]
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    api_access_list_required 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.
    federation_settings_id str
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    multi_factor_auth_required 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 str
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    restrict_employee_access 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/.
    description String
    orgOwnerId String
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    roleNames List<String>
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    apiAccessListRequired Boolean
    Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    multiFactorAuthRequired Boolean
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    restrictEmployeeAccess Boolean
    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/.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Organization resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    The organization id.
    PrivateKey string
    PublicKey string
    Public API key value set for the specified organization API key.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    The organization id.
    PrivateKey string
    PublicKey string
    Public API key value set for the specified organization API key.
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    The organization id.
    privateKey String
    publicKey String
    Public API key value set for the specified organization API key.
    id string
    The provider-assigned unique ID for this managed resource.
    orgId string
    The organization id.
    privateKey string
    publicKey string
    Public API key value set for the specified organization API key.
    id str
    The provider-assigned unique ID for this managed resource.
    org_id str
    The organization id.
    private_key str
    public_key str
    Public API key value set for the specified organization API key.
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    The organization id.
    privateKey String
    publicKey String
    Public API key value set for the specified organization API key.

    Look up Existing Organization Resource

    Get an existing Organization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OrganizationState, opts?: CustomResourceOptions): Organization
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_access_list_required: Optional[bool] = None,
        description: Optional[str] = None,
        federation_settings_id: Optional[str] = None,
        multi_factor_auth_required: Optional[bool] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        org_owner_id: Optional[str] = None,
        private_key: Optional[str] = None,
        public_key: Optional[str] = None,
        restrict_employee_access: Optional[bool] = None,
        role_names: Optional[Sequence[str]] = None) -> Organization
    func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)
    public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)
    public static Organization get(String name, Output<String> id, OrganizationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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.
    Description string
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    OrgId string
    The organization id.
    OrgOwnerId string
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    PrivateKey string
    PublicKey string
    Public API key value set for the specified organization API key.
    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/.
    RoleNames List<string>
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    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.
    Description string
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    OrgId string
    The organization id.
    OrgOwnerId string
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    PrivateKey string
    PublicKey string
    Public API key value set for the specified organization API key.
    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/.
    RoleNames []string
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    apiAccessListRequired Boolean
    Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
    description String
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    multiFactorAuthRequired Boolean
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    orgId String
    The organization id.
    orgOwnerId String
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    privateKey String
    publicKey String
    Public API key value set for the specified organization API key.
    restrictEmployeeAccess Boolean
    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/.
    roleNames List<String>
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    apiAccessListRequired boolean
    Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
    description string
    federationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    multiFactorAuthRequired boolean
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    orgId string
    The organization id.
    orgOwnerId string
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    privateKey string
    publicKey string
    Public API key value set for the specified organization API key.
    restrictEmployeeAccess boolean
    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/.
    roleNames string[]
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    api_access_list_required 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.
    description str
    federation_settings_id str
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    multi_factor_auth_required 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 str
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    org_id str
    The organization id.
    org_owner_id str
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    private_key str
    public_key str
    Public API key value set for the specified organization API key.
    restrict_employee_access 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/.
    role_names Sequence[str]
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.
    apiAccessListRequired Boolean
    Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
    description String
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
    multiFactorAuthRequired Boolean
    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
    The name of the organization you want to create. (Cannot be changed via this Provider after creation.)
    orgId String
    The organization id.
    orgOwnerId String
    Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. MongoDB Atlas Admin API - Get User By Username
    privateKey String
    publicKey String
    Public API key value set for the specified organization API key.
    restrictEmployeeAccess Boolean
    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/.
    roleNames List<String>
    List of Organization roles that the Programmatic API key needs to have. Ensure that you provide at least one role and ensure all roles are valid for the Organization. You must specify an array even if you are only associating a single role with the Programmatic API key. The MongoDB Documentation describes the roles that you can assign to a Programmatic API key.

    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.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas