URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/apiKeysParámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| 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. |
Parámetros de Solicitud Query
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). |
|
elementosPorPágina | entero | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Indica si el cuerpo de la respuesta debe estar en un formato prettyprint. |
|
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 Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
Parámetros del cuerpo de la solicitud
Se requiere al menos uno de los dos parámetros en el cuerpo.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Descripción de la clave API. Debe tener entre 1 y 250 caracteres de longitud. |
| arreglo de string | Lista de roles que la clave de API debe tener. Si se proporciona el arreglo
Los roles del proyecto incluyen:
|
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Descripción de esta clave API de la organización API asignada a este proyecto. |
| string | Identificador único para esta organización API clave asignada a este proyecto. |
| 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. |
| string | Llave pública para esta organización API asignada a este proyecto. |
| 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. |
| string | Identificador único del Proyecto al que pertenece este rol. |
| string | Identificador único de la organización a la que pertenece este rol. |
| 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 del proyecto Si esto es un
|
Solicitud de ejemplo
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"] }'Respuesta de ejemplo
Encabezado de respuesta
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}Respuesta del cuerpo
{ "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" } ]}