Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. MongoDB Atlas
  5. GetDatabaseUser

GetDatabaseUser

mongodbatlas.DatabaseUser describe a Database User. This represents a database user which will be applied to all clusters within the project.

Each user has a set of roles that provide access to the project’s databases. User’s roles apply to all the clusters in the project: if two clusters have a products database and a user has a role granting read access on the products database, the user has that access on both clusters.

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

Using GetDatabaseUser

function getDatabaseUser(args: GetDatabaseUserArgs, opts?: InvokeOptions): Promise<GetDatabaseUserResult>
def get_database_user(auth_database_name: Optional[str] = None, database_name: Optional[str] = None, project_id: Optional[str] = None, username: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetDatabaseUserResult
func LookupDatabaseUser(ctx *Context, args *LookupDatabaseUserArgs, opts ...InvokeOption) (*LookupDatabaseUserResult, error)

Note: This function is named LookupDatabaseUser in the Go SDK.

public static class GetDatabaseUser {
    public static Task<GetDatabaseUserResult> InvokeAsync(GetDatabaseUserArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ProjectId string

The unique ID for the project to create the database user.

Username string

Username for authenticating to MongoDB.

AuthDatabaseName string

The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is almost always the admin database, for X509 it is $external.

DatabaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Deprecated: use auth_database_name instead

ProjectId string

The unique ID for the project to create the database user.

Username string

Username for authenticating to MongoDB.

AuthDatabaseName string

The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is almost always the admin database, for X509 it is $external.

DatabaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Deprecated: use auth_database_name instead

projectId string

The unique ID for the project to create the database user.

username string

Username for authenticating to MongoDB.

authDatabaseName string

The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is almost always the admin database, for X509 it is $external.

databaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Deprecated: use auth_database_name instead

project_id str

The unique ID for the project to create the database user.

username str

Username for authenticating to MongoDB.

auth_database_name str

The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is almost always the admin database, for X509 it is $external.

database_name str

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Deprecated: use auth_database_name instead

GetDatabaseUser Result

The following output properties are available:

AwsIamType string

The new database user authenticates with AWS IAM credentials. Default is NONE, USER means user has AWS IAM user credentials, ROLE - means user has credentials associated with an AWS IAM role.

Id string

The provider-assigned unique ID for this managed resource.

Labels List<GetDatabaseUserLabel>
ProjectId string
Roles List<GetDatabaseUserRole>

List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

Scopes List<GetDatabaseUserScope>

Array of clusters and Atlas Data Lakes that this user has access to.

Username string
X509Type string

X.509 method by which the provided username is authenticated.

AuthDatabaseName string
DatabaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Deprecated: use auth_database_name instead

AwsIamType string

The new database user authenticates with AWS IAM credentials. Default is NONE, USER means user has AWS IAM user credentials, ROLE - means user has credentials associated with an AWS IAM role.

Id string

The provider-assigned unique ID for this managed resource.

Labels []GetDatabaseUserLabel
ProjectId string
Roles []GetDatabaseUserRole

List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

Scopes []GetDatabaseUserScope

Array of clusters and Atlas Data Lakes that this user has access to.

Username string
X509Type string

X.509 method by which the provided username is authenticated.

AuthDatabaseName string
DatabaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Deprecated: use auth_database_name instead

awsIamType string

The new database user authenticates with AWS IAM credentials. Default is NONE, USER means user has AWS IAM user credentials, ROLE - means user has credentials associated with an AWS IAM role.

id string

The provider-assigned unique ID for this managed resource.

labels GetDatabaseUserLabel[]
projectId string
roles GetDatabaseUserRole[]

List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

scopes GetDatabaseUserScope[]

Array of clusters and Atlas Data Lakes that this user has access to.

username string
x509Type string

X.509 method by which the provided username is authenticated.

authDatabaseName string
databaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Deprecated: use auth_database_name instead

aws_iam_type str

The new database user authenticates with AWS IAM credentials. Default is NONE, USER means user has AWS IAM user credentials, ROLE - means user has credentials associated with an AWS IAM role.

id str

The provider-assigned unique ID for this managed resource.

labels Sequence[GetDatabaseUserLabel]
project_id str
roles Sequence[GetDatabaseUserRole]

List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

scopes Sequence[GetDatabaseUserScope]

Array of clusters and Atlas Data Lakes that this user has access to.

username str
x509_type str

X.509 method by which the provided username is authenticated.

auth_database_name str
database_name str

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Deprecated: use auth_database_name instead

Supporting Types

GetDatabaseUserLabel

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Key string

The key that you want to write.

Value string

The value that you want to write.

Key string

The key that you want to write.

Value string

The value that you want to write.

key string

The key that you want to write.

value string

The value that you want to write.

key str

The key that you want to write.

value str

The value that you want to write.

GetDatabaseUserRole

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

CollectionName string

Collection for which the role applies. You can specify a collection for the read and readWrite roles. If you do not specify a collection for read and readWrite, the role applies to all collections in the database (excluding some collections in the system. database).

DatabaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

RoleName string
CollectionName string

Collection for which the role applies. You can specify a collection for the read and readWrite roles. If you do not specify a collection for read and readWrite, the role applies to all collections in the database (excluding some collections in the system. database).

DatabaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

RoleName string
collectionName string

Collection for which the role applies. You can specify a collection for the read and readWrite roles. If you do not specify a collection for read and readWrite, the role applies to all collections in the database (excluding some collections in the system. database).

databaseName string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

roleName string
collection_name str

Collection for which the role applies. You can specify a collection for the read and readWrite roles. If you do not specify a collection for read and readWrite, the role applies to all collections in the database (excluding some collections in the system. database).

database_name str

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

role_name str

GetDatabaseUserScope

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Name string

Name of the role to grant.

Type string

Type of resource that the user has access to. Valid values are: CLUSTER and DATA_LAKE

Name string

Name of the role to grant.

Type string

Type of resource that the user has access to. Valid values are: CLUSTER and DATA_LAKE

name string

Name of the role to grant.

type string

Type of resource that the user has access to. Valid values are: CLUSTER and DATA_LAKE

name str

Name of the role to grant.

type str

Type of resource that the user has access to. Valid values are: CLUSTER and DATA_LAKE

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.