Devuelve una clave API de la organización. Las claves API de la organización otorgan acceso programático a una organización. No puedes utilizar la clave API para acceder a MongoDB nube a través de la interfaz de usuario. Para usar este recurso, la cuenta de servicio solicitante o la clave API deben contar con el rol de Miembro de la organización.
- Miembro de la organización
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica la organización que contiene su proyectos. Utilice el
/orgsendpoint para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
string única de 24 dígitos hexadecimales que identifica esta clave API de la organización que se desea actualizar.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.pretty-print
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/apiKeys/{apiUserId}' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "string"
}
]
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}