1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getAtlasUsers
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

mongodbatlas.getAtlasUsers

Explore with Pulumi AI

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

    atlas_users provides Atlas Users associated with a specified Organization, Project, or Team.

    NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

    Example Usage

    Using org_id attribute to query Organization Atlas Users

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = mongodbatlas.getAtlasUsers({
        orgId: "<ORG_ID>",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.get_atlas_users(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.LookupAtlasUsers(ctx, &mongodbatlas.LookupAtlasUsersArgs{
    			OrgId: pulumi.StringRef("<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.GetAtlasUsers.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.GetAtlasUsersArgs;
    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.getAtlasUsers(GetAtlasUsersArgs.builder()
                .orgId("<ORG_ID>")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: mongodbatlas:getAtlasUsers
          Arguments:
            orgId: <ORG_ID>
    

    Using project_id attribute to query Project Atlas Users

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = mongodbatlas.getAtlasUsers({
        projectId: "<PROJECT_ID>",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.get_atlas_users(project_id="<PROJECT_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.LookupAtlasUsers(ctx, &mongodbatlas.LookupAtlasUsersArgs{
    			ProjectId: pulumi.StringRef("<PROJECT_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.GetAtlasUsers.Invoke(new()
        {
            ProjectId = "<PROJECT_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.GetAtlasUsersArgs;
    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.getAtlasUsers(GetAtlasUsersArgs.builder()
                .projectId("<PROJECT_ID>")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: mongodbatlas:getAtlasUsers
          Arguments:
            projectId: <PROJECT_ID>
    

    Using team_id and org_id attribute to query Team Atlas Users

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = mongodbatlas.getAtlasUsers({
        orgId: "<ORG_ID>",
        teamId: "<TEAM_ID>",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.get_atlas_users(org_id="<ORG_ID>",
        team_id="<TEAM_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.LookupAtlasUsers(ctx, &mongodbatlas.LookupAtlasUsersArgs{
    			OrgId:  pulumi.StringRef("<ORG_ID>"),
    			TeamId: pulumi.StringRef("<TEAM_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.GetAtlasUsers.Invoke(new()
        {
            OrgId = "<ORG_ID>",
            TeamId = "<TEAM_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.GetAtlasUsersArgs;
    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.getAtlasUsers(GetAtlasUsersArgs.builder()
                .orgId("<ORG_ID>")
                .teamId("<TEAM_ID>")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: mongodbatlas:getAtlasUsers
          Arguments:
            orgId: <ORG_ID>
            teamId: <TEAM_ID>
    

    Using getAtlasUsers

    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 getAtlasUsers(args: GetAtlasUsersArgs, opts?: InvokeOptions): Promise<GetAtlasUsersResult>
    function getAtlasUsersOutput(args: GetAtlasUsersOutputArgs, opts?: InvokeOptions): Output<GetAtlasUsersResult>
    def get_atlas_users(items_per_page: Optional[int] = None,
                        org_id: Optional[str] = None,
                        page_num: Optional[int] = None,
                        project_id: Optional[str] = None,
                        team_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetAtlasUsersResult
    def get_atlas_users_output(items_per_page: Optional[pulumi.Input[int]] = None,
                        org_id: Optional[pulumi.Input[str]] = None,
                        page_num: Optional[pulumi.Input[int]] = None,
                        project_id: Optional[pulumi.Input[str]] = None,
                        team_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetAtlasUsersResult]
    func LookupAtlasUsers(ctx *Context, args *LookupAtlasUsersArgs, opts ...InvokeOption) (*LookupAtlasUsersResult, error)
    func LookupAtlasUsersOutput(ctx *Context, args *LookupAtlasUsersOutputArgs, opts ...InvokeOption) LookupAtlasUsersResultOutput

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

    public static class GetAtlasUsers 
    {
        public static Task<GetAtlasUsersResult> InvokeAsync(GetAtlasUsersArgs args, InvokeOptions? opts = null)
        public static Output<GetAtlasUsersResult> Invoke(GetAtlasUsersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAtlasUsersResult> getAtlasUsers(GetAtlasUsersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: mongodbatlas:index/getAtlasUsers:getAtlasUsers
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ItemsPerPage int

    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.

    IMPORTANT: Either org_id, project_id, or team_id with org_id must be configurated.

    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    PageNum int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies the project whose users you want to return.
    TeamId string
    Unique 24-hexadecimal digit string that identifies the team whose users you want to return.
    ItemsPerPage int

    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.

    IMPORTANT: Either org_id, project_id, or team_id with org_id must be configurated.

    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    PageNum int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies the project whose users you want to return.
    TeamId string
    Unique 24-hexadecimal digit string that identifies the team whose users you want to return.
    itemsPerPage Integer

    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.

    IMPORTANT: Either org_id, project_id, or team_id with org_id must be configurated.

    orgId String
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    pageNum Integer
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    projectId String
    Unique 24-hexadecimal digit string that identifies the project whose users you want to return.
    teamId String
    Unique 24-hexadecimal digit string that identifies the team whose users you want to return.
    itemsPerPage number

    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.

    IMPORTANT: Either org_id, project_id, or team_id with org_id must be configurated.

    orgId string
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    pageNum number
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    projectId string
    Unique 24-hexadecimal digit string that identifies the project whose users you want to return.
    teamId string
    Unique 24-hexadecimal digit string that identifies the team whose users you want to return.
    items_per_page int

    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.

    IMPORTANT: Either org_id, project_id, or team_id with org_id must be configurated.

    org_id str
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    page_num int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    project_id str
    Unique 24-hexadecimal digit string that identifies the project whose users you want to return.
    team_id str
    Unique 24-hexadecimal digit string that identifies the team whose users you want to return.
    itemsPerPage Number

    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.

    IMPORTANT: Either org_id, project_id, or team_id with org_id must be configurated.

    orgId String
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    pageNum Number
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    projectId String
    Unique 24-hexadecimal digit string that identifies the project whose users you want to return.
    teamId String
    Unique 24-hexadecimal digit string that identifies the team whose users you want to return.

    getAtlasUsers Result

    The following output properties are available:

    Id string

    Deprecated: Please use each user's id attribute instead

    Results List<GetAtlasUsersResult>
    A list where each element contains a Atlas User.
    TotalCount int
    Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    ItemsPerPage int
    OrgId string
    PageNum int
    ProjectId string
    TeamId string
    Id string

    Deprecated: Please use each user's id attribute instead

    Results []GetAtlasUsersResult
    A list where each element contains a Atlas User.
    TotalCount int
    Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    ItemsPerPage int
    OrgId string
    PageNum int
    ProjectId string
    TeamId string
    id String

    Deprecated: Please use each user's id attribute instead

    results List<GetAtlasUsersResult>
    A list where each element contains a Atlas User.
    totalCount Integer
    Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage Integer
    orgId String
    pageNum Integer
    projectId String
    teamId String
    id string

    Deprecated: Please use each user's id attribute instead

    results GetAtlasUsersResult[]
    A list where each element contains a Atlas User.
    totalCount number
    Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage number
    orgId string
    pageNum number
    projectId string
    teamId string
    id str

    Deprecated: Please use each user's id attribute instead

    results Sequence[GetAtlasUsersResult]
    A list where each element contains a Atlas User.
    total_count int
    Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    items_per_page int
    org_id str
    page_num int
    project_id str
    team_id str
    id String

    Deprecated: Please use each user's id attribute instead

    results List<Property Map>
    A list where each element contains a Atlas User.
    totalCount Number
    Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage Number
    orgId String
    pageNum Number
    projectId String
    teamId String

    Supporting Types

    GetAtlasUsersResult

    Country string
    Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
    CreatedAt string
    Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
    EmailAddress string
    Email address that belongs to the MongoDB Atlas user.
    FirstName string
    First or given name that belongs to the MongoDB Atlas user.
    Id string
    LastAuth string
    Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
    LastName string
    Last name, family name, or surname that belongs to the MongoDB Atlas user.
    Links List<GetAtlasUsersResultLink>
    MobileNumber string
    Mobile phone number that belongs to the MongoDB Atlas user.
    Roles List<GetAtlasUsersResultRole>
    TeamIds List<string>
    List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Atlas user belongs.

    • links.#.href - Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • links.#.rel - Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • roles.#.group_id - Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
    • roles.#.org_id - Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.
    • roles.#.role_name - Human-readable label that identifies the collection of privileges that MongoDB Atlas grants a specific API key, user, or team. These roles include organization- and project-level roles. The MongoDB Documentation describes the valid roles that can be assigned.
    UserId string
    Unique 24-hexadecimal digit string that identifies this user.
    Username string
    Email address that belongs to the MongoDB Atlas user account. You cannot modify this address after creating the user.
    Country string
    Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
    CreatedAt string
    Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
    EmailAddress string
    Email address that belongs to the MongoDB Atlas user.
    FirstName string
    First or given name that belongs to the MongoDB Atlas user.
    Id string
    LastAuth string
    Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
    LastName string
    Last name, family name, or surname that belongs to the MongoDB Atlas user.
    Links []GetAtlasUsersResultLink
    MobileNumber string
    Mobile phone number that belongs to the MongoDB Atlas user.
    Roles []GetAtlasUsersResultRole
    TeamIds []string
    List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Atlas user belongs.

    • links.#.href - Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • links.#.rel - Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • roles.#.group_id - Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
    • roles.#.org_id - Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.
    • roles.#.role_name - Human-readable label that identifies the collection of privileges that MongoDB Atlas grants a specific API key, user, or team. These roles include organization- and project-level roles. The MongoDB Documentation describes the valid roles that can be assigned.
    UserId string
    Unique 24-hexadecimal digit string that identifies this user.
    Username string
    Email address that belongs to the MongoDB Atlas user account. You cannot modify this address after creating the user.
    country String
    Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
    createdAt String
    Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
    emailAddress String
    Email address that belongs to the MongoDB Atlas user.
    firstName String
    First or given name that belongs to the MongoDB Atlas user.
    id String
    lastAuth String
    Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
    lastName String
    Last name, family name, or surname that belongs to the MongoDB Atlas user.
    links List<GetAtlasUsersResultLink>
    mobileNumber String
    Mobile phone number that belongs to the MongoDB Atlas user.
    roles List<GetAtlasUsersResultRole>
    teamIds List<String>
    List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Atlas user belongs.

    • links.#.href - Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • links.#.rel - Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • roles.#.group_id - Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
    • roles.#.org_id - Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.
    • roles.#.role_name - Human-readable label that identifies the collection of privileges that MongoDB Atlas grants a specific API key, user, or team. These roles include organization- and project-level roles. The MongoDB Documentation describes the valid roles that can be assigned.
    userId String
    Unique 24-hexadecimal digit string that identifies this user.
    username String
    Email address that belongs to the MongoDB Atlas user account. You cannot modify this address after creating the user.
    country string
    Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
    createdAt string
    Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
    emailAddress string
    Email address that belongs to the MongoDB Atlas user.
    firstName string
    First or given name that belongs to the MongoDB Atlas user.
    id string
    lastAuth string
    Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
    lastName string
    Last name, family name, or surname that belongs to the MongoDB Atlas user.
    links GetAtlasUsersResultLink[]
    mobileNumber string
    Mobile phone number that belongs to the MongoDB Atlas user.
    roles GetAtlasUsersResultRole[]
    teamIds string[]
    List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Atlas user belongs.

    • links.#.href - Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • links.#.rel - Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • roles.#.group_id - Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
    • roles.#.org_id - Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.
    • roles.#.role_name - Human-readable label that identifies the collection of privileges that MongoDB Atlas grants a specific API key, user, or team. These roles include organization- and project-level roles. The MongoDB Documentation describes the valid roles that can be assigned.
    userId string
    Unique 24-hexadecimal digit string that identifies this user.
    username string
    Email address that belongs to the MongoDB Atlas user account. You cannot modify this address after creating the user.
    country str
    Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
    created_at str
    Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
    email_address str
    Email address that belongs to the MongoDB Atlas user.
    first_name str
    First or given name that belongs to the MongoDB Atlas user.
    id str
    last_auth str
    Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
    last_name str
    Last name, family name, or surname that belongs to the MongoDB Atlas user.
    links Sequence[GetAtlasUsersResultLink]
    mobile_number str
    Mobile phone number that belongs to the MongoDB Atlas user.
    roles Sequence[GetAtlasUsersResultRole]
    team_ids Sequence[str]
    List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Atlas user belongs.

    • links.#.href - Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • links.#.rel - Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • roles.#.group_id - Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
    • roles.#.org_id - Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.
    • roles.#.role_name - Human-readable label that identifies the collection of privileges that MongoDB Atlas grants a specific API key, user, or team. These roles include organization- and project-level roles. The MongoDB Documentation describes the valid roles that can be assigned.
    user_id str
    Unique 24-hexadecimal digit string that identifies this user.
    username str
    Email address that belongs to the MongoDB Atlas user account. You cannot modify this address after creating the user.
    country String
    Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
    createdAt String
    Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
    emailAddress String
    Email address that belongs to the MongoDB Atlas user.
    firstName String
    First or given name that belongs to the MongoDB Atlas user.
    id String
    lastAuth String
    Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
    lastName String
    Last name, family name, or surname that belongs to the MongoDB Atlas user.
    links List<Property Map>
    mobileNumber String
    Mobile phone number that belongs to the MongoDB Atlas user.
    roles List<Property Map>
    teamIds List<String>
    List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Atlas user belongs.

    • links.#.href - Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • links.#.rel - Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
    • roles.#.group_id - Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
    • roles.#.org_id - Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.
    • roles.#.role_name - Human-readable label that identifies the collection of privileges that MongoDB Atlas grants a specific API key, user, or team. These roles include organization- and project-level roles. The MongoDB Documentation describes the valid roles that can be assigned.
    userId String
    Unique 24-hexadecimal digit string that identifies this user.
    username String
    Email address that belongs to the MongoDB Atlas user account. You cannot modify this address after creating the user.
    Href string
    Rel string
    Href string
    Rel string
    href String
    rel String
    href string
    rel string
    href str
    rel str
    href String
    rel String

    GetAtlasUsersResultRole

    GroupId string
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    RoleName string
    GroupId string
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    RoleName string
    groupId String
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    roleName String
    groupId string
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    roleName string
    group_id str
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    role_name str
    groupId String
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization whose users you want to return. Also needed when team_id attributes is defined.
    roleName 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.14.3 published on Monday, Apr 1, 2024 by Pulumi