이름으로 사용자 가져오기

이 페이지의 내용

Resource

요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

언제든지 자신의 사용자 계정을 조회할 수 있습니다. 그렇지 않으면 조회하려는 사용자와 공통된 하나 이상의 프로젝트에서 Project User Admin 역할이 있어야 합니다.

이 엔드포인트를 사용하여 API 키에 대한 정보를 반환할 수 없습니다. 이 정보를 얻으려면 하나의 API 키 가져오기 엔드포인트를 요청합니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /users/byName/{USER-NAME}

요청 경로 매개변수

Parameter	유형	설명
USER-NAME	문자열	(필수 사항) 조회하려는 MongoDB 사용자의 사용자 이름입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

false

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

HTTP 문서에는 다음 요소가 각각 포함되어 있습니다.

이름

유형

설명

이메일 주소

문자열

Cloud Manager 사용자의 이메일 주소입니다.

이름

문자열

Cloud Manager 사용자의 이름입니다.

문자열

Cloud Manager 사용자의 고유 식별자입니다.

성

문자열

Cloud Manager 사용자의 성입니다.

링크

객체 배열

관련 하위 리소스에 대한 링크입니다. 응답의 모든 links 배열에는 자체 링크가 하나 이상 포함되어 있습니다. URL 간의 관계는 웹 링크 사양에 설명되어 있습니다.

mobileNumber

문자열

Cloud Manager 사용자의 휴대폰 번호입니다.

roles

객체 배열

역할 할당입니다.

roles.groupId

문자열

사용자가 지정된 역할을 갖고 있는 프로젝트의 고유 식별자입니다.

roles.orgId

문자열

사용자가 지정된 역할을 갖고 있는 조직의 고유 식별자입니다.

roles.roleName

문자열

역할의 이름입니다. users 리소스는 사용자가 Cloud Manager와 MongoDB Atlas 모두에서 가지고 있는 모든 역할을 반환합니다.

유효한 값은 다음과 같습니다.

값	설명
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_BILLING_ADMIN`	`Organization Billing Admin`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_ATLAS_ADMIN`	`Project Admin (Atlas)`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_BILLING_ADMIN`	프로젝트 청구 관리자
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`

사용자 이름

문자열

Cloud Manager 사용자의 사용자 이름입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/users/byName/jane"

응답 예시

응답 헤더

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

응답 본문

{
  "emailAddress" : "jane@qa.example.com",
  "firstName" : "Jane",
  "id" : "533dc19ce4b00835ff81e2eb",
  "lastName" : "D'oh",
  "roles" : [ {
    "groupId" : "{PROJECT-ID}",
    "roleName" : "GROUP_USER_ADMIN"
  },{
    "orgId" : "55555bbe3bd5253aea2d9b16",
    "roleName" : "ORG_MEMBER"
  } ],
  "links" : [],
  "username": "jane"
}

돌아가기

ID 로 가져오기

액세스 목록