Obter todos os usuários da organização
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 .
URL base: https://cloud.mongodb.com/api/public/v1.0
Sintaxe
GET /orgs/{ORG-ID}/users
Parâmetros do caminho da solicitação
Parâmetro | Obrigatório/Opcional | Descrição |
|---|---|---|
ORG-ID | Obrigatório. | O identificador exclusivo da organização cujas informações de usuário você deseja recuperar. |
Solicitar parâmetros de query
Campo | Obrigatório/Opcional | Descrição |
|---|---|---|
pageNum | Opcional. | A página a ser retornada. Padrão é |
itemsPerPage | Opcional. | Número de itens a serem devolvidos por página, até um máximo de 500. Padrão é |
envelope | Opcional. | Um booleano que especifica se deseja ou não envolver a resposta em um envelope. Padrão é |
pretty | Opcional | Um booleano que especifica se deseja ou não retornar um JSON document "bem impresso". Padrão é |
Elementos de resposta
Se você definir o elemento de query envelope como true, a resposta será envolvida pelo objeto content .
A resposta HTTP retorna um JSON document que inclui os seguintes objeto:
results
Um array de documentos, cada um representando um usuário da organização.
Nome | Descrição | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
country | O país onde o usuário vive. | ||||||||||||||
emailAddress | O endereço de e-mail do usuário. | ||||||||||||||
firstName | O nome do usuário. | ||||||||||||||
lastName | ID do projeto do Cloud Manager ao qual o usuário pertence. | ||||||||||||||
id | O ID do usuário. | ||||||||||||||
links | Um ou mais links para sub-recursos e/ou recursos relacionados. | ||||||||||||||
mobileNumber | O número de telefone celular do usuário. | ||||||||||||||
username | O nome de usuário para autenticar no MongoDB. | ||||||||||||||
roles | Uma array das roles do usuário dentro da organização e para cada projeto ao qual o usuário pertence. | ||||||||||||||
roles.{ENTITY-ID} | O {ENTITY-ID} representa a organização ou projeto ao qual esta função se aplica. Os valores possíveis são: orgId ou groupId. | ||||||||||||||
roles.roleName | O nome da função. O recurso
| ||||||||||||||
teamIds | Uma array das IDs de equipe da organização. |
links
Uma array de documentos, representando um link para um ou mais sub-recursos e/ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações.
totalCount
O número total de itens no conjunto de resultados. Esse valor pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.
Exemplo de solicitação
Solicitar
curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/public/v1.0/orgs/59db8d1d87d9d6420df0613f/users?pretty=true"
Resposta
{ "links" : [ ... ], "results" : [ { "country": "US", "emailAddress": "someone@example.com", "firstName": "John", "id": "59db8d1d87d9d6420df0613a", "lastName": "Smith", "links": [ ... ], "mobileNumber": "123-456-7890", "roles": [{ "groupId": "59ea02e087d9d636b587a967", "roleName": "GROUP_OWNER" }, { "groupId": "59db8d1d87d9d6420df70902", "roleName": "GROUP_OWNER" }, { "orgId": "59db8d1d87d9d6420df0613f", "roleName": "ORG_OWNER" }], "teamIds" : [ "5aeeed020bd6ef9d00033291", "5ac2aeadcabceef96172be31" ], "username": "someone@example.com" }, ... ], "totalCount" : 2 }