Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Asignar una clave de API de la organización a un único proyecto

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

PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}
Nombre
Tipo
Descripción

PROJECT-ID

string

Identificador único del proyecto cuyos API deseas actualizar. Utiliza el endpoint /grupos para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

API-KEY-ID

string

Identificador único para la clave API que se desea actualizar. Se debe utilizar el punto final /groups/{ID del proyecto}/apiKeys para recuperar todas las claves API a las que el usuario autenticado tiene acceso para la organización especificada.

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Descripción
predeterminado

Num. de pág.

entero

Número de página (basado en índice a partir de 1).

1

elementosPorPágina

entero

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Indica si el cuerpo de la respuesta debe estar en un formato prettyprint.

false

envelope

booleano

Indica si se debe envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para corregir esto, establezca "envelope" : true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:

  • status: Código de respuesta HTTP

  • content: Cuerpo de respuesta esperado

Para los endpoints que devuelven una lista de resultados, el objeto results es un sobre. Cloud Manager añade el campo status al cuerpo de la respuesta.

Ninguno

Nombre
Tipo
Necesidad
Descripción

roles

arreglo

Requerido

Lista de roles que la clave de API debe tener asignados. Se debe proporcionar un mínimo de un rol. Todos los roles proporcionados deben ser válidos para el Proyecto asignado:

Nombre
Tipo
Descripción

desc

string

Descripción de esta clave API de la organización API asignada a este proyecto.

id

string

Identificador único para esta organización API clave asignada a este proyecto.

privateKey

string

Clave privada redactada para esta organización API clave asignada a este proyecto.

Esta clave se muestra sin enmascarar cuando se crea por primera vez.

publicKey

string

Llave pública para esta organización API asignada a este proyecto.

roles

objeto arreglo

Roles que esta organización API clave asignada a este proyecto tiene. Este arreglo devuelve todos los roles de la Organización y del Proyecto que el usuario tiene en Cloud Manager.

roles.groupId

string

Identificador único del Proyecto al que pertenece este rol.

roles.orgId

string

Identificador único de la organización a la que pertenece este rol.

roles.roleName

string

Nombre del rol. Este recurso devuelve todos los roles que el usuario tiene en Cloud Manager. Los valores posibles son:

Roles de la organización

Si esto es una roles.orgId (organización), los valores incluyen:

Roles del proyecto

Si esto es un roles.groupId (Proyecto), los valores incluyen:

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}?pretty=true" --data '{ "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ] }'
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}
{ "desc" : "test", "id" : "{API-KEY-ID}", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}", "rel" : "self" } ], "privateKey" : "********-****-****-1493e7bcfde9", "publicKey" : "{PUBLIC-KEY}", "roles" : [ { "groupId" : "{PROJECT-ID-1}", "roleName" : "GROUP_DATA_ACCESS_READ_WRITE" }, { "groupId" : "{PROJECT-ID-1}", "roleName" : "GROUP_READ_ONLY" }, { "groupId" : "{PROJECT-ID-2}", "roleName" : "GROUP_READ_ONLY" }, { "orgId" : "{ORG-ID}", "roleName" : "ORG_MEMBER" } ]}