Devolver todas las claves API de la organización

OBTENER /api/atlas/v1.0/orgs/{orgId}/apiKeys

Devuelve todas las claves de API de la organización para la organización especificada. Las claves API de la organización otorgan acceso programático a una organización. No puedes usar la clave de API para iniciar sesión en MongoDB Cloud a través de la consola. Para usar este recurso, la cuenta de servicio solicitante o la clave API deben contar con el rol de Miembro de la organización.

Claves de API programáticas

Parámetros de path

  • orgId string Requerido

    string única de 24dígitos hexadecimales que identifica la organización que contiene su proyectos. Utilice el /orgs endpoint 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})$.

Parámetros de query

  • envelope booleano

    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.

  • includeCount booleano

    Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en la respuesta.

    El valor por defecto es true.

  • elementosPorPágina entero

    Número de elementos que la respuesta retorna por página.

    El valor mínimo es 1, el valor máximo es 500. El valor predeterminado es 100.

  • Num. de pág. entero

    Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

    El valor mínimo es 1. El valor por defecto es 1.

  • bonito booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

    El valor por defecto es false.

    Impresión bonita

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Resultados arreglo[objeto] Requerido

      Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto

      Detalles de las claves API programables.

      • desc string

        Propósito o explicación proporcionados cuando alguien creó esta clave API de la organización.

        La longitud mínima es de 1, la longitud máxima es de 250.

      • ID string

        string única de dígitos 24-hexadecimales que identifica esta clave de API de la organización asignada a este Proyecto.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • clave privada string

        Se devolvió una clave privada redactada para esta clave API de organización. Esta clave se muestra sin redactar al crearse.

      • publicKey string

        llave pública de API establecida para la clave API de la organización especificada.

        La longitud mínima es de 8, la longitud máxima es de 8.

      • Roles arreglo[objeto]

        Lista que contiene los roles que la clave de API debe tener. Todos los roles que proporciones deben ser válidos para el proyecto u organización especificada. Cada solicitud debe incluir al menos un rol válido. El recurso devuelve todos los roles de proyecto y de organización asignados a la clave de API.

        Hide roles attributes Mostrar atributos de roles Objeto

        Los roles del usuario de MongoDB Cloud y la organización o el proyecto correspondiente al que se aplica ese rol. Cada rol puede aplicarse a una organización o un proyecto, pero no a ambos.

        Roles de claves de API de MongoDB Cloud
        • ID del grupo string

          string de dígitos hexadecimales 24-única que identifica el Proyecto al que pertenece este rol. Puedes establecer un valor para este parámetro o orgId, pero no ambos en la misma solicitud.

          La longitud mínima es 24 y la máxima es 24. El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

        • orgId string

          Cadena única de dígitos hexadecimales 24que identifica la organización a la que pertenece este rol. Puede establecer un valor para este parámetro o groupId, pero no ambos, en la misma solicitud.

          La longitud mínima es 24 y la máxima es 24. El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

        • nombreDelRol string

          Etiqueta legible por humanos que identifica la colección de privilegios que MongoDB Cloud otorga a una clave API específica, a un usuario de MongoDB Cloud o a un equipo de MongoDB Cloud. Estos roles incluyen roles a nivel de organización y de proyecto.

          Roles de usuario de MongoDB Cloud
    • recuento total integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount está configurado en false. El número total es una estimación y puede no ser exacto.

      El valor mínimo es 0.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 500 aplicación/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

GET /api/atlas/v1.0/orgs/{orgId}/apiKeys
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/apiKeys' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
        }
      ]
    }
  ],
  "totalCount": 42
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}