サービスアカウントの更新

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

ベース URL: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}

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

名前	タイプ	説明
`ORG-ID`	string	サービスアカウントを更新する組織の一意の識別子。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。
`CLIENT-ID`	string	更新対象のサービスアカウントの一意な識別子です。 /orgs/{ORG- 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フィールドを追加します。

なし

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

名前

タイプ

説明

description

string

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

roles

string 配列

サービスアカウントが持つ必要があるロールのリスト。少なくとも 1 つのロールがリストされ、すべてのロールが組織に対して有効である必要があります。

組織ロールには、以下が含まれます。

API のロール値	ロール
`ORG_OWNER`	`Organization Owner`
`ORG_MEMBER`	`Organization Member`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_BILLING_ADMIN`	`Organization Billing Admin`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_BILLING_READ_ONLY`	`Organization Billing Viewer`

応答

名前	タイプ	説明
`clientId`	string	サービスアカウントのユニーク識別子です。
`description`	string	サービスアカウントの説明。使用可能な文字は、`A-Z` 、`a-z` 、`0-9` 、スペース、ピリオド `.` 、アスタリスク `'` 、カンマ`,` 、アンダースコア `_` 、ダッシュ `-` です。
`name`	string	サービスアカウントの名前。使用可能な文字は、`A-Z` 、`a-z` 、`0-9` 、スペース、ピリオド `.` 、アスタリスク `'` 、カンマ`,` 、アンダースコア `_` 、ダッシュ `-` です。
`createdAt`	タイムスタンプ	サービスアカウントの作成時間。
`secrets`	オブジェクト配列	サービスアカウントシークレットのリスト。
`secrets.id`	string	シークレットを識別する一意の 24桁の 16 進数文字列。string
`secrets.secret`	string	サービスアカウントシークレット。作成時にのみ利用可能です。
`secrets.maskedSecretValue`	string	プレフィックスと最後の 4 文字のみを表示するマスクされたシークレット。
`secrets.createdAt`	タイムスタンプ	シークレットの作成時間を表すタイムスタンプ。
`secrets.lastUsedAt`	タイムスタンプ	前回のシークレット使用を表すタイムスタンプ。
`secrets.expiresAt`	タイムスタンプ	シークレットの有効期限を表すタイムスタンプ。
`roles`	オブジェクト配列	組織内でサービスアカウントが持つロールです。組織ロールには、以下が含まれます。 `ORG_OWNER` `ORG_MEMBER` `ORG_GROUP_CREATOR` `ORG_BILLING_ADMIN` `ORG_READ_ONLY` `ORG_BILLING_READ_ONLY`

リクエストの例

注意

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}?pretty=true" \
     --data '{
       "description" : "Updated service account description",
       "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
     }'

応答例

応答ヘッダー

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}

レスポンス本体

{
  "createdAt" : "2024-05-31T17:27:05Z",
  "description" : "Updated service account description",
  "clientId" : "mdb_sa_id_665a086958c92d31a28d452e",
  "name" : "Audit Service Account",
  "roles" : [ "ORG_READ_ONLY", "ORG_MEMBER" ],
  "secrets" : [ {
    "createdAt" : "2024-05-31T17:27:05Z",
    "expiresAt" : "2025-05-31T17:27:05Z",
    "id" : "665a086958c92d31a28d452f",
    "maskedSecretValue" : "mdb_sa_sk_…OEyV"
  } ]
}

戻る

作成

削除