1 つのプロジェクトサービスアカウントの詳細を変更

項目一覧

Resource

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

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

PATCH /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}

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

名前	タイプ	説明
`PROJECT-ID`	string	サービスアカウントを更新するプロジェクトの一意の識別子です。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
`CLIENT-ID`	string	更新対象のサービスアカウントの一意な識別子です。 /groups/{PROJECT- ID}/serviceAccounts エンドポイントをリクエストして、指定されたプロジェクトで認証済みユーザーがアクセスできるすべてのサービスアカウントを取得します。

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

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

名前

タイプ

説明

default

pageNum

integer

ページ番号（1 インデックスベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

レスポンス本体を pretty-print にするかどうかを示します形式。

false

envelope

ブール値

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体にstatusフィールドを追加します。

なし

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

body パラメーターは必須です。

名前

タイプ

必要性

説明

name

string

任意

サービスアカウントの名前。使用可能な文字は、A-Z 、a-z 、0-9 、スペース、ピリオド . 、アスタリスク ' 、カンマ, 、アンダースコア _ 、ダッシュ - です。

description

string

任意

サービスアカウントの説明。使用可能な文字は、A-Z 、a-z 、0-9 、スペース、ピリオド . 、アスタリスク ' 、カンマ, 、アンダースコア _ 、ダッシュ - です。

roles

string 配列

必須

サービスアカウントに付与するロールのリスト。少なくとも 1 つのロールを指定する必要があります。提供されたロールは、割り当てられたプロジェクトに対して有効である必要があります。

API のロール値	ロール
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup 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`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`

このサービスアカウントに含めるすべてのロールを含めます。この配列にないロールは削除されます。

応答

名前	タイプ	説明
`clientId`	string	サービスアカウントのユニーク識別子です。
`createdAt`	タイムスタンプ	サービスアカウントの作成時間。
`name`	string	サービスアカウントの名前。
`description`	string	サービスアカウントの説明。
`roles`	string 配列	プロジェクト内でサービスアカウントが持つロールの一覧。プロジェクトロールには、以下が含まれます。 `GROUP_AUTOMATION_ADMIN` `GROUP_BACKUP_ADMIN` `GROUP_BILLING_ADMIN` `GROUP_DATA_ACCESS_ADMIN` `GROUP_DATA_ACCESS_READ_ONLY` `GROUP_DATA_ACCESS_READ_WRITE` `GROUP_MONITORING_ADMIN` `GROUP_OWNER` `GROUP_READ_ONLY` `GROUP_USER_ADMIN`
`secrets`	オブジェクト配列	サービスアカウントシークレットのリスト。
`secrets.id`	string	シークレットを識別する一意の 24桁の 16 進数文字列。string
`secrets.createdAt`	タイムスタンプ	シークレットの作成時間を表すタイムスタンプ。
`secrets.expiresAt`	タイムスタンプ	シークレットの有効期限を表すタイムスタンプ。
`secrets.lastUsedAt`	タイムスタンプ	前回のシークレット使用を表すタイムスタンプ。
`secrets.maskedSecretValue`	string	プレフィックスと最後の 4 文字のみを表示するマスクされたシークレット。

リクエストの例

注意

リクエストを行うユーザーは、 {PUBLIC-KEY}:{PRIVATE-KEY}としてフォーマットできます。

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}?pretty=true" \
6      --data '{
7          "roles": [ "GROUP_OWNER" ]
8        }'

応答例

応答ヘッダー

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}

レスポンス本体

1 {
2   "createdAt" : "2024-08-04T01:16:21Z",
3   "description" : "Service account for Cloud Manager users.",
4   "clientId" : "mdb_sa_id_66aed6653e07126244a84cc1",
5   "name" : "Cloud Manager service account",
6   "roles" : [ "GROUP_OWNER" ],
7   "secrets" : [ {
8     "createdAt" : "2024-08-04T01:16:21Z",
9     "expiresAt" : "2024-11-02T01:16:21Z",
10     "lastUsedAt" : "2024-08-24T21:10:35Z",
11     "id" : "66aed6653e07126244a84cc0",
12     "maskedSecretValue" : "mdb_sa_sk_...MeyM"
13   } ]
14 }

戻る

を割り当てる

Unassign

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}?pretty=true" \
6	--data '{
7	"roles": [ "GROUP_OWNER" ]
8	}'

1	{
2	"createdAt" : "2024-08-04T01:16:21Z",
3	"description" : "Service account for Cloud Manager users.",
4	"clientId" : "mdb_sa_id_66aed6653e07126244a84cc1",
5	"name" : "Cloud Manager service account",
6	"roles" : [ "GROUP_OWNER" ],
7	"secrets" : [ {
8	"createdAt" : "2024-08-04T01:16:21Z",
9	"expiresAt" : "2024-11-02T01:16:21Z",
10	"lastUsedAt" : "2024-08-24T21:10:35Z",
11	"id" : "66aed6653e07126244a84cc0",
12	"maskedSecretValue" : "mdb_sa_sk_...MeyM"
13	} ]
14	}