Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
プロジェクトとユーザー
/
ユーザー

最初のユーザーを作成

項目一覧

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

最初の MongoDB Ops Manager ユーザーを作成します。 API キーがなくても、このエンドポイントを呼び出すこと ができ ます。

重要

例外

MongoDB Ops Manager は、このエンドポイントを通じて作成された最初の MongoDB Ops Manager プログラムAPIキーにGLOBAL_OWNERロールを付与します。 返されるJSONドキュメントには最初のプログラムAPIキーが含まれます。このキーを使用して、以降のAPI呼び出しを行うことができます。

このエンドポイントでは、プロジェクトや組織は作成されません。 作成された新しいプログラムAPIキーを使用して、 プロジェクトの作成エンドポイントを呼び出すことができます。 そのエンドポイントでは、1 回のAPI呼び出しでプロジェクトと組織を作成できます。 プロジェクトを作成した後まで、MongoDB Ops Manager にログインすることはできません。

このエンドポイントを使用して、次の警告を持つ追加のユーザーを作成できます。

  • MongoDB Ops Manager は、 API リクエストにロールを追加しない限り、後続のユーザーに GLOBAL_OWNER ロールを付与しません。

  • MongoDB Ops Manager は、後続のユーザー向けにプログラムAPIキーを作成しません。

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

Resource

POST /unauth/users

リクエスト パス パラメーター

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

リクエスト クエリ パラメータ

名前
タイプ
説明
accessList
string

最初の MongoDB Ops Manager ユーザーのアクセス リストに追加したい IP アドレス。

複数のaccessListパラメータと値を追加できます。

リクエスト ボディ パラメータ

名前
タイプ
必要性
説明
username
string
必須

最初の MongoDB Ops Manager ユーザーのユーザー名。 mms.email.validationプロパティの値に応じて検証されます。

値
説明
false
（デフォルト）ユーザー名はメールアドレスである必要はありません。
loose
ユーザー名には、@ 記号とそれに続くピリオドを含める必要があります。
strict
ユーザー名は、厳格なメールアドレス検証の正規表現に準拠する必要があります。

詳細については、「mms.email.validation」を参照してください。

usernameは通常、メールアドレスです。 この値をメールアドレスに設定する場合、 emailAddress値を明示的に設定する必要はありません。

password
string
必須
最初の MongoDB Ops Manager ユーザーのパスワード。 このフィールドは、 HTTP レスポンス本体に は含まれていません 。MongoDB Ops Manager は、最初の MongoDB Ops Manager ユーザーを作成するときにのみHTTPリクエストでこれを送信します。
emailAddress
string
任意
最初の MongoDB Ops Manager ユーザーのメールアドレス。
firstName
string
必須
最初の MongoDB Ops Manager ユーザーの名。
lastName
string
必須
最初の MongoDB Ops Manager ユーザーの姓。

応答

名前
タイプ
説明
programmaticApiKey
オブジェクト
で作成された最初のプログラムAPI MongoDB Ops Managerキーの詳細。
programmaticApiKey
.desc
string
最初のプログラムAPIキーの説明。
programmaticApiKey
.id
string
最初のプログラムAPIキーの一意の識別子。
programmaticApiKey
.links
オブジェクトの配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。

programmaticApiKey
.privateKey
string
最初のプログラムAPIキーのパスワードとして機能する 31 文字の英数字とダッシュ。
programmaticApiKey
.publicKey
string
最初のプログラムAPIキーのユーザー名として機能する 6 文字の英数字。
programmaticApiKey
.roles
オブジェクトの配列
最初のプログラム API キーに割り当てられた ロール 。
programmaticApiKey
.roles.roleName
string
割り当てられたロールの名前。 MongoDB Ops Manager は最初のプログラムAPIキーにGlobal Ownerロール（ GLOBAL_OWNER ）を付与します。
user
オブジェクト
最初の MongoDB Ops Manager ユーザーの詳細。
user
.emailAddress
string
最初の MongoDB Ops Manager ユーザーのメールアドレス。
user
.firstName
string
最初の MongoDB Ops Manager ユーザーの名。
user
.id
string
最初の MongoDB Ops Manager ユーザーの一意の識別子です。
user
.lastName
string
最初の MongoDB Ops Manager ユーザーの姓。
user
.links
オブジェクトの配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

user
.mobileNumber
string
最初の MongoDB Ops Manager ユーザーのモバイル番号。
user
.roles
オブジェクトの配列
最初の MongoDB Ops Manager ユーザーに割り当てられたロール。
user
.roles.roleName
string
割り当てられたロールの名前。 MongoDB Ops Manager は最初の MongoDB Ops Manager ユーザーにGlobal Ownerロール（ GLOBAL_OWNER ）を付与します。
user
.teamIds
文字列の配列
最初の MongoDB Ops Manager ユーザーが属するチームの一意の識別子のリスト。
user
.username
string
最初の MongoDB Ops Manager ユーザーのユーザー名。

リクエストの例

curl --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/unauth/users?pretty=true&accessList=1.2.3.4&accessList=2.3.4.5" \
     --data '
       {
         "username": "jane.doe@example.com",
         "password": "Passw0rd.",
         "firstName": "Jane",
         "lastName": "Doe"
       }'

応答例

応答ヘッダー

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 201 Created
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}

レスポンス本体

{
  "programmaticApiKey": {
    "desc": "Automatically generated Global API key",
    "id": "{API-KEY}",
    "links": [{
      "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY}",
      "rel": "self"
    }],
    "privateKey": "private key string",
    "publicKey": "public key string",
    "roles": [{
      "roleName": "GLOBAL_OWNER"
    }]
  },
  "user": {
    "emailAddress": "jane.doe@example.com",
    "firstName": "Jane",
    "id": "{USER-ID}",
    "lastName": "Doe",
    "links": [
      {
       "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}",
       "rel" : "self"
      }
    ],
    "roles": [
      {
        "roleName": "GLOBAL_OWNER"
      }
    ],
    "username": "jane.doe@example.com"
  }
}

戻る

1 人のユーザーのロールを更新

次へ

ユーザーを 1 人の削除