Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Projetos e usuários
/
Usuários

Criar o primeiro usuário

Nesta página

  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Crie o primeiro usuário do MongoDB Ops Manager . Você pode chamar esse endpoint sem ter uma chave deAPI .

Importante

Exceções

OMongoDB Ops Manager concede à primeira chave MongoDB Ops Manager de programática API do criada por meio desse endpoint a função GLOBAL_OWNER . O documento JSON retornado inclui a primeira chave de API programática, que você pode usar para fazer outras chamadas de API .

Este endpoint não cria projetos ou organizações. Com a nova chave de API programática que ele criou, você pode chamar o endpoint Criar um projeto . Esse endpoint pode criar um projeto e uma organização em uma chamada de API . Você não pode fazer login no MongoDB Ops Manager até depois de criar um projeto.

Você pode usar esse endpoint para criar usuários adicionais com as seguintes ressalvas:

  • O MongoDB Ops Manager não concede a role GLOBAL_OWNER para esses usuários subsequentes, a menos que você adicione a role à solicitação de API .

  • MongoDB Ops Manager não cria uma chave de API programática para usuários subsequentes.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

POST /unauth/users

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Solicitar parâmetros de query

Nome
Tipo
Descrição

accessList

string

Endereço IP que você deseja adicionar à lista de acesso do primeiro usuário do MongoDB Ops Manager .

Você pode adicionar mais de um parâmetro e valor de accessList .

Parâmetros do corpo da solicitação

Nome
Tipo
necessidade
Descrição

username

string

Obrigatório

Nome de usuário do primeiro usuário do MongoDB Ops Manager . Validado dependendo do valor da propriedade mms.email.validation :

Valor
Descrição

false

(Padrão) Não é necessário que o nome de usuário seja um endereço de e-mail.

loose

O nome de usuário deve conter um símbolo @ seguido de um ponto.

strict

O nome de usuário deve aderir a uma expressão regular rigorosa de validação de endereço de e-mail.

Consulte mms.email.validation para obter detalhes.

O username geralmente é um endereço de e-mail. Se você definir esse valor para um endereço de e-mail, não precisará definir o valor emailAddress explicitamente.

password

string

Obrigatório

Senha do primeiro usuário do MongoDB Ops Manager . Este campo não está incluído no corpo da resposta HTTP . O MongoDB Ops Manager envia isso na solicitação HTTP somente ao criar o primeiro usuário do MongoDB Ops Manager .

emailAddress

string

Opcional

Endereço de e-mail do primeiro usuário do MongoDB Ops Manager .

firstName

string

Obrigatório

Nome do primeiro usuário do MongoDB Ops Manager .

lastName

string

Obrigatório

Sobrenome do primeiro usuário do MongoDB Ops Manager .

Resposta

Nome
Tipo
Descrição

programmaticApiKey

objeto

Detalhes da primeira chave de API programática criada no MongoDB Ops Manager.

programmaticApiKey
.desc

string

Descrição da primeira chave de API programática.

programmaticApiKey
.id

string

Identificador exclusivo da primeira chave de API programática.

programmaticApiKey
.links

Array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

programmaticApiKey
.privateKey

string

Trinta e um caracteres alfanuméricos e traços que servem como a senha da primeira chave de API programática.

programmaticApiKey
.publicKey

string

seis caracteres alfanuméricos que servem como o nome de usuário da primeira chave de API programática.

programmaticApiKey
.roles

Array de objetos

Roles atribuídos à primeira chave de API programática.

programmaticApiKey
.roles.roleName

string

Nome do role atribuído. O MongoDB Ops Manager concede à primeira chave de API programática a função Global Owner (GLOBAL_OWNER).

user

objeto

Detalhes do primeiro usuário do MongoDB Ops Manager .

user
.emailAddress

string

Endereço de e-mail do primeiro usuário do MongoDB Ops Manager .

user
.firstName

string

Nome do primeiro usuário do MongoDB Ops Manager .

user
.id

string

Identificador exclusivo do primeiro usuário do MongoDB Ops Manager .

user
.lastName

string

Sobrenome do primeiro usuário do MongoDB Ops Manager .

user
.links

Array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

user
.mobileNumber

string

Número de celular do primeiro usuário do MongoDB Ops Manager .

user
.roles

Array de objetos

Roles atribuídos ao primeiro usuário do MongoDB Ops Manager .

user
.roles.roleName

string

Nome do role atribuído. O MongoDB Ops Manager concede ao primeiro usuário do MongoDB Ops Manager a função Global Owner (GLOBAL_OWNER).

user
.teamIds

array de strings

Lista de identificadores exclusivos para as equipes às quais o primeiro usuário do MongoDB Ops Manager pertence.

user
.username

string

Nome de usuário do primeiro usuário do MongoDB Ops Manager .

Exemplo de solicitação

curl --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/unauth/users?pretty=true&accessList=1.2.3.4&accessList=2.3.4.5" \
     --data '
       {
         "username": "jane.doe@example.com",
         "password": "Passw0rd.",
         "firstName": "Jane",
         "lastName": "Doe"
       }'

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

{
  "programmaticApiKey": {
    "desc": "Automatically generated Global API key",
    "id": "{API-KEY}",
    "links": [{
      "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY}",
      "rel": "self"
    }],
    "privateKey": "private key string",
    "publicKey": "public key string",
    "roles": [{
      "roleName": "GLOBAL_OWNER"
    }]
  },
  "user": {
    "emailAddress": "jane.doe@example.com",
    "firstName": "Jane",
    "id": "{USER-ID}",
    "lastName": "Doe",
    "links": [
      {
       "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}",
       "rel" : "self"
      }
    ],
    "roles": [
      {
        "roleName": "GLOBAL_OWNER"
      }
    ],
    "username": "jane.doe@example.com"
  }
}

Voltar

Atualizar funções

Próximo

Excluir