federationSettings 리소스 를 사용하면 지정된 연합의 지정된 조직 에서 모든 역할 매핑 을 반환할 수 있습니다.
필수 역할
이 엔드포인트를 호출하려면 Organization Owner 역할이 있어야 합니다.
Resource
기본 URL: https://cloud.mongodb.com/api/public/v1.0
GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings
요청
요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 페더레이션 인증 구성을 식별하는 고유한 24자리 16진수 문자열입니다. |
| 문자열 | 연결된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다. |
| ||||||
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
links
하나 이상의 하위 리소스 및/또는 관련 리소스(예:목록 페이지 매김 )에 대한 링크 를 나타내는 문서 배열입니다. 자세한 내용은 연결 을 참조하세요.
results
각각 하나의 역할 매핑을 나타내는 문서 배열입니다.
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 역할 매핑과 연결된 ID 제공자 그룹을 식별하는 사람이 읽을 수 있는 고유한 레이블입니다. |
| 문자열 | 역할 매핑을 식별하는 고유한 24자리 16진수 문자열입니다. |
| 배열 | 각 역할과 연결된 프로젝트 및 조직의 고유 식별자가 포함된 목록입니다. |
| 문자열 | 역할이 적용되는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. |
| 문자열 | 역할이 적용되는 조직을 식별하는 고유한 24자리 16진수 문자열입니다. |
| 문자열 | 역할을 식별하는 사람이 읽을 수 있는 레이블입니다. |
totalCount
결과 세트의 총 항목 수입니다. 전체 결과 집합이 페이지로 매겨진 경우 이 값은 results 배열의 객체 수보다 클 수 있습니다.
예시
요청
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings"
응답
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "externalGroupName": "autocomplete-highlight", "id": "61d88e15e6cc044270a36fce", "roleAssignments": [ { "groupId": null, "orgId": "{ORG-ID}", "role": "ORG_OWNER" }, { "groupId": "{GROUP-ID}", "orgId": null, "role": "GROUP_OWNER" } ] } ], "totalCount": 1 }