YouTrack および Hub ヘルプの開発者ポータル

すべてのサービスプロバイダーのメタデータを取得する

リクエスト

GET [[[<REST API URL>|Hub-Rest-Api-URL.html]]]/saml2/serviceproviders?fields=string&amp;$skip=int&amp;$top=int&amp;query=string&amp;orderBy=string

パラメーター

説明

fields

オプション。各 ServiceProviderMetadata の指定されたフィールドのサブセットのみを返します。サブセットを定義するにはフィールド構文を使用します。

$skip

オプション。最初の ServiceProviderMetadata を返す前にスキップする ServiceProviderMetadata 数を設定できます。

$top

オプション。返される ServiceProviderMetadata の最大数を設定できます。

query

オプション。検索クエリを指定して、返される結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。ServiceProviderMetadatas では、以下のフィールドとタプルがサポートされています。

name : serviceProviderName — 名のあるサービスプロバイダー

samlEntityID : serviceProviderEntityId — 指定されたエンティティ ID を持つサービスプロバイダー

supports : logout response — ログアウト応答をサポートするすべてのサービスプロバイダー

url : assertionConsumerUrl — アサーションコンシューマー URL を持つサービスプロバイダー

orderBy

オプション。指定されたフィールドでソートされた ServiceProviderMetadata のリストを返します。詳細はソート構文を参照してください。ServiceProviderMetadata は、以下のフィールドによる並べ替えをサポートしています: entityId name

レスポンス

レスポンスコード

意味

200 OK

リクエストが成功しました。

400 不正な要求

リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。

403 禁止します

要求元は、要求されたリソースにアクセスできません。

404 お探しのページが見つかりませんでした

要求されたリソースが見つかりませんでした。

500 内部サーバーエラー

サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。

レスポンスボディ

{ "skip": int, "top": int, "total": int, "items": [[[[serviceProviderMetadata|HUB-REST-API_JSON-Scheme.html#serviceProviderMetadata]]], ...] }
2024 年 10 月 14 日