ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/serviceAccountsリクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | サービス アカウントを取得する組織の一意の識別子。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
|
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | レスポンス本体を pretty-print 形式にするかどうかを示します。 |
|
envelope | ブール値 | レスポンスをエンベロープにラップするかどうかを示します。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのサービス アカウントです。
名前 | タイプ | 説明 |
|---|---|---|
| string | サービス アカウントのユニーク識別子です。 |
| string | サービス アカウントの説明。 使用可能な文字は、 |
| string | サービス アカウントの名前。 使用可能な文字は、 |
| タイムスタンプ | サービス アカウントの作成時間。 |
| オブジェクト配列 | サービス アカウント シークレットのリスト。 |
| string | シークレットを識別する一意の 24桁の 16 進数文字列。string |
| 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/orgs/{ORG-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/orgs/1234567890abcdef12345678/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=3", "rel": "self" } ], "results": [ { "createdAt": "2024-04-23T20:36:22Z", "description": "Service account for development team", "clientId": "mdb_sa_id_001", "name": "dev-team-sa", "roles": ["ORG_OWNER"], "secrets": [ { "createdAt": "2024-04-23T20:36:22Z", "expiresAt": "2024-12-01T00:00:00Z", "id": "secret_id_001", "lastUsedAt": "2024-04-23T20:49:19Z", "maskedSecretValue": "mdb_sa_sk_…OEyV" } ] }, { "createdAt": "2024-05-31T17:27:05Z", "description": "Service account for billing operations", "clientId": "mdb_sa_id_002", "name": "billing-sa", "roles": ["ORG_BILLING_ADMIN"], "secrets": [ { "createdAt": "2024-05-31T17:27:05Z", "expiresAt": "2025-05-31T17:27:05Z", "id": "secret_id_002", "maskedSecretValue": "mdb_sa_sk_…OTyG" } ] }, { "createdAt": "2024-06-04T18:31:42Z", "description": "Service account for project management", "clientId": "mdb_sa_id_003", "name": "project-mgmt-sa", "roles": ["ORG_MEMBER"], "secrets": [ { "createdAt": "2024-06-04T18:31:42Z", "expiresAt": "2024-09-02T18:31:42Z", "id": "secret_id_003", "maskedSecretValue": "mdb_sa_sk_…OWyP" } ] } ], "totalCount": 3}