Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /

DatabaseUser Recurso personalizado

Un usuario de base de datos, administrado por el operador Atlas de MongoDB Kubernetes.

Name
Tipo
Descripción
Requerido

apiVersion

string

atlas.generated.mongodb.com/v1

true

kind

string

DatabaseUser

true

metadata

Objeto

Consulta la documentación de Kubernetes API para obtener información sobre los campos del campo metadata.

true

spec

Objeto

Especificación del databaseuser que admite las siguientes versiones:

  • v20250312

Se puede especificar como máximo una versión de spec. Más información: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status validación:

  • (tiene(self.v20250312.``groupId``) && tener(self.``connectionSecretRef``)) || (!has(self.v20250312.``groupId``)): spec.``connectionSecretRef`` debe establecerse si spec.v20250312.``groupId`` está establecido.

false

status

Objeto

La instancia de solo lectura status más recientemente observada del usuario de la base de datos para la versión de recurso especificada. Es posible que estos datos no estén actualizados y que los rellene el sistema. Más información: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

false

Especificación del databaseuser que admite las siguientes versiones:

  • v20250312

Se puede especificar como máximo una especificación versionada. Más información: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
Tipo
Descripción
Requerido

connectionSecretRef

Objeto

SENSITIVE FIELD Referencia a un secreto que contiene las credenciales para configurar la conexión a Atlas.

false

v20250312

Objeto

La especificación del recurso databaseuser para la versión v20250312. validación:

  • (has(self.``groupId``) && !has(self.«groupRef»)) || (! tiene(self.``groupId``) && has(self.``groupRef``)): groupId y groupRef son mutuamente excluyentes; solo uno de ellos puede establecerse

false

CAMPO SENSIBLE

Referencia a un secreto que contiene las credenciales para configurar la conexión a Atlas.

Name
Tipo
Descripción
Requerido

name

string

Nombre del secreto que contiene las credenciales de Atlas.

false

La especificación del recurso databaseuser para la versión v20250312.

Name
Tipo
Descripción
Requerido

entry

Objeto

Los campos entry de la especificación del recurso databaseuser. Estos campos pueden configurarse para crear y actualizar usuarios de base de datos.

false

groupId

string

string exclusiva de 24dígitos hexadecimales que identifica el proyecto. Utiliza el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tenga acceso.

Nota

Grupos y proyectos son términos sinónimos. Tu ID de grupo es el mismo que tu ID del grupo. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los endpoints correspondientes usan el término grupos.

validación:

  • self == oldSelf: groupId no se puede modificar después de la creación

false

groupRef

Objeto

Una referencia a un recurso “Grupo”. El valor de "$.status.v20250312.id" se utilizará para configurar "groupId". Mutuamente excluyente con la propiedad “groupId”.

false

Los campos de entrada de la especificación del recurso databaseuser. Estos campos pueden configurarse para crear y actualizar usuarios de base de datos.

Name
Tipo
Descripción
Requerido

databaseName

string

La base de datos ante la que el usuario de la base de datos se autentica. Los usuarios de base de datos deben proporcionar tanto un nombre de usuario como una base de datos de autenticación para iniciar sesión en MongoDB. Si el usuario se autentica con AWS IAM, x.509, LDAP, o OIDC carga de trabajo, este valor debe ser $external. Si el usuario se autentica con SCRAM-SHA o OIDC Workforce, este valor debe ser admin.

true

roles

[]objeto

Lista que proporciona los emparejamientos de un rol con una base de datos aplicable.

true

username

string

Etiqueta legible por humanos que representa al usuario que se autentica en MongoDB. El formato de esta etiqueta depende del método de autenticación:

Método de autenticación
Parámetro necesario
Valor del parámetro
username Formato

AWS IAM

awsIAMType

ROLE

ARN

AWS IAM

awsIAMType

USER

ARN

X.509

x509Type

CUSTOMER

RFC 2253 nombre distinguido

