Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /
/ / /

Acceso programático a Cloud Manager con claves API

Para conceder acceso programático a una organización o proyecto usando únicamente los API, puedes crear un API key. API keys:

  • Tiene dos partes: una clave pública y una clave privada.

  • No se puede usar para iniciar sesión en Cloud Manager a través de la interfaz de usuario.

  • Se deben otorgar roles como si fueran usuarios para asegurarse de que las claves API puedan llamar a los puntos finales de API sin errores.

  • Puede pertenecer a una organización, pero se le puede conceder acceso a cualquier número de proyectos dentro de dicha organización.

Nota

Permisos requeridos

1
  1. Si aún no se muestra, selecciona la organización deseada en el menú Organizations de la barra de navegación.

  2. En la barra lateral, haz clic en Applications` en la sección Identity & Access.

Se muestra la página de Aplicaciones.

2
3

Desde el paso API Key Information de la página Add API Key:

Campo
Valor

Descripción

Introduce una descripción para la nueva Clave API.

Permisos de la organización

Seleccione el nuevo rol o roles para la API Key.

4
5

Desde el paso Private Key & Access List de la página Add API Key, haz clic en Add Access List Entry.

Para esta clave de API, puedes elegir:

  • Ingrese una dirección IPv4 desde la cual Cloud Manager debe aceptar solicitudes de API, o

  • Haga clic en si el host que utiliza Use Current IP Address para acceder a Cloud Manager realizará solicitudes de API.

6

Advertencia

Copia la clave privada antes de salir de esta página

Cloud Manager muestra el Private Key una vez: en esta página. Haga clic en Copy para añadir la clave privada al portapapeles. Guarde y asegure esta clave privada como lo haría con cualquier otra contraseña.

1
  1. Si aún no se muestra, selecciona la organización deseada en el menú Organizations de la barra de navegación.

  2. En la barra lateral, haz clic en Applications` en la sección Identity & Access.

Se muestra la página de Aplicaciones.

2
3
  1. Junto a la clave API, haga clic en.

  2. Haga clic en View Details.

    El modal <Public Key> API Key Details muestra el:

    • Private Key ofuscado.

    • Fecha en que se utilizó la clave por última vez.

    • Fecha en que se creó la Clave.

    • IPv4 direcciones en las que la clave se encuentra en la lista de acceso.

    • Proyectos a los que se ha concedido acceso a la clave.

Puedes cambiar los roles, la descripción o la lista de acceso de una clave API en una organización.

1
  1. Si aún no se muestra, selecciona la organización deseada en el menú Organizations de la barra de navegación.

  2. En la barra lateral, haz clic en Applications` en la sección Identity & Access.

Se muestra la página de Aplicaciones.

2
3
  1. Haz clic en el junto a la clave de API que quieres cambiar.

  2. Haga clic en Edit.

4

Desde el paso API Key Information de la página Add API Key:

Campo
Valor

Descripción

Introduce una descripción para la nueva Clave API.

Permisos de la organización

Seleccione el nuevo rol o roles para la API Key.

5
6

Desde el paso Private Key & Access List de la página Add API Key, haz clic en Add Access List Entry.

Para esta clave de API, puedes elegir:

  • Ingrese una dirección IPv4 desde la cual Cloud Manager debe aceptar solicitudes de API, o

  • Haga clic en si el host que utiliza Use Current IP Address para acceder a Cloud Manager realizará solicitudes de API.

7

Advertencia

Copia la clave privada antes de salir de esta página

Cloud Manager muestra el Private Key una vez: en esta página. Haga clic en Copy para añadir la clave privada al portapapeles. Guarde y asegure esta clave privada como lo haría con cualquier otra contraseña.

1
  1. Si aún no se muestra, selecciona la organización deseada en el menú Organizations de la barra de navegación.

  2. En la barra lateral, haz clic en Applications` en la sección Identity & Access.

Se muestra la página de Aplicaciones.

2
3
  1. Haz clic en junto a la clave API que deseas borrar.

  2. Haz clic en Delete para confirmar que deseas borrar esta clave API o en Cancel para dejar la clave en la organización.

Nota

Al eliminar una clave API de una organización, también se elimina esa clave de cualquier proyecto al que se le haya otorgado acceso a la clave.

Nota

Permisos requeridos

Para realizar cualquiera de las siguientes acciones, debes tener el rol Project User Admin.

