ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/serviceAccountsリクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | 割り当てられた組織サービス アカウントを検索するプロジェクトの一意の識別子。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
|
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | レスポンス本体を pretty-print 形式にするかどうかを示します。 |
|
envelope | ブール値 | レスポンスをエンベロープにラップするかどうかを示します。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 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" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts?pretty=true"応答例
応答ヘッダー
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}レスポンス本体
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/66ae30345fe4416479e39269/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "createdAt": "2024-08-03T14:02:40Z", "description": "Service account for Cloud Manager users.", "clientId": "mdb_sa_id_66ae38803cdf55582cb01144", "name": "General Access", "roles": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"], "secrets": [ { "createdAt": "2024-08-03T14:02:40Z", "expiresAt": "2024-12-31T14:02:40Z", "lastUsedAt" : "2024-08-24T21:10:35Z", "id": "66ae38803cdf55582cb01143", "maskedSecretValue": "mdb_sa_sk_...hcOL" } ] }, { "createdAt": "2024-08-03T14:05:20Z", "description": "Service account for read access.", "clientId": "mdb_sa_id_66ae38803cdf55582cb01145", "name": "Read Only Access", "roles": ["GROUP_READ_ONLY"], "secrets": [ { "createdAt": "2024-08-03T14:05:20Z", "expiresAt": "2024-12-31T14:05:20Z", "lastUsedAt" : "2024-08-24T21:10:35Z", "id": "66ae38803cdf55582cb01146", "maskedSecretValue": "mdb_sa_sk_...jcOP" } ] }, { "createdAt": "2024-08-03T14:10:00Z", "description": "Service account for data backup.", "clientId": "mdb_sa_id_66ae38803cdf55582cb01147", "name": "Backup Access", "roles": ["GROUP_DATA_BACKUP_ADMIN"], "secrets": [ { "createdAt": "2024-08-03T14:10:00Z", "expiresAt": "2024-12-31T14:10:00Z", "lastUsedAt" : "2024-08-24T21:10:35Z", "id": "66ae38803cdf55582cb01148", "maskedSecretValue": "mdb_sa_sk_...kcQR" } ] } ], "totalCount": 3}