X.509

x509Type

MANAGED

RFC 2253 nombre distinguido

LDAP

ldapAuthType

USER

RFC 2253 nombre distinguido

LDAP

ldapAuthType

GROUP

RFC 2253 nombre distinguido

OIDC Personal

oidcAuthType

IDP_GROUP

Atlas OIDC IdP ID (se encuentra en la configuración de federación), seguido de una '/', seguido del nombre del grupo IdP

OIDC carga de trabajo

oidcAuthType

USER

Atlas OIDC IdP ID (que se encuentra en la configuración de la federación), seguido de un '/', seguido del nombre de usuario IdP

SCRAM-SHA

awsIAMType, x509Type, ldapAuthType, oidcAuthType

NONE

Alphanumeric string

true

awsIAMType

string

Etiqueta legible por humanos que indica si el nuevo usuario de base de datos se autentica con las credenciales de Amazon Web Services (AWS) Identity and Access gestión (IAM) asociadas con el usuario o el rol del usuario.

false

deleteAfterDate

string

Fecha y hora en que MongoDB nube elimina al usuario. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC y puede incluir la designación de zona horaria. Debes especificar una fecha futura que esté dentro de una semana después de realizar la solicitud de la Interfaz de Programación de Aplicaciones (API).

false

description

string

Descripción de este usuario de base de datos.

false

labels

[]objeto

Lista que contiene los pares clave-valor para etiquetar y categorizar al usuario de base de datos MongoDB. El labels que definiste no aparece en la consola.

false

ldapAuthType

string

Parte del registro del Protocolo Ligero de Acceso a Directorios (LDAP) que la base de datos utiliza para autenticar a este usuario de la base de datos en el host LDAP.

false

oidcAuthType

string

Etiqueta legible por humanos que indica si el nuevo usuario de base de datos o grupo se autentica con la autenticación federada de OIDC. Para crear un usuario de autenticación federada, especifique el valor de USER en este campo. Para crear un grupo de autenticación federada, especifique el valor de IDP_GROUP en este campo.

false

passwordSecretRef

Objeto

SENSITIVE FIELD Referencia a un secreto que contiene datos para el campo "password": Alphanumeric string que autentica a este usuario de la base de datos en la base de datos especificada en databaseName. Para autenticar con SCRAM-SHA, debes especificar este parámetro. Este parámetro no aparece en esta respuesta.

false

scopes

[]objeto

Lista que contiene clústeres, MongoDB Atlas lagos de datos, y MongoDB Atlas Streams Workspaces a los que este usuario de base de datos puede acceder. Si se omite, MongoDB Cloud otorga al usuario de la base de datos acceso a todos los clústeres, MongoDB Atlas Data Lakes y MongoDB Atlas Streams Workspaces en el proyecto.

false

x509Type

string

X.509 método que MongoDB nube utiliza para autenticar al usuario de la base de datos.

  • Para X.509 gestionado por la aplicación, especifica MANAGED.

  • Para X.509 autogestionado, especifica CUSTOMER.

Los usuarios creados con el método CUSTOMER requieren un Nombre Común (CN) en el parámetro nombre de usuario. Debes crear usuarios autenticados externamente en la base de datos $external.

false

Rango de recursos disponibles para este usuario de base de datos.

Name
Tipo
Descripción
Requerido

databaseName

string

Base de datos a la que se conceden al usuario privilegios de acceso.

true

roleName

string

Etiqueta legible por humanos que identifica un grupo de privilegios asignados a un usuario de base de datos. Este valor puede ser un rol predeterminado o un rol personalizado.

true

collectionName

string

Colección sobre la que se aplica este rol.

false

Etiquetas legibles para humanos aplicadas a este componente de MongoDB Cloud.

Name
Tipo
Descripción
Requerido

key

string

Clave aplicada para etiquetar y categorizar este componente.

false

value

string

Valor establecido a la Llave aplicada para etiquetar y categorizar este componente.

