Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
フェデレーティッド認証

1 つのロール マッピングを返す

項目一覧

  • 必須のロール
  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例

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

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

必須のロール

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

Resource

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}

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

名前
タイプ
説明

FEDERATION-SETTINGS-ID

string

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

ORG-ID

string

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

ROLE-MAPPING-ID

string

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

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

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

false

リクエスト ボディ パラメータ

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

応答

名前
タイプ
説明

externalGroupName

string

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

id

string

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

roleAssignments

配列

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

roleAssignments.groupId

string

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

roleAssignments.orgId

string

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

roleAssignments.role

string

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

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}"

応答例

{
 "externalGroupName": "autocomplete-highlight",
 "id": "61d88e15e6cc044270a36fce",
 "roleAssignments": [
     {
         "groupId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "role": "ORG_OWNER"
     },
     {
         "groupId": "5f86fb2ff9c4e56d39502559",
         "orgId": null,
         "role": "GROUP_OWNER"
     }
 ]
}

戻る

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

次へ

すべての IdP を返す