/ /

Projetos e usuários

Projetos

Página inicial do Docs

Obtenha todos os usuários em um projeto

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu grupo. Para grupos existentes, o ID do grupo/ ID do projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

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

Resource

GET /groups/{PROJECT-ID}/users

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Nome	Tipo	necessidade	Descrição
ID do projeto	string	Obrigatório	Identificador único do projeto.

Solicitar parâmetros de query

Nome	Tipo	necessidade	Descrição
flattenTeams	booleano	Opcional	Sinalizador que indica se a lista retornada deve incluir usuários que pertencem a uma equipe atribuída a uma role neste projeto. Talvez você não tenha atribuído uma role aos usuários individuais neste projeto. Se esse sinalizador estiver definido como `false`, o endpoint retornará apenas os usuários que receberam uma função no projeto. Se esse sinalizador for definido como `true`, o endpoint retornará tanto os usuários que receberam roles no projeto quanto os usuários que são membros de equipes que receberam roles no projeto.
includeOrgUsers	booleano	Opcional	Sinalizador que indica se a lista retornada deve incluir usuários com acesso implícito ao projeto por meio da role `Organization Owner` ou `Organization Read Only` . Talvez você não tenha atribuído uma role aos usuários individuais neste projeto. Se esse sinalizador estiver definido como `false`, o endpoint retornará apenas os usuários que receberam uma função no projeto. Se esse sinalizador for definido como `true`, o endpoint retornará usuários que recebem roles no projeto e usuários que têm acesso implícito ao projeto por meio de sua role da organização. O valor padrão é `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

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Nome	Tipo	Descrição
`results`	array	A array inclui um objeto para cada item detalhado na seção `results` Documento incorporado.
`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 resultado é um usuário.

Nome	Tipo	Descrição
emailAddress	string	Endereço de e-mail atribuído ao MongoDB Atlas user retornado.
Nome	string	Nome atribuído ao Atlas user retornado do MongoDB Atlas.
id	string	Identificador único atribuído ao MongoDB Atlas user retornado.
Sobrenome	string	Sobrenome atribuído ao usuário retornado do MongoDB Atlas.
links	array de objetos	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.
roles	array de objetos	Roles atribuídos ao Atlas user do MongoDB Atlas.
roles.groupId	string	Identificador único do projeto ao qual o usuário retornado do MongoDB Atlas foi atribuído ao role fornecido em `role.roleName`.
roles.orgId	string	Identificador único da organização para a qual o Atlas user retornado do MongoDB Atlas foi atribuído à role fornecida em `role.roleName`.
roles.roleName	string	Nome de exibição do role atribuído ao usuário MongoDB Atlas retornado para o grupo fornecido em `role.groupId` ou a organização fornecida em `role.orgId`.
nome de usuário	string	Nome de usuário do MongoDB Atlas fornecido ao Atlas user que retornou.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true&includeOrgUsers=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://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/ users?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "emailAddress" : "joe.bloggs@example.com",
    "firstName" : "Joe",
    "id" : "{USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
      "rel" : "self"
    }, {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "groupId" : "{OTHER-PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }
    ...
    ],
    "username" : "joe.bloggs"
  }, {
    "emailAddress" : "jim.bloggs@example.com",
    "firstName" : "Jim",
    "id" : "{OTHER-USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{OTHER-USER-ID}",
      "rel" : "self"
    }, {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{OTHER-USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "roleName" : "GLOBAL_READ_ONLY"
    }, {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "orgId" : "{ORGANIZATION-ID}",
      "roleName" : "ORG_READ_ONLY"
    } ],
    "username" : "jim.bloggs"
  } ],
  "totalCount" : 2
}

Voltar

Atualizar funções

Adicionar usuários existentes