1
  1. Si aún no se muestra, seleccione la organización que contiene su proyecto deseado en el menú Organizations de la barra de navegación.

  2. Si aún no aparece, selecciona el proyecto deseado en el menú Projects de la barra de navegación.

  3. En la barra lateral, haga clic en Project Settings.

    La página Configuración del proyecto se muestra.

2

En la barra lateral, haz clic en Applications en la sección Identity & Access.

Se muestra la página de Aplicaciones.

3
4

Desde el paso API Key Information de la página Add API Key:

Campo
Valor

Descripción

Introduce una descripción para la nueva Clave API.

Permisos del proyecto

Seleccione el nuevo rol o roles para la API Key.

5
6

Desde el paso Private Key & Access List de la página Add API Key, haz clic en Add Access List Entry.

Para esta clave de API, puedes elegir:

  • Ingrese una dirección IPv4 desde la cual Cloud Manager debe aceptar solicitudes de API, o

  • Haga clic en si el host que utiliza Use Current IP Address para acceder a Cloud Manager realizará solicitudes de API.

7

Advertencia

Copia la clave privada antes de salir de esta página

Cloud Manager muestra el Private Key una vez: en esta página. Haga clic en Copy para añadir la clave privada al portapapeles. Guarde y asegure esta clave privada como lo haría con cualquier otra contraseña.

1
  1. Si aún no se muestra, seleccione la organización que contiene su proyecto deseado en el menú Organizations de la barra de navegación.

  2. Si aún no aparece, selecciona el proyecto deseado en el menú Projects de la barra de navegación.

  3. En la barra lateral, haga clic en Project Settings.

    La página Configuración del proyecto se muestra.

2

En la barra lateral, haz clic en Applications en la sección Identity & Access.

Se muestra la página de Aplicaciones.

3
4
  1. Junto a la clave API, haga clic en.

  2. Haga clic en View Details.

    El modal <Public Key> API Key Details muestra el:

    • Private Key ofuscado.

    • Fecha en que se utilizó la clave por última vez.

    • Fecha en que se creó la Clave.

    • IPv4 direcciones en las que la clave se encuentra en la lista de acceso.

    • Proyectos a los que se ha concedido acceso a la clave.

1
  1. Si aún no se muestra, seleccione la organización que contiene su proyecto deseado en el menú Organizations de la barra de navegación.

  2. Si aún no aparece, selecciona el proyecto deseado en el menú Projects de la barra de navegación.

  3. En la barra lateral, haga clic en Project Settings.

    La página Configuración del proyecto se muestra.

2

En la barra lateral, haz clic en Applications en la sección Identity & Access.

Se muestra la página de Aplicaciones.

3
4
  1. Haz clic en el junto a la clave de API que quieres cambiar.

  2. Haga clic en Edit.

5

Desde el paso API Key Information de la página Add API Key:

Campo
Valor

Descripción

Introduce una descripción para la nueva Clave API.

Permisos del proyecto

Seleccione el nuevo rol o roles para la API Key.

6
7

Desde el paso Private Key & Access List de la página Add API Key, haz clic en Add Access List Entry.

Para esta clave de API, puedes elegir:

  • Ingrese una dirección IPv4 desde la cual Cloud Manager debe aceptar solicitudes de API, o

  • Haga clic en si el host que utiliza Use Current IP Address para acceder a Cloud Manager realizará solicitudes de API.

8

Advertencia

Copia la clave privada antes de salir de esta página

Cloud Manager muestra el Private Key una vez: en esta página. Haga clic en Copy para añadir la clave privada al portapapeles. Guarde y asegure esta clave privada como lo haría con cualquier otra contraseña.

1
  1. Si aún no se muestra, seleccione la organización que contiene su proyecto deseado en el menú Organizations de la barra de navegación.

  2. Si aún no aparece, selecciona el proyecto deseado en el menú Projects de la barra de navegación.

  3. En la barra lateral, haga clic en Project Settings.

    La página Configuración del proyecto se muestra.

2

En la barra lateral, haz clic en Applications en la sección Identity & Access.

Se muestra la página de Aplicaciones.

3
4
  1. Haz clic en junto a la clave API que deseas borrar.

  2. Haz clic en Delete para confirmar que deseas borrar esta clave API o en Cancel para dejar la clave en la organización.

Nota

Al eliminar una clave API de una organización, también se elimina esa clave de cualquier proyecto al que se le haya otorgado acceso a la clave.

Volver

Acceso a Cloud Manager

En esta página