ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | サービス アカウントを更新するプロジェクトの一意の識別子です。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。 |
| string | 更新対象のサービス アカウントの一意な識別子です。 /groups/{PROJECT- ID}/serviceAccounts エンドポイントをリクエストして、指定されたプロジェクトで認証済みユーザーがアクセスできるすべてのサービス アカウントを取得します。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
|
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | レスポンス本体を pretty-print 形式にするかどうかを示します。 |
|
envelope | ブール値 | レスポンスをエンベロープにラップするかどうかを示します。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
body パラメーターは必須です。
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 任意 | サービス アカウントの名前。 使用可能な文字は、 |
| string | 任意 | サービス アカウントの説明。 使用可能な文字は、 |
| string 配列 | 必須 | サービス アカウントに付与するロールの一覧。最少1つのロールを提供する必要があります。提供されるロールはすべて、割り当てられたプロジェクトに対して有効である必要があります。
このサービス アカウントに含めるすべてのロールを含めます。 この配列にないロールは削除されます。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | サービス アカウントのユニーク識別子です。 |
| タイムスタンプ | サービス アカウントの作成時間。 |
| string | サービス アカウントの名前。 |
| string | サービス アカウントの説明。 |
| string 配列 | プロジェクト内でサービス アカウントが持つロールの一覧。 プロジェクト ロールには、以下が含まれます。 |
| オブジェクト配列 | サービス アカウント シークレットのリスト。 |
| string | シークレットを識別する一意の 24桁の 16 進数文字列。string |
| タイムスタンプ | シークレットの作成時間を表すタイムスタンプ。 |
| タイムスタンプ | シークレットの有効期限を表すタイムスタンプ。 |
| タイムスタンプ | 前回のシークレット使用を表すタイムスタンプ。 |
| string | プレフィックスと最後の 4 文字のみを表示するマスクされたシークレット。 |
リクエストの例
注意
リクエストを行うユーザーは、 {PUBLIC-KEY}:{PRIVATE-KEY}としてフォーマットできます。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}?pretty=true" \ --data '{ "roles": [ "GROUP_OWNER" ] }'応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "createdAt" : "2024-08-04T01:16:21Z", "description" : "Service account for Cloud Manager users.", "clientId" : "mdb_sa_id_66aed6653e07126244a84cc1", "name" : "Cloud Manager service account", "roles" : [ "GROUP_OWNER" ], "secrets" : [ { "createdAt" : "2024-08-04T01:16:21Z", "expiresAt" : "2024-11-02T01:16:21Z", "lastUsedAt" : "2024-08-24T21:10:35Z", "id" : "66aed6653e07126244a84cc0", "maskedSecretValue" : "mdb_sa_sk_...MeyM" } ]}