Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

名前を使用してユーザーを取得

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

注意

グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。

自分のユーザー アカウントはいつでも検索できます。 それ以外の場合は、 グローバル ユーザーであるか、取得するユーザーとの間で共通の少なくとも 1 つのプロジェクトでProject User Adminロールが必要です。

このエンドポイントを使用してAPI キーに関する情報を返すことはできません。 この情報を取得するには、 Get One API Keyエンドポイントをリクエストします。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /users/byName/{USER-NAME}
Parameter
タイプ
説明
ユーザー名
string
(必須。) 検索対象の MongoDB ユーザーのユーザー名。

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

HTTP ドキュメントには、次の各要素が含まれています。

名前
タイプ
説明
メールアドレス
string
MongoDB Ops Manager ユーザーのメールアドレス。
string
MongoDB Ops Manager ユーザーの名。
id
string
MongoDB Ops Manager ユーザーの一意の識別子です。
string
MongoDB Ops Manager ユーザーの姓。
Links
オブジェクト配列
関連するサブリソース へのリンク。 応答内のすべてのlinks配列には、自己と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。
mobileNumber
string
MongoDB Ops Manager ユーザーのモバイル番号。
役割
オブジェクト配列
ロールの割り当て。
role.groupId
string

指定されたロールを持つユーザーを持つプロジェクトの一意の識別子です。

「グローバル」ロール(名前がGLOBAL_で始まるロール)の場合、これらのロールはプロジェクトに関連付けられていないため、 groupIdはありません。

role.orgId
string
指定されたロールを持つユーザーが所属する組織の一意の識別子です。
role.roleName
string

ロールの名前。 値は次のとおりです。

説明
ORG_MEMBER
ORG_READ_ONLY
ORG_GROUP_CREATOR
ORG_OWNER
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
GLOBAL_AUTOMATION_ADMIN
GLOBAL_BACKUP_ADMIN
GLOBAL_MONITORING_ADMIN
GLOBAL_OWNER
GLOBAL_READ_ONLY
GLOBAL_USER_ADMIN
username
string
MongoDB Ops Manager ユーザーのユーザー名。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://<ops-manager-host>/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 でユーザーを取得