모든 클라우드 제공자 액세스 역할 반환

얻다 /api/atlas/v1.0/groups/{groupId}/cloudProviderAccess

지정된 프로젝트에 대한 액세스 권한이 있는 모든 클라우드 공급자 액세스 역할을 반환합니다.

역할 요구 사항
  • 프로젝트 소유자

경로 매개변수

  • groupId 문자열 필수 사항

    프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

    참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

쿼리 매개변수

  • envelope 부울

    애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

    기본값은 false 입니다.

  • pretty 부울

    응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

    기본값은 false 입니다.

    Prettyprint

응답

  • 200 application/json

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • awsIamRoles 배열[객체]

      MongoDB Cloud에 등록되고 권한이 부여된 Amazon Web Services (AWS) IAM 역할이 포함된 목록입니다.

      awsIamRoles 속성 숨기기 awsIamRoles 속성 표시 객체

      Amazon Web Services (AWS) ID 및 액세스 관리(IAM) 역할 에 연결된 기능을 설명하는 세부 정보입니다.

      • providerName 문자열 필수 사항 판별자

        역할의 클라우드 공급자를 식별하는 인간 판독 가능 레이블.

        값은 CloudProviderAccessRole입니다.

      • _id 문자열

        역할을 식별하는 고유한 24자리 16진수 문자열.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • atlasAzureAppId 문자열(uuid)

        Atlas 의 Azure Active Directory 애플리케이션 ID . 이 필드 는 선택 사항이며 제공하지 않는 경우 Azure 구독 에서 파생됩니다.

      • createdDate 문자열(날짜-시간)

        누군가가 지정된 cloud 서비스 제공자 에 대해 이 역할 만든 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • featureUsages 배열[객체]

        이 Amazon Web Services (AWS) ID 및 액세스 관리(IAM) 역할 과 관련된 애플리케이션 기능이 포함된 목록입니다.

        다음 중 하나입니다.
      • lastUpdatedDate 문자열(날짜-시간)

        이 Azure 서비스 주체가 마지막으로 업데이트된 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • 서비스 주체 ID 문자열(uuid)

        Azure 서비스 주체를 식별하는 UUID 문자열입니다.

      • 테넌트 ID 문자열(uuid)

        Azure Active Directory 테넌트 ID 식별하는 UUID 문자열입니다.

      • gcpServiceAccountForAtlas 문자열

        Atlas 에서 만든 Google 서비스 계정의 이메일 주소 .

        형식은 ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$ 패턴 과 일치해야 합니다.

      • roleId 문자열

        역할을 식별하는 고유한 24자리 16진수 문자열.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • 상태 문자열

        서비스 계정의 프로비저닝 상태입니다.

        값은 IN_PROGRESS, COMPLETE, FAILED 또는 NOT_INITIATED입니다.

      • atlasAWSAccountArn 문자열

        MongoDB Cloud가 ID 및 액세스 관리(IAM) 역할 맡을 때 사용하는 Amazon Web Services (AWS) 사용자 계정을 식별하는 Amazon 리소스 이름입니다.

        최소 길이는 20, 최대 길이는 2048입니다.

      • atlasAssumedRoleExternalId 문자열(uuid)

        MongoDB Cloud가 Amazon Web Services (AWS) 계정에서 IAM 역할 맡을 때 사용하는 고유한 외부 ID 입니다.

      • authorizedDate 문자열(날짜-시간)

        누군가가 지정된 cloud 서비스 제공자 에 대해 이 역할 승인한 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • iamAssumedRoleArn 문자열

        MongoDB Cloud가 AWS 계정의 리소스에 액세스할 때 가정하는 AWS(Amazon Web Services) IAM(ID 및 액세스 관리) 역할을 식별하는 ARN(Amazon 리소스 이름).

        최소 길이는 20, 최대 길이는 2048입니다.

    • azureServicePrincipals 배열[객체]

      MongoDB Cloud에 등록된 Azure 서비스 주체가 포함된 목록입니다.

      azureServicePrincipals 특성 숨기기 azureServicePrincipals 특성 표시 객체

      Azure 서비스 주체에 연결된 기능을 설명하는 세부 정보입니다.

      • providerName 문자열 필수 사항 판별자

        역할의 클라우드 공급자를 식별하는 인간 판독 가능 레이블.

      • atlasAWSAccountArn 문자열

        MongoDB Cloud가 ID 및 액세스 관리(IAM) 역할 맡을 때 사용하는 Amazon Web Services (AWS) 사용자 계정을 식별하는 Amazon 리소스 이름입니다.

        최소 길이는 20, 최대 길이는 2048입니다.

      • atlasAssumedRoleExternalId 문자열(uuid)

        MongoDB Cloud가 Amazon Web Services (AWS) 계정에서 IAM 역할 맡을 때 사용하는 고유한 외부 ID 입니다.

      • authorizedDate 문자열(날짜-시간)

        누군가가 지정된 cloud 서비스 제공자 에 대해 이 역할 승인한 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • createdDate 문자열(날짜-시간)

        이 Azure 서비스 주체가 생성된 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • featureUsages 배열[객체]

        이 Azure 서비스 주체와 연결된 애플리케이션 기능이 포함된 목록입니다.

        다음 중 하나입니다.
      • iamAssumedRoleArn 문자열

        MongoDB Cloud가 AWS 계정의 리소스에 액세스할 때 가정하는 AWS(Amazon Web Services) IAM(ID 및 액세스 관리) 역할을 식별하는 ARN(Amazon 리소스 이름).

        최소 길이는 20, 최대 길이는 2048입니다.

      • roleId 문자열

        역할을 식별하는 고유한 24자리 16진수 문자열.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • gcpServiceAccountForAtlas 문자열

        Atlas 에서 만든 Google 서비스 계정의 이메일 주소 .

        형식은 ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$ 패턴 과 일치해야 합니다.

      • 상태 문자열

        서비스 계정의 프로비저닝 상태입니다.

        값은 IN_PROGRESS, COMPLETE, FAILED 또는 NOT_INITIATED입니다.

      • _id 문자열

        역할을 식별하는 고유한 24자리 16진수 문자열.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • atlasAzureAppId 문자열(uuid)

        Atlas 의 Azure Active Directory 애플리케이션 ID . 이 필드 는 선택 사항이며 제공하지 않는 경우 Azure 구독 에서 파생됩니다.

      • lastUpdatedDate 문자열(날짜-시간)

        이 Azure 서비스 주체가 마지막으로 업데이트된 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • 서비스 주체 ID 문자열(uuid)

        Azure 서비스 주체를 식별하는 UUID 문자열입니다.

      • 테넌트 ID 문자열(uuid)

        Azure Active Directory 테넌트 ID 식별하는 UUID 문자열입니다.

    • gcpServiceAccounts 배열[객체]

      MongoDB Cloud에 등록되고 권한이 부여된 Google 서비스 계정이 포함된 목록입니다.

      gcpServiceAccounts 속성 숨기기 gcpServiceAccounts 속성 표시 객체

      GCP 서비스 계정에 연결된 기능을 설명하는 세부 정보입니다.

      • providerName 문자열 필수 사항 판별자

        역할의 클라우드 공급자를 식별하는 인간 판독 가능 레이블.

      • atlasAWSAccountArn 문자열

        MongoDB Cloud가 ID 및 액세스 관리(IAM) 역할 맡을 때 사용하는 Amazon Web Services (AWS) 사용자 계정을 식별하는 Amazon 리소스 이름입니다.

        최소 길이는 20, 최대 길이는 2048입니다.

      • atlasAssumedRoleExternalId 문자열(uuid)

        MongoDB Cloud가 Amazon Web Services (AWS) 계정에서 IAM 역할 맡을 때 사용하는 고유한 외부 ID 입니다.

      • authorizedDate 문자열(날짜-시간)

        누군가가 지정된 cloud 서비스 제공자 에 대해 이 역할 승인한 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • createdDate 문자열(날짜-시간)

        이 Google 서비스 계정이 생성된 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • featureUsages 배열[객체]

        이 Google 서비스 계정과 연결된 애플리케이션 기능이 포함된 목록입니다.

        다음 중 하나입니다.
      • iamAssumedRoleArn 문자열

        MongoDB Cloud가 AWS 계정의 리소스에 액세스할 때 가정하는 AWS(Amazon Web Services) IAM(ID 및 액세스 관리) 역할을 식별하는 ARN(Amazon 리소스 이름).

        최소 길이는 20, 최대 길이는 2048입니다.

      • roleId 문자열

        역할을 식별하는 고유한 24자리 16진수 문자열.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • _id 문자열

        역할을 식별하는 고유한 24자리 16진수 문자열.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • atlasAzureAppId 문자열(uuid)

        Atlas 의 Azure Active Directory 애플리케이션 ID . 이 필드 는 선택 사항이며 제공하지 않는 경우 Azure 구독 에서 파생됩니다.

      • lastUpdatedDate 문자열(날짜-시간)

        이 Azure 서비스 주체가 마지막으로 업데이트된 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • 서비스 주체 ID 문자열(uuid)

        Azure 서비스 주체를 식별하는 UUID 문자열입니다.

      • 테넌트 ID 문자열(uuid)

        Azure Active Directory 테넌트 ID 식별하는 UUID 문자열입니다.

      • gcpServiceAccountForAtlas 문자열

        Atlas 에서 만든 Google 서비스 계정의 이메일 주소 .

        형식은 ^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$ 패턴 과 일치해야 합니다.

      • 상태 문자열

        서비스 계정의 프로비저닝 상태입니다.

        값은 IN_PROGRESS, COMPLETE, FAILED 또는 NOT_INITIATED입니다.

  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

GET /API/Atlas/v1.0/groups/{groupId}/cloudProviderAccess
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/cloudProviderAccess' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
응답 예시(200)
{
  "awsIamRoles": [
    {
      "providerName": "CloudProviderAccessRole",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "createdDate": "2026-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "lastUpdatedDate": "2026-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string",
      "gcpServiceAccountForAtlas": "string",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "status": "IN_PROGRESS",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2026-05-04T09:42:00Z",
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
    }
  ],
  "azureServicePrincipals": [
    {
      "providerName": "string",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2026-05-04T09:42:00Z",
      "createdDate": "2026-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "gcpServiceAccountForAtlas": "string",
      "status": "IN_PROGRESS",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "lastUpdatedDate": "2026-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string"
    }
  ],
  "gcpServiceAccounts": [
    {
      "providerName": "string",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2026-05-04T09:42:00Z",
      "createdDate": "2026-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "lastUpdatedDate": "2026-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string",
      "gcpServiceAccountForAtlas": "string",
      "status": "IN_PROGRESS"
    }
  ]
}
응답 예시(401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
응답 예시(403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
응답 예시(404)
{
  "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"
}
응답 예시(500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}