URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| string | O identificador exclusivo da organização cujas chaves de API você deseja recuperar. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso. |
| string | Identificador único para a chave de API que você deseja recuperar. Solicitação ao ponto de extremidade /orgs/{ORG-ID}/apiKeys para recuperar todas as chaves API para a organização especificada à qual 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 ser retornado em um formato prettyprint. |
|
envelope | booleano | Indica se deve envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure 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
Elementos de resposta
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:
Nome | Tipo | Descrição |
|---|---|---|
| string | Identificador exclusivo para a chave API |
| string | Um array de documentos, representando um link para um ou mais sub-recursos ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações. |
| string | Descrição da chave API |
| string | Chave privada editada para a chave de API |
| string | Chave pública para a chave de API |
| array de objetos | Funções que a chave API tem |
| string | O |
| string | O nome da função. O recurso
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true"Exemplo de resposta
Cabeçalho de resposta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
{ "desc" : "Test Docs Service User", "id" : "5c47503880eef5662e1cce8d", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d98229d82e3f6/apiKeys/5c47503880eef5662e1cce8d", "rel" : "self" } ], "privateKey" : "********-****-****-db2c132ca78d", "publicKey" : "ewmaqvdo", "roles" : [ { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_MEMBER" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_OWNER" } ]}