URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/apiKeys
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| string | Identificador exclusivo do projeto do qual você deseja recuperar as chaves atribuídas da API da organização. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|
pageNum | inteiro | Número da página (com base em índice 1). |
| ||||||
itemsPerPage | inteiro | Número de itens a serem devolvidos por página, até um máximo de 500. |
| ||||||
pretty | booleano | Indica se o corpo da resposta deve estar em formato prettyprint. |
| ||||||
envelope | booleano | Indica se deseja ou não envolver a resposta em um envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set Para endpoints que retornam um resultado, o corpo da resposta inclui:
Para endpoints que retornam uma lista de resultados, o objeto | none |
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 |
|---|---|---|
| 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. As relações entre URLs são explicadas na Especificação de links da web. |
| 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 é uma chave API do projeto.
Nome | Tipo | Descrição | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Descrição desta chave de API da Organização atribuída a este projeto. | ||||||||||||||||||||||||||||||||||
| string | Identificador exclusivo para esta chave de API da organização atribuída a este projeto. | ||||||||||||||||||||||||||||||||||
| string | Chave privada editada para esta chave de API da Organização atribuída a este projeto. Essa chave é exibida sem edição quando criada pela primeira vez. | ||||||||||||||||||||||||||||||||||
| string | Chave pública para esta chave de API da Organização atribuída a este Projeto. | ||||||||||||||||||||||||||||||||||
| array de objetos | Funções que essa chave de API da organização atribuída a esse projeto tem. Essa matriz retorna todos os papéis da organização e do projeto que o usuário tem no Cloud Manager. | ||||||||||||||||||||||||||||||||||
| string | Identificador único do projeto ao qual pertence este role. | ||||||||||||||||||||||||||||||||||
| string | Identificador único da organização à qual pertence esse role. | ||||||||||||||||||||||||||||||||||
| string | Nome da função. Esse recurso retorna todos os roles que o usuário tem no Cloud Manager. Os valores possíveis são: Roles da organização Se esta for uma
Roles do projeto Se este for um
|
Exemplo de solicitação
Observação
O usuário que faz a solicitação pode ser formatado como {PUBLIC-KEY}:{PRIVATE-KEY}.
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=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
1 { 2 "links" : [ { 3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "desc" : "Updated API Key description for DOCSP-6042", 8 "id" : "5d1cf1f980eef570c9fc87e5", 9 "links" : [ { 10 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5", 11 "rel" : "self" 12 } ], 13 "privateKey" : "********-****-****-9d4ae38e4ddd", 14 "publicKey" : "{PUBLIC-KEY}", 15 "roles" : [ { 16 "groupId" : "{PROJECT-ID}", 17 "roleName" : "GROUP_AUTOMATION_ADMIN" 18 }, { 19 "groupId" : "{PROJECT-ID}", 20 "roleName" : "GROUP_MONITORING_ADMIN" 21 }, { 22 "orgId" : "5980cfe20b6d97029d82fa63", 23 "roleName" : "ORG_MEMBER" 24 }, { 25 "orgId" : "5980cfe20b6d97029d82fa63", 26 "roleName" : "ORG_BILLING_ADMIN" 27 }, { 28 "groupId" : "{PROJECT-ID}", 29 "roleName" : "GROUP_DATA_ACCESS_ADMIN" 30 }, { 31 "groupId" : "{PROJECT-ID}", 32 "roleName" : "GROUP_USER_ADMIN" 33 }, { 34 "groupId" : "{PROJECT-ID}", 35 "roleName" : "GROUP_READ_ONLY" 36 }, { 37 "groupId" : "{PROJECT-ID}", 38 "roleName" : "GROUP_OWNER" 39 }, { 40 "orgId" : "5980cfe20b6d97029d82fa63", 41 "roleName" : "ORG_OWNER" 42 }, { 43 "groupId" : "{PROJECT-ID}", 44 "roleName" : "GROUP_DATA_ACCESS_READ_WRITE" 45 }, { 46 "orgId" : "5980cfe20b6d97029d82fa63", 47 "roleName" : "ORG_GROUP_CREATOR" 48 }, { 49 "orgId" : "5980cfe20b6d97029d82fa63", 50 "roleName" : "ORG_READ_ONLY" 51 }, { 52 "groupId" : "{PROJECT-ID}", 53 "roleName" : "GROUP_DATA_ACCESS_READ_ONLY" 54 }, { 55 "groupId" : "{PROJECT-ID}", 56 "roleName" : "GROUP_BACKUP_ADMIN" 57 }, { 58 "groupId" : "{PROJECT-ID}", 59 "roleName" : "GROUP_CLUSTER_MANAGER" 60 } ] 61 }, { 62 "desc" : "New API key for test purposes", 63 "id" : "5d1d12c087d9d63e6d682438", 64 "links" : [ { 65 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438", 66 "rel" : "self" 67 } ], 68 "privateKey" : "********-****-****-cb34f12aafdb", 69 "publicKey" : "oxhzytwb", 70 "roles" : [ { 71 "groupId" : "{PROJECT-ID}", 72 "roleName" : "GROUP_READ_ONLY" 73 }, { 74 "orgId" : "5980cfe20b6d97029d82fa63", 75 "roleName" : "ORG_MEMBER" 76 }, { 77 "orgId" : "5980cfe20b6d97029d82fa63", 78 "roleName" : "ORG_BILLING_ADMIN" 79 } ] 80 } ], 81 "totalCount" : 2 82 }