Concede acesso ao projeto especificado para a função de acesso especificada. Esse ponto de extremidade da API é uma etapa em um procedimento para criar acesso unificado aos serviços do MongoDB Cloud. Isso não é necessário para acessar a conta de serviço do GCP.
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
String exclusiva de 24dígitos hexadecimais que identifica a função. As funções IAM do Amazon Web Services (AWS) e as contas de serviço do Google retornam esse valor como roleId. As entidades de serviço do Azure o retornam como _id.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.
O valor padrão é false.
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é false.
Concede acesso ao projeto especificado para a role de acesso especificada.
Detalhes que descrevem os recursos vinculados à função Amazon Web Services (AWS) Identity e Access Management (IAM).
Rótulo legível por humanos que identifica o fornecedor de nuvem da função.
O valor é AWS.
Nome de recurso da Amazon (ARN) que identifica a função de gerenciamento de identidade e acesso (IAM) do Amazon Web Services (AWS) que o MongoDB Cloud considera quando acessa recursos em sua conta da AWS.
O comprimento mínimo é 20, o comprimento máximo é 2048.
Detalhes que descrevem as funcionalidades vinculadas ao Azure Service Principal.
Rótulo legível por humanos que identifica o fornecedor de nuvem da função.
O valor é AZURE.
ID do aplicativo do Azure Active Directory do Atlas. Este campo é opcional e será derivado da assinatura do Azure se não for fornecido.
String UUID que identifica o Azure Service Principal.
String de UUID que identifica a ID do inquilino do Azure Active Directory.
OK
Detalhes que descrevem os recursos vinculados à função Amazon Web Services (AWS) Identity e Access Management (IAM).
Rótulo legível por humanos que identifica o fornecedor de nuvem da função.
Nome do recurso da Amazon que identifica a conta de usuário do Amazon Web Services (AWS) que o MongoDB Cloud usa quando assume a função de gerenciamento de identidade e acesso (IAM).
O comprimento mínimo é 20, o comprimento máximo é 2048.
ID externa exclusiva que o MongoDB Cloud usa quando assume a função IAM em sua conta da Amazon Web Services (AWS).
Data e hora em que alguém autorizou esta função para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.
Data e hora em que alguém criou esta role para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.
Lista que contém recursos de aplicação associados a essa função do Amazon Web Services (AWS) Identity and Access Management (IAM).
Detalhes que descrevem os Atlas Data Lakes vinculados a essa função do Amazon Web Services (AWS) Identity e Access Management (IAM).
Rótulo legível por humanos que descreve um recurso do MongoDB Cloud vinculado a essa função do Amazon Web Services (AWS) Identity e Access Management (IAM).
O valor é ATLAS_DATA_LAKE.
Identificar características sobre o data lake vinculado a essa função do Amazon Web Services (AWS) Identity and Access Management (IAM).
Detalhes que descrevem a integração de log do Atlas vinculada a esta função de acesso do provedor de nuvem.
Rótulo legível por humanos que descreve um recurso do MongoDB Cloud vinculado a essa função do Amazon Web Services (AWS) Identity e Access Management (IAM).
O valor é ATLAS_LOG_INTEGRATION.
Identificando características sobre a integração de log do Atlas vinculada a essa função de acesso do provedor de nuvem.
string exclusiva de 24dígitos hexadecimais que identifica a configuração de integração de log do Atlas .
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
String única de 24 dígitos hexadecimais que identifica seu projeto.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Rótulo legível por humanos que identifica o coletor, como um bucket S3/GVS ou o nome de um contêiner Azure.
Detalhes que descrevem o Key Management Service (KMS) vinculado a essa função do Amazon Web Services (AWS) Identity and Access Management (IAM).
Rótulo legível por humanos que descreve um recurso do MongoDB Cloud vinculado a essa função do Amazon Web Services (AWS) Identity e Access Management (IAM).
O valor é ENCRYPTION_AT_REST.
Objeto que contém as características de identificação do Amazon Web Services (AWS) Key Management Service (KMS). Este campo sempre retorna um valor nulo.
Detalhes que descrevem os buckets de exportação do Amazon Web Services (AWS) Simple Storage Service (S3) vinculados a essa função do AWS Identity and Access Management (IAM).
Rótulo legível por humanos que descreve um recurso do MongoDB Cloud vinculado a essa função do Amazon Web Services (AWS) Identity e Access Management (IAM).
O valor é EXPORT_SNAPSHOT.
Identificando características sobre o bucket de exportação do Amazon Web Services (AWS) Simple Storage Service (S3) vinculado a esta função do AWS Identity and Access Management (IAM).
String única de 24dígitos hexadecimais que identifica o bucket da AWS S3 para o qual você exporta seus snapshots.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
String única de 24 dígitos hexadecimais que identifica seu projeto.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Detalhes que descrevem os endpoints privados de armazenamento de objetos vinculados a esta entidade de serviço do Azure. Este recurso está em acesso antecipado limitado: ele é habilitado por projeto por meio de um sinalizador de recurso e não está disponível para o público em geral. Entre em contato com o MongoDB para se tornar um dos primeiros usuários.
Rótulo legível por humanos que descreve um recurso do MongoDB Cloud vinculado a essa função do Amazon Web Services (AWS) Identity e Access Management (IAM).
O valor é OBJECT_STORAGE_PRIVATE_ENDPOINT.
Identificação das características do ponto de extremidade privado do armazenamento de objetos vinculado a esta entidade de serviço do Azure.
String única de 24 dígitos hexadecimais que identifica seu projeto.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies the object storage private endpoint.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Detalhes que descrevem os buckets de exportação do Amazon Web Services (AWS) Simple Storage Service (S3) vinculados a essa função do AWS Identity and Access Management (IAM).
Rótulo legível por humanos que descreve um recurso do MongoDB Cloud vinculado a essa função do Amazon Web Services (AWS) Identity e Access Management (IAM).
O valor é PUSH_BASED_LOG_EXPORT.
Identificando características sobre o bucket de exportação do Amazon Web Services (AWS) Simple Storage Service (S3) vinculado a esta função do AWS Identity and Access Management (IAM).
Nome de recurso da Amazon (ARN) que identifica a função de gerenciamento de identidade e acesso (IAM) do Amazon Web Services (AWS) que o MongoDB Cloud considera quando acessa recursos em sua conta da AWS.
O comprimento mínimo é 20, o comprimento máximo é 2048.
String única de 24 dígitos hexadecimais que identifica a role.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Detalhes que descrevem as funcionalidades vinculadas ao Azure Service Principal.
Rótulo legível por humanos que identifica o fornecedor de nuvem da função.
O valor é AZURE.
String exclusiva de 24dígitos hexadecimais que identifica a função. Passe este valor como o parâmetro de caminho roleId ao solicitar, atualizar ou remover este Azure Service Principal. Os Azure Service Principals retornam este identificador como _id, enquanto as funções do Amazon Web Services (AWS) IAM e as contas de serviço do Google o retornam como roleId.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
ID do aplicativo do Azure Active Directory do Atlas. Este campo é opcional e será derivado da assinatura do Azure se não for fornecido.
Data e hora em que este Service Principal do Azure foi criado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.
Lista que contém funcionalidades de aplicação associadas a esse Azure Service Principal.
Data e hora em que este Service Principal do Azure foi atualizado pela última vez. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.
String UUID que identifica o Azure Service Principal.
String de UUID que identifica a ID do inquilino do Azure Active Directory.
Detalhes que descrevem os recursos vinculados à Conta de Serviço GCP.
Rótulo legível por humanos que identifica o fornecedor de nuvem da função.
O valor é GCP.
Data e hora em que esta conta de serviço do Google foi criada. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.
Lista que contém recursos de aplicação associados a esta conta de serviço do Google.
Endereço de e-mail da conta do Google Service criada pelo Atlas.
O formato deve corresponder ao seguinte padrão: ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$.
String única de 24 dígitos hexadecimais que identifica a role.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Status de provisionamento da conta de serviço.
Os valores são IN_PROGRESS, COMPLETE, FAILED ou NOT_INITIATED.
Solicitação inválida.
Detalhes da solicitação inválida.
Descreve todas as violações em uma solicitação do cliente .
Descreve as condições ou os motivos específicos que causam cada tipo de erro.
O código de status HTTP retornado com este erro.
Código de erro do aplicativo retornado com esse erro.
Parâmetros usados para fornecer mais informações sobre o erro.
Políticas de recurso do Atlas que causaram a negação da solicitação. Retornado apenas quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.
Não mais do que 100 elementos.
Política de recurso do Atlas que causou a negação da solicitação.
String exclusiva de 24caracteres hexadecimais que identifica a Política de Recursos do Atlas.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Etiqueta legível por humanos que identifica a Política de Recursos do Atlas.
Mensagens de erro de aplicativo retornadas com este erro.
Não autorizado.
Detalhes da solicitação inválida.
Descreve todas as violações em uma solicitação do cliente .
Descreve as condições ou os motivos específicos que causam cada tipo de erro.
O código de status HTTP retornado com este erro.
Código de erro do aplicativo retornado com esse erro.
Parâmetros usados para fornecer mais informações sobre o erro.
Políticas de recurso do Atlas que causaram a negação da solicitação. Retornado apenas quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.
Não mais do que 100 elementos.
Política de recurso do Atlas que causou a negação da solicitação.
String exclusiva de 24caracteres hexadecimais que identifica a Política de Recursos do Atlas.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Etiqueta legível por humanos que identifica a Política de Recursos do Atlas.
Mensagens de erro de aplicativo retornadas com este erro.
Forbidden.
Detalhes da solicitação inválida.
Descreve todas as violações em uma solicitação do cliente .
Descreve as condições ou os motivos específicos que causam cada tipo de erro.
O código de status HTTP retornado com este erro.
Código de erro do aplicativo retornado com esse erro.
Parâmetros usados para fornecer mais informações sobre o erro.
Políticas de recurso do Atlas que causaram a negação da solicitação. Retornado apenas quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.
Não mais do que 100 elementos.
Política de recurso do Atlas que causou a negação da solicitação.
String exclusiva de 24caracteres hexadecimais que identifica a Política de Recursos do Atlas.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Etiqueta legível por humanos que identifica a Política de Recursos do Atlas.
Mensagens de erro de aplicativo retornadas com este erro.
Não encontrado.
Detalhes da solicitação inválida.
Descreve todas as violações em uma solicitação do cliente .
Descreve as condições ou os motivos específicos que causam cada tipo de erro.
O código de status HTTP retornado com este erro.
Código de erro do aplicativo retornado com esse erro.
Parâmetros usados para fornecer mais informações sobre o erro.
Políticas de recurso do Atlas que causaram a negação da solicitação. Retornado apenas quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.
Não mais do que 100 elementos.
Política de recurso do Atlas que causou a negação da solicitação.
String exclusiva de 24caracteres hexadecimais que identifica a Política de Recursos do Atlas.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Etiqueta legível por humanos que identifica a Política de Recursos do Atlas.
Mensagens de erro de aplicativo retornadas com este erro.
Conflito.
Detalhes da solicitação inválida.
Descreve todas as violações em uma solicitação do cliente .
Descreve as condições ou os motivos específicos que causam cada tipo de erro.
O código de status HTTP retornado com este erro.
Código de erro do aplicativo retornado com esse erro.
Parâmetros usados para fornecer mais informações sobre o erro.
Políticas de recurso do Atlas que causaram a negação da solicitação. Retornado apenas quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.
Não mais do que 100 elementos.
Política de recurso do Atlas que causou a negação da solicitação.
String exclusiva de 24caracteres hexadecimais que identifica a Política de Recursos do Atlas.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Etiqueta legível por humanos que identifica a Política de Recursos do Atlas.
Mensagens de erro de aplicativo retornadas com este erro.
Erro interno do servidor.
Detalhes da solicitação inválida.
Descreve todas as violações em uma solicitação do cliente .
Descreve as condições ou os motivos específicos que causam cada tipo de erro.
O código de status HTTP retornado com este erro.
Código de erro do aplicativo retornado com esse erro.
Parâmetros usados para fornecer mais informações sobre o erro.
Políticas de recurso do Atlas que causaram a negação da solicitação. Retornado apenas quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.
Não mais do que 100 elementos.
Política de recurso do Atlas que causou a negação da solicitação.
String exclusiva de 24caracteres hexadecimais que identifica a Política de Recursos do Atlas.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Etiqueta legível por humanos que identifica a Política de Recursos do Atlas.
Mensagens de erro de aplicativo retornadas com este erro.
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/cloudProviderAccess/{roleId}' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"providerName": "AWS",
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}'
{
"providerName": "AWS",
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}
{
"providerName": "AZURE",
"atlasAzureAppId": "string",
"servicePrincipalId": "string",
"tenantId": "string"
}
{
"providerName": "GCP"
}
{
"atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
"atlasAssumedRoleExternalId": "feb2dfc7-f760-4288-a403-01c7c2345005",
"authorizedDate": "2024-05-30T14:12:00Z",
"createdDate": "2024-05-30T14:11:00Z",
"featureUsages": [],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"providerName": "AWS",
"roleId": "32b6e34b3d91647abb20e7b8"
}
{
"_id": "32b6e34b3d91647abb20e7b8",
"atlasAzureAppId": "da5dd062-f3ca-4cb5-b86a-05f82203ab67",
"createdDate": "2024-05-30T14:11:00Z",
"featureUsages": [],
"lastUpdatedDate": "2024-05-30T14:12:00Z",
"providerName": "AZURE",
"servicePrincipalId": "ec8e7844-912d-4869-86e9-6d0dfca4b8af",
"tenantId": "4297fc77-1592-4de8-a6d5-a8c32401df87"
}
{
"createdDate": "2024-05-30T14:11:00Z",
"featureUsages": [],
"gcpServiceAccountForAtlas": "mongodb-atlas-1234567890123456@p-111111111111111111111111.iam.gserviceaccount.com",
"providerName": "GCP",
"roleId": "32b6e34b3d91647abb20e7b8",
"status": "COMPLETE"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"error": 400,
"errorCode": "VALIDATION_ERROR",
"reason": "Bad Request"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}
{
"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",
"error": 409,
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK",
"reason": "Conflict"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}