すべてのサービスアカウントの取得

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例
応答ヘッダー
レスポンス本体

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 /orgs/{ORG-ID}/serviceAccounts

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

名前	タイプ	説明
`ORG-ID`	string	サービスアカウントを取得する組織の一意の識別子。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。

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

次のクエリパラメータは任意です。

名前

タイプ

説明

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

なし

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、 `results`埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つのサービスアカウントです。

名前	タイプ	説明
`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" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts?pretty=true"

応答例

応答ヘッダー

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}

レスポンス本体

{
  "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
}

戻る

組織サービスアカウント

1 つのサービスアカウントを取得