Agregue entradas de la lista de acceso para la cuenta de servicio especificada para el proyecto. Los recursos requieren que todas las solicitudes de API provengan de 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 propietario del proyecto o administrador de acceso del proyecto.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
El ID de cliente de la cuenta de servicio.
El formato debe coincidir con el siguiente patrón:
^mdb_sa_id_[a-fA-F\d]{24}$.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula 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 solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si la respuesta devuelve el número total de elementos (
totalCount) en la respuesta.El valor predeterminado es
true. -
Número de elementos que la respuesta devuelve por página.
El valor mínimo es
1, el valor máximo es500. El valor predeterminado es100. -
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 es1. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
Cuerpo
Requerido
Una lista de entradas de la lista de acceso para agregar a la lista de acceso de la cuenta de servicio especificada para el proyecto.
-
Rango de direcciones de red en la lista de acceso de la cuenta de servicio. Este parámetro requiere que el rango se exprese en notación CIDR (Enrutamiento Interdominio sin Clase) para direcciones del Protocolo de Internet versión 4 o versión 6. Puede establecer un valor para este parámetro o para
ipAddress, pero no para ambos en la misma solicitud.El formato debe coincidir con el siguiente patrón:
^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$. -
Dirección de red en la lista de acceso de la cuenta de servicio. Este parámetro requiere que la dirección se exprese como una dirección del protocolo de Internet versión 4 o versión 6. Puede establecer un valor para este parámetro o para
cidrBlock, pero no para ambos en la misma solicitud.El formato debe coincidir con el siguiente patrón:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.
atlas api serviceAccounts createAccessList --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupServiceAccountAccessListApiParams{}
sdkResp, httpResp, err := client.ServiceAccountsApi.
CreateGroupServiceAccountAccessListWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" \
-d '{ <Payload> }'[
{
"cidrBlock": "203.0.113.0/24",
"ipAddress": "203.0.113.10"
}
]{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"cidrBlock": "203.0.113.0/24",
"createdAt": "2026-05-04T09:42:00Z",
"ipAddress": "203.0.113.10",
"lastUsedAddress": "203.0.113.10",
"lastUsedAt": "2026-05-04T09:42:00Z",
"requestCount": 42
}
],
"totalCount": 42
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}