プログラムによる Cloud Manager へのアクセス
APIのみを使用して組織またはプロジェクトへのプログラムによるアクセスを許可するには、 APIキーまたはサービス アカウントを作成します。これにより、ユーザー名とパスワードとして機能するキーとアクセス トークンがネットワーク経由で送信されることがなくなります。 APIキーと サービス アカウント
UIを介してCloud Managerにログするために使用することはできません。
APIキーとサービス アカウントで、エラーなくAPIエンドポイントを呼び出せるようにするには、ユーザーと同様にロールを付与する必要があります。
は 1 つの組織に属していますが、その組織内の任意の数のプロジェクトにアクセスできます。
これら 2 つの認証方法の詳細については、「 認証 」を参照してください。
プログラムによる組織へのアクセスを管理
組織へのプログラムによるアクセスの付与
APIキーまたはサービス アカウントを使用して、組織へのプログラムによるアクセスを許可するには、次の手順に従います。これら 2 つの認証方法の詳細については、「 認証 」を参照してください。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、{0Organization Settings ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
[Organizations] メニューの横にある [Organization Settings] アイコンをクリックします。
[ Organization Settings ]ページが表示されます。
Organization Access Managerページに移動します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
API Key Informationフォームを完了します。
Add API KeyページのAPI Key Informationステップから以下の操作を行います。
フィールド | 値 |
---|---|
説明 | 新しいAPIキーの説明を入力します。 |
組織権限 | API キーの 新しいロール を 選択します。 |
をクリックします。<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">Save
警告
このページを終了する前に秘密キーをコピーする
Cloud Manager は、このページにPrivate Keyを 1 回表示します。 [ Copyをクリックして、秘密キーをクリップボードに追加します。 この秘密キーを他のパスワードと同様に安全に保存します。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Organization Settings ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
[Organizations] メニューの横にある [Organization Settings] アイコンをクリックします。
[ Organization Settings ]ページが表示されます。
Organization Access Managerページに移動します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
サービス アカウント情報を入力します。
Nameと入力します。
Descriptionと入力します。
Client Secret Expiration メニューから期間を選択します。
[ Organization Permissions ] メニューから、サービス アカウントの 新しいロール を選択します。
をコピーして保存してください。<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\"Client Secret \">
クライアント シークレットは、アクセス トークンを作成するときにパスワードとして機能します。
警告
クライアントの秘密をすべて見ることができるのはこの時だけです。Copy をクリックして、安全な場所に保存します。それ以外の場合は、新しいクライアントシークレットを生成する必要があります。
組織へのプログラムによるアクセスの表示
組織へのアクセス権を持つすべてのAPIキーまたはサービス アカウントの詳細を表示できます。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Organization Settings ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
[Organizations] メニューの横にある [Organization Settings] アイコンをクリックします。
[ Organization Settings ]ページが表示されます。
Organization Access Managerページに移動します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Organization Settings ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
[Organizations] メニューの横にある [Organization Settings] アイコンをクリックします。
[ Organization Settings ]ページが表示されます。
Organization Access Managerページに移動します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
組織へのプログラムによるアクセスを更新
組織内のAPIキーまたはサービス アカウントのロール、説明、またはアクセス リストを変更できます。サービス アカウント用に新しいクライアントシークレットを生成することもできます。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Organization Settings ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
[Organizations] メニューの横にある [Organization Settings] アイコンをクリックします。
[ Organization Settings ]ページが表示されます。
Organization Access Managerページに移動します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
API Key Informationフォームを完了します。
Add API KeyページのAPI Key Informationステップから以下の操作を行います。
フィールド | 値 |
---|---|
説明 | 新しいAPIキーの説明を入力します。 |
組織権限 | API キーの 新しいロール を 選択します。 |
をクリックします。<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">Save
警告
このページを終了する前に秘密キーをコピーする
Cloud Manager は、このページにPrivate Keyを 1 回表示します。 [ Copyをクリックして、秘密キーをクリップボードに追加します。 この秘密キーを他のパスワードと同様に安全に保存します。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Organization Settings ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
[Organizations] メニューの横にある [Organization Settings] アイコンをクリックします。
[ Organization Settings ]ページが表示されます。
Organization Access Managerページに移動します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
Organization Permissionsを編集します。
[Edit Permissions] をクリックします。
Organization Permissionsメニューから、サービス アカウントの 新しいロール を選択します。
[Save and next] をクリックします。
重要
サービス アカウントの認証情報は、有効期限が切れるか、ユーザーが取り消すまでアクティブのままになります。
API Access Listを編集します。
Cloud Managerがこのサービス APIIPアカウントのAPIリクエストを受け入れるIPアドレスまたは CIDR ブロックを追加するには、[]Cloud ManagerAdd Access List Entry IPをクリックしてIPアドレスを入力します。
Use Current IP AddressCloud Managerにアクセスするために使用しているホストもこのサービス アカウントを使用してAPIリクエストを行う場合は、 をクリックすることもできます。
アクセス リストからIPアドレスを削除するには、クリックします許可されIP 。
[Save] をクリックします。
組織へのプログラムによるアクセスを取り消す
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Organization Settings ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
[Organizations] メニューの横にある [Organization Settings] アイコンをクリックします。
[ Organization Settings ]ページが表示されます。
Organization Access Managerページに移動します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Organization Settings ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
[Organizations] メニューの横にある [Organization Settings] アイコンをクリックします。
[ Organization Settings ]ページが表示されます。
Organization Access Managerページに移動します。
サイドバーの Access Manager をクリックします。
[ Organization Access Manager ]ページが表示されます。
プロジェクトへのプログラムによるアクセスを管理
プロジェクトへのプログラムによるアクセスの付与
APIキーまたはサービス アカウントのいずれかを使用して、プロジェクトへのプログラムによるアクセスを許可するには、次の手順に従います。これら 2 つの認証方法の詳細については、「 認証 」を参照してください。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Project Access Manager ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからProject Accessを選択します。
Projectsメニューの横にある次を展開します[ Options ] メニューで [] をクリックし、サイドバーの [ Access Manager Project Settingsをクリックします。
プロジェクト アクセス マネージャーページが表示されます。
API Key Informationフォームを完了します。
Add API KeyページのAPI Key Informationステップから以下の操作を行います。
フィールド | 値 |
---|---|
説明 | 新しいAPIキーの説明を入力します。 |
プロジェクト権限 | API キーの 新しいロール を 選択します。 |
をクリックします。<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">Save
警告
このページを終了する前に秘密キーをコピーする
Cloud Manager は、このページにPrivate Keyを 1 回表示します。 [ Copyをクリックして、秘密キーをクリップボードに追加します。 この秘密キーを他のパスワードと同様に安全に保存します。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Project Access Manager ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからProject Accessを選択します。
Projectsメニューの横にある次を展開します[ Options ] メニューで [] をクリックし、サイドバーの [ Access Manager Project Settingsをクリックします。
プロジェクト アクセス マネージャーページが表示されます。
サービス アカウント情報を入力します。
Nameと入力します。
Descriptionと入力します。
Client Secret Expiration メニューから期間を選択します。
[Project Permissions(プロジェクト権限)] メニューから、サービス アカウントの 新しいロール を選択します。
をコピーして保存してください。<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\"Client Secret \">
クライアント シークレットは、アクセス トークンを作成するときにパスワードとして機能します。
警告
クライアントの秘密をすべて見ることができるのはこの時だけです。Copy をクリックして、安全な場所に保存します。それ以外の場合は、新しいクライアントシークレットを生成する必要があります。
プロジェクトへのプログラムによるアクセスの表示
プロジェクトへのアクセス権を持つすべてのAPIキーまたはサービス アカウントの詳細を表示できます。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Project Access Manager ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからProject Accessを選択します。
Projectsメニューの横にある次を展開します[ Options ] メニューで [] をクリックし、サイドバーの [ Access Manager Project Settingsをクリックします。
プロジェクト アクセス マネージャーページが表示されます。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Project Access Manager ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからProject Accessを選択します。
Projectsメニューの横にある次を展開します[ Options ] メニューで [] をクリックし、サイドバーの [ Access Manager Project Settingsをクリックします。
プロジェクト アクセス マネージャーページが表示されます。
プロジェクトへのプログラムによるアクセスを更新
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Project Access Manager ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからProject Accessを選択します。
Projectsメニューの横にある次を展開します[ Options ] メニューで [] をクリックし、サイドバーの [ Access Manager Project Settingsをクリックします。
プロジェクト アクセス マネージャーページが表示されます。
API Key Informationフォームを完了します。
Add API KeyページのAPI Key Informationステップから以下の操作を行います。
フィールド | 値 |
---|---|
説明 | 新しいAPIキーの説明を入力します。 |
プロジェクト権限 | API キーの 新しいロール を 選択します。 |
をクリックします。<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">Save
警告
このページを終了する前に秘密キーをコピーする
Cloud Manager は、このページにPrivate Keyを 1 回表示します。 [ Copyをクリックして、秘密キーをクリップボードに追加します。 この秘密キーを他のパスワードと同様に安全に保存します。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Project Access Manager ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからProject Accessを選択します。
Projectsメニューの横にある次を展開します[ Options ] メニューで [] をクリックし、サイドバーの [ Access Manager Project Settingsをクリックします。
プロジェクト アクセス マネージャーページが表示されます。
Project Permissionsを編集します。
[Edit Permissions] をクリックします。
Project Permissionsメニューから、サービス アカウントの 新しいロール を選択します。
[Save and next] をクリックします。
重要
サービス アカウントの認証情報は、有効期限が切れるか、ユーザーが取り消すまでアクティブのままになります。
API Access Listを編集します。
Cloud Managerがこのサービス APIIPアカウントのAPIリクエストを受け入れるIPアドレスまたは CIDR ブロックを追加するには、[]Cloud ManagerAdd Access List Entry IPをクリックしてIPアドレスを入力します。
Use Current IP AddressCloud Managerにアクセスするために使用しているホストもこのサービス アカウントを使用してAPIリクエストを行う場合は、 をクリックすることもできます。
アクセス リストからIPアドレスを削除するには、クリックします許可されIP 。
[Save] をクリックします。
プロジェクトへのプログラムによるアクセスを取り消す
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Project Access Manager ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからProject Accessを選択します。
Projectsメニューの横にある次を展開します[ Options ] メニューで [] をクリックし、サイドバーの [ Access Manager Project Settingsをクリックします。
プロジェクト アクセス マネージャーページが表示されます。
MongoDB Cloud ManagerGoMongoDB Cloud Managerで、Project Access Manager ページにGoします。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。
次のいずれかの手順を行います。
ナビゲーション バーのAccess ManagerメニューからProject Accessを選択します。
Projectsメニューの横にある次を展開します[ Options ] メニューで [] をクリックし、サイドバーの [ Access Manager Project Settingsをクリックします。
プロジェクト アクセス マネージャーページが表示されます。
API リクエストを行う
Cloud Manager APIは、 APIキーまたはサービスアカウントの 2 つの認証方法のいずれかを使用してリクエストを認証します。次の手順を完了するには、希望認証方法を構成するときに保存したキーまたはシークレットが必要です。
リクエストは次の例のようになります。ここで、 {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" }'