1 つのプロジェクトに割り当てられたすべての組織のサービス アカウントを取得
項目一覧
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
GET /groups/{PROJECT-ID}/serviceAccounts
リクエスト パス パラメーター
名前 | タイプ | 説明 |
---|---|---|
PROJECT-ID | string | 割り当てられた組織サービス アカウントを検索するプロジェクトの一意の識別子。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号(1 インデックス ベース)。 | 1 | ||||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 | 100 | ||||||
pretty | ブール値 | レスポンス本体を pretty-print にするかどうかを示します 形式。 | false | ||||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
---|---|---|
results | 配列 | 配列には、 results 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results
embeddedDocument
各結果は 1 つのプロジェクト サービス アカウントです。
名前 | タイプ | 説明 |
---|---|---|
clientId | string | サービス アカウントのユニーク識別子です。 |
createdAt | タイムスタンプ | サービス アカウントの作成時間。 |
name | string | サービス アカウントの名前。 |
description | string | サービス アカウントの説明。 |
roles | string 配列 | プロジェクト内でサービス アカウントが持つロールの一覧。 プロジェクト ロールには、以下が含まれます。 |
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 --include \ 4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts?pretty=true"
応答例
応答ヘッダー
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
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 "links": [ 3 { 4 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/66ae30345fe4416479e39269/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=100", 5 "rel": "self" 6 } 7 ], 8 "results": [ 9 { 10 "createdAt": "2024-08-03T14:02:40Z", 11 "description": "Service account for Cloud Manager users.", 12 "clientId": "mdb_sa_id_66ae38803cdf55582cb01144", 13 "name": "General Access", 14 "roles": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"], 15 "secrets": [ 16 { 17 "createdAt": "2024-08-03T14:02:40Z", 18 "expiresAt": "2024-12-31T14:02:40Z", 19 "lastUsedAt" : "2024-08-24T21:10:35Z", 20 "id": "66ae38803cdf55582cb01143", 21 "maskedSecretValue": "mdb_sa_sk_...hcOL" 22 } 23 ] 24 }, 25 { 26 "createdAt": "2024-08-03T14:05:20Z", 27 "description": "Service account for read access.", 28 "clientId": "mdb_sa_id_66ae38803cdf55582cb01145", 29 "name": "Read Only Access", 30 "roles": ["GROUP_READ_ONLY"], 31 "secrets": [ 32 { 33 "createdAt": "2024-08-03T14:05:20Z", 34 "expiresAt": "2024-12-31T14:05:20Z", 35 "lastUsedAt" : "2024-08-24T21:10:35Z", 36 "id": "66ae38803cdf55582cb01146", 37 "maskedSecretValue": "mdb_sa_sk_...jcOP" 38 } 39 ] 40 }, 41 { 42 "createdAt": "2024-08-03T14:10:00Z", 43 "description": "Service account for data backup.", 44 "clientId": "mdb_sa_id_66ae38803cdf55582cb01147", 45 "name": "Backup Access", 46 "roles": ["GROUP_DATA_BACKUP_ADMIN"], 47 "secrets": [ 48 { 49 "createdAt": "2024-08-03T14:10:00Z", 50 "expiresAt": "2024-12-31T14:10:00Z", 51 "lastUsedAt" : "2024-08-24T21:10:35Z", 52 "id": "66ae38803cdf55582cb01148", 53 "maskedSecretValue": "mdb_sa_sk_...kcQR" 54 } 55 ] 56 } 57 ], 58 "totalCount": 3 59 }