Criar um usuário
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
Observação
Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.
Criar um novo usuário. Por padrão, qualquer organização não global e roles de projeto na carga útil enviam aos usuários um convite para a organização ou projeto primeiro.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
POST /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
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. |
| ||||||
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo da solicitação
Todos os campos são obrigatórios.
Nome | Tipo | Descrição | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nome de usuário | string | Nome de usuário do usuário do Cloud Manager . Deve ser um endereço de e-mail válido. | ||||||||||||||||||||||||||||||||||
Senha | string | Senha do usuário do Cloud Manager . Este campo não está incluído na entidade retornada do servidor. Ele pode ser enviado somente no corpo da entidade quando você cria um novo usuário. | ||||||||||||||||||||||||||||||||||
emailAddress | string | Endereço de e-mail do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||||||
mobileNumber | string | Número de telefone celular do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||||||
Nome | string | Nome do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||||||
Sobrenome | string | Sobrenome do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||||||
País | string | País principal onde o usuário do Cloud Manager está baseado. Deve corresponder a um ISO 3661de duas letras1 - código do país. | ||||||||||||||||||||||||||||||||||
roles | array de objetos | Atribuições de funções do usuário do Cloud Manager . | ||||||||||||||||||||||||||||||||||
roles.orgId | string | Identificador exclusivo da organização na qual o usuário do Cloud Manager tem a função especificada. | ||||||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único do grupo no qual o usuário do Cloud Manager tem a função especificada. | ||||||||||||||||||||||||||||||||||
roles.roleName | string | Nome da função. Os valores aceitos são:
|
Resposta
O documento JSON contém cada um dos seguintes elementos:
Name | Tipo | Descrição | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Endereço de e-mail do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Nome do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Identificador exclusivo do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Sobrenome do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||
| array de objetos | Links para sub-recursos relacionados. Todas as arrays | ||||||||||||||||||||||||||||||
| string | Número de celular do usuário do Cloud Manager. | ||||||||||||||||||||||||||||||
| Array vazia | Função atribuída ao usuário do Cloud Manager . | ||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único do projeto no qual o usuário tem o papel especificado. | ||||||||||||||||||||||||||||||
roles.orgId | string | Identificador único para a organização na qual o usuário tem o papel especificado. | ||||||||||||||||||||||||||||||
roles.roleName | string | Nome da função. O recurso Os valores aceitos são:
| ||||||||||||||||||||||||||||||
| string | Nome de usuário do usuário do Cloud Manager. |
Exemplo de solicitação
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request POST "https://cloud.mongodb.com/api/public/v1.0/users" \ 6 --data ' 7 { 8 "username": "jane.doe@mongodb.com", 9 "emailAddress": "jane.doe@mongodb.com", 10 "firstName": "Jane", 11 "lastName": "Doe", 12 "password": "M0ng0D8!:)", 13 "country" : "US", 14 "roles": [{ 15 "groupId": "533daa30879bb2da07807696", 16 "roleName": "GROUP_USER_ADMIN" 17 },{ 18 "orgId" : "55555bbe3bd5253aea2d9b16", 19 "roleName" : "ORG_MEMBER" 20 }] 21 }'
Exemplo de resposta
Cabeçalho de resposta
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
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
{ "id" : "533dc19ce4b00835ff81e2eb", "username" : "jane.doe@mongodb.com", "emailAddress" : "jane.doe@mongodb.com", "firstName" : "Jane", "lastName" : "Doe", "roles" : [], "links" : [] }