名前を使用してユーザーを取得
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
自分のユーザー アカウントはいつでも検索できます。 それ以外の場合は、取得するユーザーと取得するユーザー間で共通の少なくとも 1 つのプロジェクトにProject User Adminロールが必要です。
このエンドポイントを使用してAPI キーに関する情報を返すことはできません。 この情報を取得するには、 Get One API Keyエンドポイントをリクエストします。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /users/byName/{USER-NAME}
リクエスト パス パラメーター
Parameter | タイプ | 説明 |
|---|---|---|
ユーザー名 | string | （必須。） 検索対象の MongoDB ユーザーのユーザー名。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
HTTP ドキュメントには、次の各要素が含まれています。
名前 | タイプ | 説明 | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
メールアドレス | string | Cloud Manager ユーザーのメールアドレス。 | ||||||||||||||||||||||||||||||||||
名 | string | Cloud Manager ユーザーの名。 | ||||||||||||||||||||||||||||||||||
id | string | Cloud Manager ユーザーの一意の識別子です。 | ||||||||||||||||||||||||||||||||||
姓 | string | Cloud Manager ユーザーの姓。 | ||||||||||||||||||||||||||||||||||
Links | オブジェクト配列 | 関連するサブリソース へのリンク。 応答内のすべての | ||||||||||||||||||||||||||||||||||
mobileNumber | string | Cloud Manager ユーザーのモバイル番号。 | ||||||||||||||||||||||||||||||||||
役割 | オブジェクト配列 | ロールの割り当て。 | ||||||||||||||||||||||||||||||||||
role.groupId | string | 指定されたロールを持つユーザーを持つプロジェクトの一意の識別子です。 | ||||||||||||||||||||||||||||||||||
role.orgId | string | 指定されたロールを持つユーザーが所属する組織の一意の識別子です。 | ||||||||||||||||||||||||||||||||||
role.roleName | string | ロールの名前。 次の値が有効です。
| ||||||||||||||||||||||||||||||||||
username | string | 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"
応答例
応答ヘッダー
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
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" }