URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/apiKeys
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | El identificador único para el Organización cuyas claves API desea recuperar. Utilice el punto de conexión /orgs para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|
número de página | entero | Número de página (basado en el índice 1). |
| ||||||
artículos por página | entero | Número de artículos a devolver por página, hasta un máximo de 500. |
| ||||||
bonita | booleano | Indica si el cuerpo de la respuesta debe estar en formato prettyprint. formato. |
| ||||||
envolvente | booleano | Indica si se debe envolver o no la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
Respuesta
Documento de respuesta
El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en la |
| arreglo | La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web. |
| Número | Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado. |
results Documento incrustado
Cada resultado es una clave API.
Nombre | Tipo | Descripción | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Identificador único para la clave API | ||||||||||||||
| string | Descripción de la clave API | ||||||||||||||
| string | Clave privada redactada para la clave API | ||||||||||||||
| string | Clave pública para la clave API | ||||||||||||||
| matriz de objetos | Roles que tiene la clave API | ||||||||||||||
| string | El | ||||||||||||||
| string | El nombre del rol. El recurso
|
Ejemplo de solicitud
Nota
El usuario que realiza la solicitud puede tener el formato {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/orgs/{ORG-ID}/apiKeys?pretty=true"
Ejemplo de respuesta
Encabezado de respuesta
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Cuerpo de respuesta
{ "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d97029d82e3f6/apiKeys?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "desc" : "Test Docs Service User", "id" : "5c47503320eef5699e1cce8d", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d98829d82e3f6/apiKeys/5c47503ae0eef5699e1cce8d", "rel" : "self" } ], "privateKey" : "********-****-****-db2c132ca78d", "publicKey" : "ewmaqvdo", "roles" : [ { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_OWNER" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" }, { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_MEMBER" } ] } ], "totalCount" : 1 }