Devuelve una entrada de lista de control de acceso para la clave API de organización especificada.
El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Los recursos requieren que todas las solicitudes de API se originen desde direcciones IP de la lista de acceso de API. Para usar este recurso, la cuenta de servicio o clave de API solicitante debe tener el rol de miembro de la organización.
Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgapikeyaccesslistentry.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api programmaticApiKeys getOrgAccessEntry [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--apiUserId | string | true | string única de 24 dígitos hexadecimales que identifica la clave API de esta organización para la cual deseas devolver las entradas de la lista de acceso. |
--envelope | envelope | false | Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta. |
-h, --help | false | ayuda para getOrgAccessEntry | |
--ipAddress | string | true | Una dirección IP o varias direcciones IP representadas como un bloque CIDR para limitar las solicitudes a los recursos API en la organización especificada. Cuando añadas un bloque CIDR con una máscara de subred, como 192.0.2.0/24, usa el valor codificado en URL %2F para la barra diagonal /. |
--orgId | string | true | Cadena única de dígitos hexadecimales 24que identifica la organización que contiene sus proyectos. Utilice el punto de conexión [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--outputFile | string | false | archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip) |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-01"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api programmaticApiKeys getOrgAccessEntry --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61