Menu Docs
Página inicial do Docs
/ /

DatabaseUser Recurso personalizado

Um utilizador de banco de dados gerenciado pelo Operador do MongoDB Kubernetes Atlas .

Name
Tipo
Descrição
Obrigatório

apiVersion

string

atlas.generated.mongodb.com/v1

true

kind

string

DatabaseUser

true

metadata

objeto

Consulte a documentação do Kubernetes API para os campos do campo metadata.

true

spec

objeto

Especificação do utilizador de banco de dados compatível com as seguintes versões:

  • v20250312

No máximo, uma versão spec pode ser especificada. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Validações:

  • (has(auto.v20250312.``groupId``) && has(auto.``connectionSecretRef``)) || (!has(auto.v20250312.``groupId``): spec.``connectionSecretRef`` deve ser definido se spec.v20250312.``groupId`` estiver definido.

false

status

objeto

somente leitura observado mais recentemente status do databaseuser para a versão do recurso especificado. Esses dados podem não estar atualizados e são preenchidos pelo sistema. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

false

Especificação do utilizador de banco de dados compatível com as seguintes versões:

  • v20250312

No máximo, uma especificação versionada pode ser especificada. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
Tipo
Descrição
Obrigatório

connectionSecretRef

objeto

SENSITIVE FIELD Referência a um segredo contendo as credenciais para configurar a conexão com o Atlas.

false

v20250312

objeto

A especificação do recurso databaseuser para a versão20250312 v. Validações:

  • (has(auto.''groupId'') && !has(auto.''groupRef'')) || (!has(auto.``groupId``) && has(auto.``groupRef``): groupId e groupRef são mutuamente exclusivos; apenas um deles pode ser definido

false

Campo sensível

Referência a um segredo contendo as credenciais para configurar a conexão com o Atlas.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do segredo que contém as credenciais do Atlas .

false

A especificação do recurso databaseuser para a versão v20250312.

Name
Tipo
Descrição
Obrigatório

entry

objeto

Os campos entry da especificação do recurso databaseuser. Estes campos podem ser configurados para criar e atualizar databaseusers.

false

groupId

string

Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para recuperar todos os projetos aos quais o usuário autenticado tem acesso.

Observação

Grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os pontos de extremidade correspondentes usam o termo grupos.

Validações:

  • self == oldSelf: groupId não pode ser modificado após a criação

false

groupRef

objeto

Uma referência a um recurso "Grupo". O valor de "$.status.v20250312.id" será utilizado para definir "groupId". Mutualmente exclusivo com a propriedade"groupId".

false

Os campos de entrada da especificação do recurso databaseuser. Estes campos podem ser configurados para criar e atualizar databaseusers.

Name
Tipo
Descrição
Obrigatório

databaseName

string

O banco de dados no qual o usuário de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para conectar ao MongoDB. Se o usuário se autenticar com AWS IAM, x.509, LDAP ou OIDC Volume de trabalho, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser admin.

true

roles

[] objeto

Lista que fornece os pares de um papel com um banco de dados aplicável.

true

username

string

Etiqueta legível por humanos que representa o usuário que se autentica em MongoDB. O formato desse rótulo depende do método de autenticação:

Método de autenticação
Parâmetro necessário
Valor do parâmetro
username Formatar

AWS IAM

awsIAMType

ROLE

ARN

AWS IAM

awsIAMType

USER

ARN

x.509

x509Type

CUSTOMER

Nome DistintoRFC 2253

x.509

x509Type

MANAGED

Nome DistintoRFC 2253

LDAP

ldapAuthType

USER

Nome DistintoRFC 2253

LDAP

ldapAuthType

GROUP

Nome DistintoRFC 2253

OIDC Força de trabalho

oidcAuthType

IDP_GROUP

Atlas OIDC IdP ID (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP

OIDC Volume de trabalho

oidcAuthType

USER

Atlas OIDC IdP ID (encontrado nas configurações de federação), seguido por uma '/', seguido pelo nome de usuário IdP

SCRAM-SHA

awsIAMType, x509Type, ldapAuthType, oidcAuthType

NONE

Texto alfanumérico

true

awsIAMType

string

Rótulo legível por humanos que indica se o novo usuário de banco de dados se autentica com as credenciais do Amazon Web Services (AWS) Identity and Access Management (IAM) associadas ao usuário ou à função do usuário.

false

deleteAfterDate

string

Data e hora em que o MongoDB Cloud exclui o usuário. Esse parâmetro expressa seu valor no formato de registro de data e hora ISO 8601 em UTC e pode incluir a designação de zona horário. Você deve especificar uma data futura que caia dentro de uma semana após fazer a solicitação da Interface de Programação de Aplicativo (API).

false

description

string

Descrição deste usuário de banco de dados.

false

labels

[] objeto

Lista que contém os pares de valores-chave para marcar e categorizar o usuário de banco de dados MongoDB. O labels que você define não aparece no console.

false

ldapAuthType

string

Parte do registro do Lightweight Directory Access Protocol (LDAP) que o banco de dados usa para autenticar esse usuário de banco de dados no host LDAP.

false

oidcAuthType

string

Etiqueta legível para humanos que indica se o novo usuário de banco de dados ou grupo se autentica com a autenticação federada OIDC. Para criar um usuário de autenticação federado, especifique o valor de USER neste campo. Para criar um grupo de autenticação federado, especifique o valor de IDP_GROUP neste campo.

false

passwordSecretRef

objeto

SENSITIVE FIELD Referência a um segredo contendo dados para o campo"senha" : string alfanumérica que autentica este usuário de banco de dados no banco de dados especificado no databaseName. Para autenticar com SCRAM-SHA, você deve especificar este parâmetro. Este parâmetro não aparece nesta resposta.

false

scopes

[] objeto

Lista que contém clusters, MongoDB Atlas Data Lakes e MongoDB Atlas Streams Workspaces que esse usuário de banco de dados pode acessar. Se omitido, o MongoDB Cloud concede ao usuário de banco de dados acesso a todos os clusters, MongoDB Atlas Data Lakes e MongoDB Atlas Streams Workspaces no projeto.

false

x509Type

string

X.509 método que o MongoDB nuvem usa para autenticar o usuário de banco de dados.

  • Para X.509 gerenciado pelo aplicativo, especifique MANAGED.

  • Para X.509 autogerenciado, especifique CUSTOMER.

Os usuários criados com o CUSTOMER método exigem um Nome ComumCN () no parâmetro username. Você deve criar usuários autenticados externamente no $external banco de dados do.

false

Faixa de recursos disponíveis para esse usuário de banco de dados.

Name
Tipo
Descrição
Obrigatório

databaseName

string

Banco de dados ao qual o usuário recebe privilégios de acesso.

true

roleName

string

Etiqueta legível por humanos que identifica um grupo de privilégios atribuídos a um usuário de banco de dados. Esse valor pode ser uma função integrada ou uma função personalizada.

true

collectionName

string

Collection na qual essa role se aplica.

false

Rótulos legíveis por humanos aplicados a este componente MongoDB Cloud.

Name
Tipo
Descrição
Obrigatório

key

string

Chave aplicada para marcar e categorizar este componente.

false

value

string

Valor definido para a chave aplicada para marcar e categorizar este componente.

false

Campo sensível

Referência a um segredo contendo dados para o campo"senha":

String alfanumérica que autentica este usuário de banco de dados no banco de dados especificado no databaseName. Para autenticar com SCRAM-SHA, você deve especificar este parâmetro. Este parâmetro não aparece nesta resposta.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do segredo que contém o valor do campo sensível.

true

key

string

Chave dos dados secretos contendo o valor de campo sensível, padrão para "senha". Padrão: senha

false

Faixa de recursos disponíveis para esse usuário de banco de dados.

Name
Tipo
Descrição
Obrigatório

name

string

Rótulo legível por humanos que identifica o cluster ou MongoDB Atlas Data Lake que esse usuário de banco de dados pode acessar.

true

type

string

Categoria de recurso que este usuário de banco de dados pode acessar.

true

Uma referência a um recurso "Grupo". O valor de "$.status.v20250312.id" será utilizado para definir "groupId". Mutualmente exclusivo com a propriedade"groupId".

Name
Tipo
Descrição
Obrigatório

name

string

Nome do recurso "Grupo".

false

Status somente leitura observado mais recentemente do utilizador de banco de dados para a versão do recurso especificado. Esses dados podem não estar atualizados e são preenchidos pelo sistema. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
Tipo
Descrição
Obrigatório

conditions

[] objeto

Representa as últimas observações disponíveis do estado atual de um recurso.

false

v20250312

objeto

O último estado do Atlas observado do recurso databaseuser para a versão v20250312.

false

Name
Tipo
Descrição
Obrigatório

status

string

Status da condição, um de verdadeiro, falso, desconhecido.

true

type

string

Tipo de condição.

true

lastTransitionTime

string

Última vez que a condição fez a transição de um status para outro. Formato: data/hora

false

message

string

Um message legível por humanos indicando detalhes sobre a transição.

false

observedGeneration

inteiro

observedGeneration representa o .metadata.generação em que a condição foi definida com base.

false

reason

string

O reason para a última transição da condição.

false

O último estado do Atlas observado do recurso databaseuser para a versão v20250312.

Name
Tipo
Descrição
Obrigatório

databaseName

string

O banco de dados no qual o usuário de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para conectar ao MongoDB. Se o usuário se autenticar com AWS IAM, x.509, LDAP ou OIDC Volume de trabalho, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser admin.

true

groupId

string

String única de 24 dígitos hexadecimais que identifica o projeto.

true

username

string

Etiqueta legível por humanos que representa o usuário que se autentica em MongoDB. O formato desse rótulo depende do método de autenticação:

Método de autenticação
Parâmetro necessário
Valor do parâmetro
username Formatar

AWS IAM

awsIAMType

ROLE

ARN

AWS IAM

awsIAMType

USER

ARN

x.509

x509Type

CUSTOMER

Nome DistintoRFC 2253

x.509

x509Type

MANAGED

Nome DistintoRFC 2253

LDAP

ldapAuthType

USER

Nome DistintoRFC 2253

LDAP

ldapAuthType

GROUP

Nome DistintoRFC 2253

OIDC Força de trabalho

oidcAuthType

IDP_GROUP

Atlas OIDC IdP ID (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP

OIDC Volume de trabalho

oidcAuthType

USER

Atlas OIDC IdP ID (encontrado nas configurações de federação), seguido por uma '/', seguido pelo nome de usuário IdP

SCRAM-SHA

awsIAMType, x509Type, ldapAuthType, oidcAuthType

NONE

Texto alfanumérico

true

Voltar

FlexCluster

Nesta página