Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Obter todas as chaves de API da organização atribuídas a um projeto

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

PROJECT-ID

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).

1

itemsPerPage

inteiro

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Indica se o corpo da resposta deve ser retornado em um formato prettyprint.

false

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 "envelope" : true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

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

O documento JSON de resposta inclui uma array de objetos de result, uma array de objetos de link e uma contagem do número total de objetos de result recuperados.

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 é uma chave API do projeto.

Nome
Tipo
Descrição

desc

string

Descrição desta chave de API da Organização atribuída a este projeto.

id

string

Identificador exclusivo para esta chave de API da organização atribuída a este projeto.

privateKey

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.

publicKey

string

Chave pública para esta chave de API da Organização atribuída a este Projeto.

roles

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.

roles.groupId

string

Identificador único do projeto ao qual pertence este role.

roles.orgId

string

Identificador único da organização à qual pertence esse role.

roles.roleName

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.orgId (Organização), os valores incluem:

Roles do projeto

Se este for um roles.groupId (Projeto), os valores incluem:

Exemplo de solicitação

Observação

O usuário que faz a solicitação pode ser formatado como {PUBLIC-KEY}:{PRIVATE-KEY}.

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}/apiKeys?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-alive
HTTP/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

{  "links" : [ {    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",    "rel" : "self"  } ],  "results" : [ {    "desc" : "Updated API Key description for DOCSP-6042",    "id" : "5d1cf1f980eef570c9fc87e5",    "links" : [ {      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",      "rel" : "self"    } ],    "privateKey" : "********-****-****-9d4ae38e4ddd",    "publicKey" : "{PUBLIC-KEY}",    "roles" : [ {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_AUTOMATION_ADMIN"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_MONITORING_ADMIN"    }, {      "orgId" : "5980cfe20b6d97029d82fa63",      "roleName" : "ORG_MEMBER"    }, {      "orgId" : "5980cfe20b6d97029d82fa63",      "roleName" : "ORG_BILLING_ADMIN"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_DATA_ACCESS_ADMIN"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_USER_ADMIN"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_READ_ONLY"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_OWNER"    }, {      "orgId" : "5980cfe20b6d97029d82fa63",      "roleName" : "ORG_OWNER"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"    }, {      "orgId" : "5980cfe20b6d97029d82fa63",      "roleName" : "ORG_GROUP_CREATOR"    }, {      "orgId" : "5980cfe20b6d97029d82fa63",      "roleName" : "ORG_READ_ONLY"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_DATA_ACCESS_READ_ONLY"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_BACKUP_ADMIN"    }, {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_CLUSTER_MANAGER"    } ]  }, {    "desc" : "New API key for test purposes",    "id" : "5d1d12c087d9d63e6d682438",    "links" : [ {      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",      "rel" : "self"    } ],    "privateKey" : "********-****-****-cb34f12aafdb",    "publicKey" : "oxhzytwb",    "roles" : [ {      "groupId" : "{PROJECT-ID}",      "roleName" : "GROUP_READ_ONLY"    }, {      "orgId" : "5980cfe20b6d97029d82fa63",      "roleName" : "ORG_MEMBER"    }, {      "orgId" : "5980cfe20b6d97029d82fa63",      "roleName" : "ORG_BILLING_ADMIN"    } ]  } ],  "totalCount" : 2}
Voltar
Chaves API em projetos
Próximo
Criar e atribuir
Avalie esta página

Nesta página