Obter todos os usuários atribuídos a uma 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

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.

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

Sintaxe

GET /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 associada à equipe.
`TEAM-ID`	Obrigatório	O identificador exclusivo da equipe cuja associação de usuário você deseja recuperar.

Solicitar parâmetros de query

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

Nome	Tipo	necessidade	Descrição	Default
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope : true` na consulta. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`false`

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

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 incorporado`results` .
`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 atribuído à equipe.

Nome	Tipo	Descrição
`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 de objetos	Um ou mais links para sub-recursos e/ou recursos relacionados. Os tipos de relação entre URLs são explicados na Especificação de links da web .
`roles`	array	Cada objeto na array `roles` representa a função da organização MongoDB Atlas que o usuário tem para o `orgId` ou `groupId` associado.
`roles.orgId`	string	ID da organização onde o usuário tem o role de organização `roles.roleName` atribuído.
`roles.groupId`	string	ID do projeto em que o usuário tem a função de projeto `roles.roleName` atribuída .
`roles.roleName`	string	O papel da organização atribuído ao usuário para o `roles.orgId` ou `roles.groupId` especificado.
`teamsIds`	array	Array de IDs de string para cada equipe da qual o usuário é membro.
`username`	string	Nome de usuário associado ao usuário.

Exemplo de solicitação

curl --user "{username:apiKey}" --digest -i \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true"

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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pageNum=1&itemsPerPage=100",
          "rel": "self"
      }
  ],
  "results": [
      {
          "emailAddress": "CloudUser@example.com",
          "firstName": "Cloud",
          "id": "{USER-ID}",
          "lastName": "User",
          "links": [
              {
                  "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/users/{USER-ID}",
                  "rel": "self"
              }
          ],
          "roles": [
              {
                  "groupId": "{PROJECT-ID}",
                  "roleName": "GROUP_OWNER"
              },
              {
                  "orgId": "{ORG-ID}",
                  "roleName": "ORG_OWNER"
              }
          ],
          "teamIds": [
              "{TEAM-ID}"
          ],
          "username": "CloudUser@example.com"
      }
  ],
  "totalCount": 1
}

Voltar

Obter uma equipe por nome

Crie uma equipe