/ /

Claves API de organización

Docs Home

/ /

Claves de API programáticas

Claves API de organización

Claves de API programáticas

Claves API de organización

Obtén una clave de API

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

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

Resource

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	string	El identificador único de organización cuyas claves de API deseas recuperar. Utiliza el endpoint /orgs para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.
`API-KEY-ID`	string	El identificador único de la clave API que desea recuperar. Solicita el endpoint /orgs/{ORG-ID}/apiKeys para recuperar todos API claves para la organización especificada 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).

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 prettyprint formato.

false

envelope

booleano

Indica si se debe o no envolver la respuesta en un sobre.

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

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

Nombre	Descripción
`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

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Elementos de respuesta

Si configuras el elemento de query envelope en true, la respuesta estará envuelta en el objeto content.

La respuesta HTTP retorna un documento JSON que incluye los siguientes objetos:

Nombre

Tipo

Descripción

id

string

Identificador único para la clave API

links

string

Un arreglo de documentos que representa un enlace a uno o más subrecursos y/o recursos relacionados, como la paginación de la lista. Consulta Vinculación para obtener más información.

desc

string

Descripción de la clave API

privateKey

string

Clave privada redactada para la clave API

publicKey

string

llave pública para la clave API

roles

objeto arreglo

Roles que tiene la clave API

roles.{ENTITY-ID}

string

El {ENTITY-ID} representa la Organización o Proyecto a la que aplica este rol. Los valores posibles son: orgId o groupId.

roles.roleName

string

El nombre del rol. El recurso users devuelve todos los roles que el usuario tiene en MongoDB Atlas o Cloud Manager. Los valores posibles son:

Roles de la organización

Valor de Rol en API	rol
`ORG_OWNER`	`Organization Owner`
`ORG_MEMBER`	`Organization Member`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_BILLING_ADMIN`	`Organization Billing Admin`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_BILLING_READ_ONLY`	`Organization Billing Viewer`

Roles del proyecto
Grupos y proyectos son términos sinónimos.
- GROUP_OWNER
- GROUP_READ_ONLY
- GROUP_DATA_ACCESS_ADMIN
- GROUP_DATA_ACCESS_READ_WRITE
- GROUP_DATA_ACCESS_READ_ONLY
- GROUP_AUTOMATION_ADMIN
- GROUP_BACKUP_ADMIN
- GROUP_MONITORING_ADMIN
- GROUP_OWNER
- GROUP_USER_ADMIN

Solicitud de ejemplo

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/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true"

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 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

HTTP/1.1 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}

Respuesta del cuerpo

{
  "desc" : "Test Docs Service User",
  "id" : "5c47503880eef5662e1cce8d",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d98229d82e3f6/apiKeys/5c47503880eef5662e1cce8d",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "ewmaqvdo",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "groupId" : "{PROJECT-ID}",
    "roleName" : "GROUP_READ_ONLY"
  }, {
    "groupId" : "{PROJECT-ID}",
    "roleName" : "GROUP_OWNER"
  } ]
}

Volver

Obtener todo

Update