AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

すべてのロールマッピングを返す

federationSettingsリソースを使用すると、指定されたフェデレーション内の指定された組織から、すべてのロールマッピングを返すことができます。

このエンドポイントを呼び出すには、 Organization Ownerロールが必要です。

ベース URL: https://cloud.mongodb.com/api/public/v1.0

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings
名前
タイプ
説明

FEDERATION-SETTINGS-ID

string

フェデレーション認証構成を識別する一意な 24 桁の 16 進数のstring 。

ORG-ID

string

接続済み組織を識別する一意な 24 桁の 16 進数のstring 。

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体をpretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

このエンドポイントは、HTTP リクエスト本体のパラメータを使用しません。

1 つ以上のサブリソースや関連リソース( リストページ 分割 など)への リンク を表すドキュメントの配列。詳細については、「リンク」を参照してください。

それぞれが 1 つのロール マッピングを表すドキュメントの配列。

名前
タイプ
説明

externalGroupName

string

ロール・マッピングに関連付けられた IdP グループを識別する、人間に判読可能な一意のラベル。

id

string

ロール マッピングを識別する一意な 24 桁の 16 進数のstring 。

roleAssignments

配列

各ロールに関連付けられているプロジェクトと組織の一意の識別子を含むリスト。

roleAssignments.groupId

string

ロールが適用されるプロジェクトを識別する一意な 24 桁の 16 進数のstring 。

roleAssignments.orgId

string

ロールが適用される組織を識別する一意な 24 桁の 16 進数のstring 。

roleAssignments.role

string

ロールを識別する、人間が判読可能なラベル。

結果セット内の項目の合計数。 結果セット全体がページ分割される場合、この値はresults配列内のオブジェクトの数よりも大きくなる可能性があります。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings"
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "externalGroupName": "autocomplete-highlight", "id": "61d88e15e6cc044270a36fce", "roleAssignments": [ { "groupId": null, "orgId": "{ORG-ID}", "role": "ORG_OWNER" }, { "groupId": "{GROUP-ID}", "orgId": null, "role": "GROUP_OWNER" } ] } ], "totalCount": 1}