Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
サービス アカウント
/
プロジェクト アカウント

サービス アカウントのシークレットを作成

項目一覧

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

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

Resource

POST /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/secrets/

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

名前
タイプ
説明

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フィールドを追加します。

なし

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

この本体パラメーターは必須です。

名前
タイプ
説明

secretExpiresAfterHours

string

このサービス アカウントのシークレットが期限切れになる時間数。 最小値は 8 時間です。最大は 8766 時間（1 年）です。

応答

名前
タイプ
説明

id

string

シークレットを識別する一意の 24桁の 16 進数文字列。string

secret

string

サービス アカウント シークレット。作成時にのみ利用可能です。

createdAt

タイムスタンプ

作成時刻を表すタイムスタンプ。

expiresAt

タイムスタンプ

シークレットの有効期限を表すタイムスタンプ。

リクエストの例

注意

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/secrets/?pretty=true" \
     --data '{
      "secretExpiresAfterHours": "3600"
     }'

応答例

応答ヘッダー

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}

レスポンス本体

注意

レスポンス本体では secret は編集されていません。この例は、セキュリティ上の理由から編集されています。

{
  "createdAt" : "2024-08-08T22:19:45Z",
  "expiresAt" : "2025-01-05T22:19:45Z",
  "id" : "66b544825867ba071c85469d",
  "secret" : "mdb_sa_sk_...AOk5"
}

戻る

Unassign

次へ

シークレットを削除