Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

Obter todos os usuários da organização

Nesta página

  • Sintaxe
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Elementos de resposta
  • Exemplo de solicitação
  • Solicitar
  • Resposta

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

GET /orgs/{ORG-ID}/users
Parâmetro
Obrigatório/Opcional
Descrição
ORG-ID
Obrigatório.
O identificador exclusivo daorganização cujas informações de usuário você deseja recuperar.
Campo
Obrigatório/Opcional
Descrição
pageNum
Opcional.

A página a ser retornada.

Padrão é 1.

itemsPerPage
Opcional.

Número de itens a serem devolvidos por página, até um máximo de 500.

Padrão é 100.

envelope
Opcional.

Um booleano que especifica se deseja ou não envolver a resposta em um envelope.

Padrão é false.

pretty
Opcional

Um booleano que especifica se deseja ou não retornar um JSON document "bem impresso".

Padrão é false.

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:

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 MongoDB Ops 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 users retorna todos os papéis que o usuário tem no MongoDB Ops Manager ou MongoDB Atlas. Os valores possíveis são:

  • Roles da organização

    Valor da função na API
    Função
    ORG_OWNER
    ORG_MEMBER
    ORG_GROUP_CREATOR
    ORG_READ_ONLY
  • Roles do projeto

    Grupos e projetos são termos sinônimos.

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

teamIds
Uma array das IDs de equipe da organização.

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.

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.

curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/public/v1.0/orgs/59db8d1d87d9d6420df0613f/users?pretty=true"
{
"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
}

Voltar

Obter todos os projetos de uma organização