false

CAMPO SENSIBLE

Referencia a un secreto que contiene datos para el campo "contraseña":

string alfanumérico que autentica a este usuario de base de datos en la base de datos especificada en databaseName. Para autenticarse con SCRAM-SHA, debes especificar este parámetro. Este parámetro no aparece en esta respuesta.

Name
Tipo
Descripción
Requerido

name

string

Nombre del secreto que contiene el valor del campo confidencial.

true

key

string

Clave de los datos confidenciales que contienen el valor del campo sensible, por defecto es "contraseña". Por defecto: contraseña

false

Rango de recursos disponibles para este usuario de base de datos.

Name
Tipo
Descripción
Requerido

name

string

Etiqueta legible por humanos que identifica el clúster o el MongoDB Atlas Data Lake al que este usuario de base de datos puede acceder.

true

type

string

Categoría de recursos a la que puede acceder este usuario de base de datos.

true

Una referencia a un recurso de "Grupo". El valor de "$.status.v20250312.id" se usará para establecer "groupId". Es mutuamente excluyente con la propiedad "groupId".

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso "Grupo".

false

El estado de solo lectura más recientemente observado del databaseuser para la versión de recurso especificada. Es posible que estos datos no estén actualizados y que los rellene el sistema. Más información: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
Tipo
Descripción
Requerido

conditions

[]objeto

Representa las últimas observaciones disponibles sobre el estado actual de un recurso.

false

v20250312

Objeto

El último estado observado de Atlas del recurso de DatabaseUser para la versión v20250312.

false

Name
Tipo
Descripción
Requerido

status

string

Estado de la condición, uno de True, False, Unknown.

true

type

string

Tipo de condición.

true

lastTransitionTime

string

La última vez que la condición pasó de un estado a otro. Formato: fecha y hora

false

message

string

Un message legible para humanos que indica detalles sobre la transición.

false

observedGeneration

entero

observedGeneration representa la .metadatos.generation en la que se estableció la condición.

false

reason

string

El reason para la última transición de la condición.

false

El último estado observado de Atlas del recurso de DatabaseUser para la versión v20250312.

Name
Tipo
Descripción
Requerido

databaseName

string

La base de datos ante la que el usuario de la base de datos se autentica. Los usuarios de base de datos deben proporcionar tanto un nombre de usuario como una base de datos de autenticación para iniciar sesión en MongoDB. Si el usuario se autentica con AWS IAM, x.509, LDAP, o OIDC carga de trabajo, este valor debe ser $external. Si el usuario se autentica con SCRAM-SHA o OIDC Workforce, este valor debe ser admin.

true

groupId

string

string única de 24 dígitos hexadecimales que identifica el Proyecto.

true

username

string

Etiqueta legible por humanos que representa al usuario que se autentica en MongoDB. El formato de esta etiqueta depende del método de autenticación:

Método de autenticación
Parámetro necesario
Valor del parámetro
username Formato

AWS IAM

awsIAMType

ROLE

ARN

AWS IAM

awsIAMType

USER

ARN

X.509

x509Type

CUSTOMER

RFC 2253 nombre distinguido

X.509

x509Type

MANAGED

RFC 2253 nombre distinguido

LDAP

ldapAuthType

USER

RFC 2253 nombre distinguido

LDAP

ldapAuthType

GROUP

RFC 2253 nombre distinguido

OIDC Personal

oidcAuthType

IDP_GROUP

Atlas OIDC IdP ID (se encuentra en la configuración de federación), seguido de una '/', seguido del nombre del grupo IdP

OIDC carga de trabajo

oidcAuthType

USER

Atlas OIDC IdP ID (que se encuentra en la configuración de la federación), seguido de un '/', seguido del nombre de usuario IdP

SCRAM-SHA

awsIAMType, x509Type, ldapAuthType, oidcAuthType

NONE

Alphanumeric string

true

Volver

FlexCluster

En esta página