Docs Menu
Docs Home
/ /
Claves API de la organización
Docs Home
/ /
Claves de API programáticas
/
Claves API de la organización
Docs Home
/
MongoDB Ops Manager
/
API
/
Recursos
/
Claves de API programáticas
/
Claves API de la organización

Obtenga una clave API

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

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

Parámetros de la ruta de solicitud

Nombre
Tipo
Descripción

ORG-ID

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.

API-KEY-ID

string

El identificador único de la clave API que desea recuperar. Solicite el punto de conexión /orgs/{ORG-ID}/apiKeys para recuperar todas las claves. Claves API para la organización especificada a la 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).

1

artículos por página

entero

Número de artículos a devolver por página, hasta un máximo de 500.

100

bonita

booleano

Indica si el cuerpo de la respuesta debe estar en formato prettyprint. formato.

false

envolvente

booleano

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

Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure "envelope" : true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Estado
Código de respuestaHTTP

envolvente

Cuerpo de respuesta esperado

Para los puntos finales que devuelven una lista de resultados, el objeto results es un sobre. Ops Manager añade el campo status al cuerpo de la respuesta.

Ninguno

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Elementos de respuesta

Si establece el elemento de consulta envelope en true, la respuesta estará envuelta por el objeto content.

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

Nombre
Tipo
Descripción

id

string

Identificador único para la clave API

links

string

Una matriz de documentos que representa un enlace a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Enlaces 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

Clave pública para la clave API

roles

matriz de objetos

Roles que tiene la clave API

roles.{ENTITY-ID}

string

El {ENTITY-ID} representa la organización o el proyecto al que se 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 u Ops Manager. Los valores posibles son:

  • Roles de la organización

    Valor del rol en la API
    rol

    ORG_OWNER

    Organization Owner

    ORG_MEMBER

    Organization Member

    ORG_GROUP_CREATOR

    Organization Project Creator

    ORG_READ_ONLY

    Organization Read Only

  • 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

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true"

Ejemplo de respuesta

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}

Cuerpo de respuesta

{
  "desc" : "Test Docs Service User",
  "id" : "5c47503880eef5662e1cce8d",
  "links" : [ {
    "href" : "https://<OpsManagerHost>:<Port>/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

Next

Crear

En esta página