Obtenha todos os usuários em um projeto
Nesta página
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
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.
|
includeOrgUsers | booleano | Opcional | Sinalizador que indica se a lista retornada deve incluir usuários com acesso implícito ao projeto por meio da função
O valor padrão é |
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 documentoJSON 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 |
---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| array | A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. The relations between URLs are explained in the Web Linking Specification. |
| 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 |
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 |
roles.orgId | string | Identificador único da organização para a qual o Atlas user retornado do MongoDB Atlas foi atribuído à role fornecida em |
roles.roleName | string | Nome de exibição do role atribuído ao usuário MongoDB Atlas retornado para o grupo fornecido em |
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://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true&includeOrgUsers=true"
Exemplo de resposta
Cabeçalho de resposta
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
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" : "http://{opsManagerHost}:{port}/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" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{USER-ID}", "rel" : "self" }, { "href" : "http://{opsManagerHost}:{port}/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" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{OTHER-USER-ID}", "rel" : "self" }, { "href" : "http://{opsManagerHost}:{port}/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 }