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.

Crear y asignar una clave de API de una organización a un proyecto

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

POST /groups/{PROJECT-ID}/apiKeys
Nombre
Tipo
Descripción

PROJECT-ID

string

Identificador único del Proyecto cuyas claves API desea recuperar. Utilice el endpoint /groups para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

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

Se requiere al menos uno de los dos parámetros en el cuerpo.

Nombre
Tipo
Descripción

desc

string

Descripción de la clave API. Debe tener entre 1 y 250 caracteres de longitud.

roles

arreglo de string

Lista de roles que la clave de API debe tener. Si se proporciona el arreglo roles:

  • Proporciona al menos un rol

  • Asegúrese de que todos los roles sean válidos para el proyecto

Los roles del proyecto incluyen:

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:

Nota

El usuario que hace la solicitud puede ser formateado como {PUBLIC-KEY}:{PRIVATE-KEY}.

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/groups/{PROJECT-ID}/apiKeys?pretty=true" \ --data '{ "desc" : "New API key for test purposes", "roles": ["GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN"] }'
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" : "New API key for test purposes", "id" : "5d1d143c87d9d63e6d694746", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d143c87d9d63e6d694746", "rel" : "self" } ], "privateKey" : "********-****-****-db2c132ca78d", "publicKey" : "{PUBLIC-KEY}", "roles" : [ { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_DATA_ACCESS_ADMIN" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_BILLING_ADMIN" } ]}