Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos da API de administração do Cloud Manager
/
Organizações e equipes
/
Equipes

Adicionar usuários à equipe

Nesta página

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

URL base: https://cloud.mongodb.com/api/public/v1.0

Sintaxe

POST /orgs/{ORG-ID}/teams/{TEAM-ID}/users

Parâmetros do caminho da solicitação

Elemento do caminho
Obrigatório/Opcional
Descrição
ORG-ID
Obrigatório.
O identificador exclusivo daorganização à qual você deseja associar a equipe.
TEAM-ID
Obrigatório
O nome da equipe à qual você deseja adicionar usuários.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
default
pretty
booleano
Opcional
false
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:

Nome
Descrição
status
Código de resposta HTTP
content
Corpo de resposta esperado
false

Parâmetros do corpo da solicitação

Especifique uma matriz de documentos, onde cada documento representa um usuário que você deseja adicionar à equipe. Cada documento na array deve conter os seguintes campos:

Nome
Tipo
Descrição
id
string
O ID exclusivo do usuário que você deseja adicionar à equipe

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição
results
array
A array inclui um objeto para cada item detalhado na seção Documento incorporadoresults .
links
array
A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
totalCount
número
Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

Cada elemento na array result é um usuário adicionado à equipe.

Nome
Tipo
Descrição
country
string
O ISO 3166 Alpha-2 código de país associado ao usuário.
emailAddress
string
O endereço de e-mail associado ao usuário.
firstName
string
O primeiro nome do usuário.
id
string
O identificador exclusivo da equipe.
lastName
string
O sobrenome do usuário.
links
array

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.

mobileNumber
string
O número de telefone associado ao usuário.
roles
array
Cada objeto na matriz roles representa o papel da organização MongoDB Atlas que o usuário tem para o org_idassociado
roles.orgId
string
ID da organização onde o usuário tem o role de organização roles.roleName atribuído.
roles.roleName
string
O papel da organização atribuído ao usuário para o roles.orgId especificado.
teamsId
array
Cada string na array é uma equipe associada ao usuário.
username
string
Nome de usuário associado ao usuário.

Exemplo de solicitação

curl -u "username:apiKey" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users? pretty=true" \
     --data '[{ "id" : "{USER-ID}" }]'

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 200 OK
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

{
 "links": [
     {
      "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true",
      "rel": "self"
     }
 ],
 "results": [
     {
      "country": "US",
      "emailAddress": "JohnDoe@example.com",
      "firstName": "John",
      "id": "{USER-ID}",
      "lastName": "Doe",
      "links": [
          {
              "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
              "rel": "self"
          }
      ],
      "mobileNumber": "5555550100",
      "roles": [
          {
              "orgId": "{ORG-ID}",
              "roleName": "ORG_MEMBER"
          },
          ...
      ],
      "teamIds": [ "{TEAM-ID}" ],
      "username": "JohnDoe@example.com"
     }
 ],
 "totalCount": 1
}

Voltar

Atualizar roles de equipe em um projeto