Cloud Manager에 대한 프로그래밍 방식의 액세스
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할 서비스 계정 을 만듭니다.
API 만 사용하여 조직 또는 프로젝트 에 프로그래밍 방식의 액세스 을 부여하려면 API 키 또는 서비스 계정을 만듭니다. 이렇게 하면 사용자 이름과 비밀번호 제공 을 하는 키와 액세스 토큰이 네트워크를 통해 전송되지 않습니다. API 키 및 서비스 계정:
UI 를 통해 Cloud Manager 에 로그 하는 데 사용할 수 없습니다.
API 키와 서비스 계정이 오류 없이 API 엔드포인트를 호출할 수 있도록 하려면 사용자에게 역할을 부여해야 합니다.
하나의 조직 에 속하지만 해당 조직 의 프로젝트 수에 관계없이 액세스 을 부여할 수 있습니다.
이 두 가지 인증 방법에 학습 보려면 인증을 참조하세요.
조직에 대한 프로그래밍 방식 액세스 관리
조직에 프로그래밍 방식 액세스 권한 부여
API 키 또는 서비스 계정을 통해 조직 에 프로그래밍 방식의 액세스 을 부여하려면 다음 절차를 따르세요. 이 두 가지 인증 방법에 학습 보려면 인증을 참조하세요.
MongoDB Cloud Manager 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
1} 메뉴 옆에 있는 아이콘을 클릭합니다.Organization Settings Organizations
조직 설정 페이지가 표시됩니다.
페이지로 고 (Go)Organization Access Manager 합니다.
사이드바에서 Access Manager를 클릭합니다.
조직 액세스 관리자 페이지가 표시됩니다.
API Key Information 양식을 작성합니다.
Add API Key 페이지의 API Key Information 단계에서 다음을 수행합니다.
필드 | 값 |
---|---|
설명 | 새 API 키에 대한 설명을 입력합니다. |
조직 권한 | API 키의 새 역할을 하나 이상 선택합니다. |
MongoDB Cloud Manager 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
1} 메뉴 옆에 있는 아이콘을 클릭합니다.Organization Settings Organizations
조직 설정 페이지가 표시됩니다.
페이지로 고 (Go)Organization Access Manager 합니다.
사이드바에서 Access Manager를 클릭합니다.
조직 액세스 관리자 페이지가 표시됩니다.
서비스 계정 정보를 입력합니다.
Name을(를) 입력합니다.
Description을(를) 입력합니다.
Client Secret Expiration 메뉴에서 기간을 선택합니다.
조직 권한 메뉴에서 서비스 계정의 새 역할 하나 이상 선택합니다.
조직에 대한 프로그래밍 방식 액세스 보기
조직 에 액세스 할 수 있는 모든 API 키 또는 서비스 계정의 세부 정보를 볼 수 있습니다.
MongoDB Cloud Manager 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
1} 메뉴 옆에 있는 아이콘을 클릭합니다.Organization Settings Organizations
조직 설정 페이지가 표시됩니다.
페이지로 고 (Go)Organization Access Manager 합니다.
사이드바에서 Access Manager를 클릭합니다.
조직 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
MongoDB Cloud Manager 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
1} 메뉴 옆에 있는 아이콘을 클릭합니다.Organization Settings Organizations
조직 설정 페이지가 표시됩니다.
페이지로 고 (Go)Organization Access Manager 합니다.
사이드바에서 Access Manager를 클릭합니다.
조직 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
Service Accounts을(를) 클릭합니다.
조직 에 액세스 할 수 있는 모든 서비스 계정이 나열됩니다.
서비스 계정의 이름을 클릭하면 다음을 포함한 세부 정보를 볼 수 있습니다.
서비스 계정에 대한 난독화된 클라이언트 비밀
클라이언트 시크릿이 마지막으로 사용된 날짜
클라이언트 시크릿이 생성된 날짜
서비스 계정이 API 에 액세스 할 수 있는 IP 주소
서비스 계정에 할당된 역할
조직에 대한 프로그래밍 방식 액세스 업데이트
조직 에서 API 키 또는 서비스 계정의 역할, 설명 또는 액세스 목록을 변경할 수 있습니다. 서비스 계정에 대한 새 클라이언트 비밀을 생성할 수도 있습니다.
MongoDB Cloud Manager 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
1} 메뉴 옆에 있는 아이콘을 클릭합니다.Organization Settings Organizations
조직 설정 페이지가 표시됩니다.
페이지로 고 (Go)Organization Access Manager 합니다.
사이드바에서 Access Manager를 클릭합니다.
조직 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
API Key Information 양식을 작성합니다.
Add API Key 페이지의 API Key Information 단계에서 다음을 수행합니다.
필드 | 값 |
---|---|
설명 | 새 API 키에 대한 설명을 입력합니다. |
조직 권한 | API 키의 새 역할을 하나 이상 선택합니다. |
MongoDB Cloud Manager 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
1} 메뉴 옆에 있는 아이콘을 클릭합니다.Organization Settings Organizations
조직 설정 페이지가 표시됩니다.
페이지로 고 (Go)Organization Access Manager 합니다.
사이드바에서 Access Manager를 클릭합니다.
조직 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
을(를)Organization Permissions 편집합니다.
Edit Permissions를 클릭합니다.
Organization Permissions 메뉴에서 서비스 계정의 새 역할 을 선택합니다.
Save and next를 클릭합니다.
중요
서비스 계정 자격 증명 은 만료되거나 사용자가 해지할 때까지 활성 상태로 유지됩니다.
조직에 대한 프로그래밍 방식 액세스 취소
MongoDB Cloud Manager 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
1} 메뉴 옆에 있는 아이콘을 클릭합니다.Organization Settings Organizations
조직 설정 페이지가 표시됩니다.
페이지로 고 (Go)Organization Access Manager 합니다.
사이드바에서 Access Manager를 클릭합니다.
조직 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
MongoDB Cloud Manager 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
1} 메뉴 옆에 있는 아이콘을 클릭합니다.Organization Settings Organizations
조직 설정 페이지가 표시됩니다.
페이지로 고 (Go)Organization Access Manager 합니다.
사이드바에서 Access Manager를 클릭합니다.
조직 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
프로젝트에 대한 프로그래밍 방식 액세스 managed
프로젝트에 프로그래밍 방식 액세스 권한 부여
API 키 또는 서비스 계정을 통해 프로젝트 에 프로그래밍 방식의 액세스 을 부여하려면 다음 절차를 따르세요. 이 두 가지 인증 방법에 학습 보려면 인증을 참조하세요.
MongoDB Cloud Manager 에서 Project Access Manager 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
다음 단계 중 하나를 수행합니다.
탐색 표시줄의 Access Manager 메뉴에서 Project Access 을 선택합니다.
Projects 메뉴 옆의 Options 메뉴를 확장하고 Project Settings을 클릭한 다음 사이드바에서 Access Manager를 클릭합니다.
프로젝트 액세스 관리자 페이지가 표시됩니다.
API Key Information 양식을 작성합니다.
Add API Key 페이지의 API Key Information 단계에서 다음을 수행합니다.
필드 | 값 |
---|---|
설명 | 새 API 키에 대한 설명을 입력합니다. |
프로젝트 권한 | API 키의 새 역할을 하나 이상 선택합니다. |
MongoDB Cloud Manager 에서 Project Access Manager 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
다음 단계 중 하나를 수행합니다.
탐색 표시줄의 Access Manager 메뉴에서 Project Access 을 선택합니다.
Projects 메뉴 옆의 Options 메뉴를 확장하고 Project Settings을 클릭한 다음 사이드바에서 Access Manager를 클릭합니다.
프로젝트 액세스 관리자 페이지가 표시됩니다.
서비스 계정 정보를 입력합니다.
Name을(를) 입력합니다.
Description을(를) 입력합니다.
Client Secret Expiration 메뉴에서 기간을 선택합니다.
프로젝트 권한 메뉴에서 서비스 계정의 새 역할 하나 이상 선택합니다.
프로젝트에 대한 프로그래밍 방식 액세스 보기
프로젝트 에 액세스 할 수 있는 모든 API 키 또는 서비스 계정의 세부 정보를 볼 수 있습니다.
MongoDB Cloud Manager 에서 Project Access Manager 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
다음 단계 중 하나를 수행합니다.
탐색 표시줄의 Access Manager 메뉴에서 Project Access 을 선택합니다.
Projects 메뉴 옆의 Options 메뉴를 확장하고 Project Settings을 클릭한 다음 사이드바에서 Access Manager를 클릭합니다.
프로젝트 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
MongoDB Cloud Manager 에서 Project Access Manager 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
다음 단계 중 하나를 수행합니다.
탐색 표시줄의 Access Manager 메뉴에서 Project Access 을 선택합니다.
Projects 메뉴 옆의 Options 메뉴를 확장하고 Project Settings을 클릭한 다음 사이드바에서 Access Manager를 클릭합니다.
프로젝트 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
Service Accounts을(를) 클릭합니다.
프로젝트 에 액세스 할 수 있는 모든 서비스 계정이 나열됩니다.
서비스 계정의 이름을 클릭하면 다음을 포함한 세부 정보를 볼 수 있습니다.
서비스 계정에 대한 난독화된 클라이언트 비밀
클라이언트 시크릿이 마지막으로 사용된 날짜
클라이언트 시크릿이 생성된 날짜
서비스 계정이 API 에 액세스 할 수 있는 IP 주소
서비스 계정에 할당된 역할
프로젝트에 대한 프로그래밍 방식 액세스 업데이트
MongoDB Cloud Manager 에서 Project Access Manager 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
다음 단계 중 하나를 수행합니다.
탐색 표시줄의 Access Manager 메뉴에서 Project Access 을 선택합니다.
Projects 메뉴 옆의 Options 메뉴를 확장하고 Project Settings을 클릭한 다음 사이드바에서 Access Manager를 클릭합니다.
프로젝트 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
API Key Information 양식을 작성합니다.
Add API Key 페이지의 API Key Information 단계에서 다음을 수행합니다.
필드 | 값 |
---|---|
설명 | 새 API 키에 대한 설명을 입력합니다. |
프로젝트 권한 | API 키의 새 역할을 하나 이상 선택합니다. |
MongoDB Cloud Manager 에서 Project Access Manager 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
다음 단계 중 하나를 수행합니다.
탐색 표시줄의 Access Manager 메뉴에서 Project Access 을 선택합니다.
Projects 메뉴 옆의 Options 메뉴를 확장하고 Project Settings을 클릭한 다음 사이드바에서 Access Manager를 클릭합니다.
프로젝트 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
을(를)Project Permissions 편집합니다.
Edit Permissions를 클릭합니다.
Project Permissions 메뉴에서 서비스 계정의 새 역할 을 선택합니다.
Save and next를 클릭합니다.
중요
서비스 계정 자격 증명 은 만료되거나 사용자가 해지할 때까지 활성 상태로 유지됩니다.
프로젝트에 대한 프로그래밍 방식 액세스 취소
MongoDB Cloud Manager 에서 Project Access Manager 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
다음 단계 중 하나를 수행합니다.
탐색 표시줄의 Access Manager 메뉴에서 Project Access 을 선택합니다.
Projects 메뉴 옆의 Options 메뉴를 확장하고 Project Settings을 클릭한 다음 사이드바에서 Access Manager를 클릭합니다.
프로젝트 액세스 관리자 페이지가 표시됩니다.
탭 을 API Keys 클릭합니다.
MongoDB Cloud Manager 에서 Project Access Manager 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
다음 단계 중 하나를 수행합니다.
탐색 표시줄의 Access Manager 메뉴에서 Project Access 을 선택합니다.
Projects 메뉴 옆의 Options 메뉴를 확장하고 Project Settings을 클릭한 다음 사이드바에서 Access Manager를 클릭합니다.
프로젝트 액세스 관리자 페이지가 표시됩니다.
탭 을 Applications 클릭합니다.
API 요청하기
Cloud Manager API 는 API 키 또는 서비스 계정이라는 두 가지 인증 방법 중 하나를 사용하여 요청을 인증합니다. 다음 절차를 완료하려면 선호하는 인증 방법을 구성할 때 저장한 키 또는 시크릿이 필요합니다.
요청은 다음 예시와 유사해야 하며, 여기서 {PUBLIC-KEY}
는 API 퍼블릭 키이고 {PRIVATE-KEY}
는 해당 프라이빗 키입니다.
다음 샘플 GET
요청 은 현재 사용자의 모든 프로젝트를 반환합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true"
다음 샘플 POST
요청 은 요청 본문을 가져와서 조직 에 MyProject
라는 프로젝트 를 만듭니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true" \ --data ' { "name": "MyProject", "orgId": "deffb2031b938da53f16d714" }'
서비스 계정을 사용하여 API 요청 을 수행하려면 서비스 계정을 사용하여 액세스 토큰을 생성한 다음 요청 에 액세스 토큰을 사용합니다.
서비스 계정의 클라이언트 시크릿을 조회합니다.
서비스 계정을 생성한 직후 저장한 mdb_sa_sk_
으)로 시작하는 클라이언트 시크릿을 찾습니다. 이 때만 클라이언트 시크릿을 볼 수 있었습니다. 클라이언트 시크릿을 저장하지 않은 경우 새 클라이언트 시크릿을 생성해야 합니다.
액세스 토큰을 요청합니다.
다음 예시 의 {BASE64-AUTH}
을 이전 단계의 출력으로 바꾼 다음 실행.
1 curl --request POST \ 2 --url https://cloud.mongodb.com/api/oauth/token \ 3 --header 'accept: application/json' \ 4 --header 'cache-control: no-cache' \ 5 --header 'authorization: Basic {BASE64-AUTH}' \ 6 --header 'content-type: application/x-www-form-urlencoded' \ 7 --data 'grant_type=client_credentials'
{"access_token":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImYyZjE2YmE4LTkwYjUtNDRlZS1iMWYLTRkNWE2OTllYzVhNyJ9eyJpc3MiOiJodHRwczovL2Nsb3VkLWRldi5tb25nb2RiLmNvbSIsImF1ZCI6ImFwaTovL2FkbWluIiwic3ViIjoibWRi3NhX2lkXzY2MjgxYmM2MDNhNzFhNDMwYjkwNmVmNyIsImNpZCI6Im1kYl9zYV9pZF82NjI4MWJjNjAzYTcxYTQzMGI5MZlZjciLCJhY3RvcklkIjoibWRiX3NhX2lkXzY2MjgxYmM2MDNhNzFhNDMwYjkwNmVmNyIsImlhdCI6MTcxMzkwNTM1OSiZXhwIjoxNzEzOTA4OTU5LCJqdGkiOiI4ZTg1MTM3YS0wZGU1LTQ0N2YtYTA0OS1hMmVmNTIwZGJhNTIifQAZSFvhcjwVcJYmvW6E_K5UnDmeiX2sJgL27vo5ElzeBuPawRciKkn6ervZ6IpUTx2HHllGgAAMmhaP9B66NywhfjAXC67X9KcOzm81DTtvDjLrFeRSc_3vFmeGvfUKKXljEdWBnbmwCwtBlO5SJuBxb1V5swAl-Sbq9Ymo4NbyepSnF""expires_in":3600,"token_type":"Bearer"}%
중요
액세스 토큰은 1 시간(3600 초) 동안 유효합니다. 액세스 토큰은 새로 고칠 수 없습니다. 이 액세스 토큰이 만료되면 이 단계를 반복하여 새 액세스 토큰을 생성합니다.
API 호출을 실행합니다.
다음 예시 의 {ACCESS-TOKEN}
을 이전 단계의 출력으로 바꿉니다. 예를 예시--header 'Authorization: Bearer eyJ...pSnF' \
입니다.
다음 샘플 GET
요청 은 현재 사용자의 모든 프로젝트를 반환합니다.
curl --request GET \ --url https://cloud.mongodb.com/api/public/v1.0/groups \ --header 'Authorization: Bearer {ACCESS-TOKEN}' \ --header 'Accept: application/json' \
다음 샘플 POST
요청 은 요청 본문을 가져와서 조직 에 MyProject
라는 프로젝트 를 만듭니다.
curl --header 'Authorization: Bearer {ACCESS-TOKEN}' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --include \ --request POST 'https://cloud.mongodb.com/api/public/v1.0/groups' \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'