ジャンプ先

• リクエスト
• レスポンス

このフェデレーション・サービスの表示

get

/management/weblogic/{version}/serverConfig/serverTemplates/{name}/federationServices

このフェデレーション・サービスを表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスのnameプロパティ。
• version: string
  WebLogic RESTインタフェースのバージョン。

問合せパラメータ

• excludeFields(optional): string
  'excludeFields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前がリストにないフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('fields'問合せパラメータが指定されていない場合)。ノート: 'excludeFields'が指定されている場合、'fields'を指定しないでください。
• excludeLinks(optional): string
  'excludeLinks'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('links'問合せパラメータが指定されていない場合)。ノート: 'excludeLinks'が指定されている場合、'links'を指定しないでください。
• fields(optional): string
  'fields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('excludeFields'問合せパラメータが指定されていない場合)。ノート: 'fields'が指定されている場合、'excludeFields'を指定しないでください。
• links(optional): string
  'links'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('excludeLinks'問合せパラメータが指定されていない場合)。ノート: 'links'が指定されている場合、'excludeLinks'を指定しないでください。

セキュリティ

• Admin: basic
  型: Basic

  説明: A user in the Admin security role.
• デプロイヤ: 基本
  型: Basic

  説明: A user in the Deployer security role.
• モニター: 基本
  型: Basic

  説明: A user in the Monitor security role.
• オペレータ: 基本
  型: Basic

  説明: A user in the Operator security role.

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

このフェデレーション・サービスを返します。

本文()

ルート・スキーマ : フェデレーション・サービス

型: object

ソースの表示

• ACSRequiresSSL(optional): boolean
  デフォルト値: true

  アサーション・コンシューマ・サービスにSSLが必要かどうかを指定します。

• allowedTargetHosts(optional): array 項目
  タイトル: Items

  SAML SPターゲットのリダイレクトURLのホストと比較するホストのリスト。リストが空の場合、ターゲットのリダイレクトURLはチェックされません。

• ARSRequiresSSL(optional): boolean
  デフォルト値: true

  アサーション検索サービスにSSLが必要かどうかを指定します。

• ARSRequiresTwoWaySSL(optional): boolean
  デフォルト値: false

  アサーション検索サービスに双方向SSL認証が必要かどうかを指定します。

• assertionConsumerURIs(optional): array 項目
  タイトル: Items

  アサーション・コンシューマURI。

• assertionRetrievalURIs(optional): array 項目
  タイトル: Items

  受信するアサーション取得リクエストをリスニングするための1つ以上のURI。

  アーティファクト・プロファイルの場合、宛先サイトでは、ソース・サイト(ソース・サイトのID値が必要)とアサーションIDを表すSAMLアーティファクトを受信し、ソース・サイトのアサーション検索URLに、そのアーティファクトを含むリクエストを送信します。ソース・サイトでは、対応するアサーションに応答します。複数のURIを構成できますが、通常は1つで十分です。URIは、アプリケーション・コンテキストとリソース・コンテキストで構成されます。次に例を示します。

  /my_application/saml/ars

  これはhttps://my.example.com/my_application/saml/arsとして外部からアクセス可能です。

• assertionStoreClassName(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@4e3c3ebc

  デフォルト・クラス以外のアサーション・ストア・クラスを使用した場合に、アサーション用の永続ストレージを提供するクラス。

• assertionStoreProperties(optional): object プロパティ
  タイトル: Properties

  使用可能なその他のプロパティ: additionalProperties

  Assertion StoreクラスのinitStore()メソッドに渡されるプロパティ。

  カスタムAssertion Storeクラスを実装している場合に便利です。

• destinationSiteEnabled(optional): boolean
  デフォルト値: false

  宛先サイトが有効かどうかを指定します。

• dynamicallyCreated(optional): boolean
  読取り専用: true

  デフォルト値: false

  MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます

• id(optional): integer(int64)
  読取り専用: true

  このMBeanインスタンスの一意のIDを返します

• intersiteTransferURIs(optional): array 項目
  タイトル: Items

  サイト間転送URI。

• ITSRequiresSSL(optional): boolean
  デフォルト値: true

  サイト間転送サービスにSSLが必要かどうかを指定します。

• name(optional): string
  読取り専用: true

  このMBeanインスタンスのユーザー定義の名前。

  この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています

  Name=user-specified-name

  制約

  • 有効なnull
• notes(optional): string

  この構成の説明として任意に入力できる情報。

  WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

  ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• POSTOneUseCheckEnabled(optional): boolean
  デフォルト値: true

  POSTの使用を1回にするチェックが有効かどうかを指定します。

• POSTRecipientCheckEnabled(optional): boolean
  デフォルト値: true

  POST宛先のチェックが有効化されるかどうかを指定します。trueに設定されている場合、SAMLレスポンスの宛先は、HTTPリクエストのURLと一致している必要があります。

• signingKeyAlias(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@9dfd5c5

  ソース・サイトの署名キーをキーストアに格納し、キーストアから取得するための別名。このキーは、POSTプロファイル・レスポンスの署名に使用されます。

• signingKeyPassPhrase(optional): string(password)

  ソース・サイトの署名キーをキーストアから取得するためのパスフレーズ。

• sourceIdBase64(optional): string
  読取り専用: true

  base64エンコード形式のソース・サイトID。

  この読取り専用の値は、SourceSiteURLから算出される20バイトのバイナリ値をBase64で表したものです。他のサイトでアーティファクト・プロファイルを構成する場合は、SourceId値をまた別のサイトに与える必要があります。この値は、SourceSiteURLが変更されると、自動的に更新されます。

• sourceIdHex(optional): string
  読取り専用: true

  16進数によるソース・サイトID。

  この読取り専用の値は、SourceSiteURLから算出される20バイトのバイナリ値を16進数で表したものです。他のサイトでアーティファクト・プロファイルを構成する場合は、SourceId値をまた別のサイトに与える必要があります。この値は、SourceSiteURLが変更されると、自動的に更新されます。

• sourceSiteEnabled(optional): boolean
  デフォルト値: false

  ソース・サイトが有効化されているかどうかを示します。

• sourceSiteURL(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@37fa4179

  ソース・サイトのURL。

• SSLClientIdentityAlias(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@4e9bcce5

  宛先サイトのSSLクライアント・アイデンティティをキーストアに格納し、キーストアから取得するための別名。

• SSLClientIdentityPassPhrase(optional): string(password)

  宛先サイトのSSLクライアントIDをキーストアから取得するためのパスフレーズ。

• tags(optional): array 項目
  タイトル: Items

  この構成MBeanのすべてのタグを返します

• type(optional): string
  読取り専用: true

  MBeanのタイプを戻します。

  制約

  • 収集不可
• usedAssertionCacheClassName(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@4c6182b8

  使用済アサーション・キャッシュの永続ストアとして使用されるクラス。クラスが指定されていない場合、デフォルトの使用済アサーション・キャッシュ実装が使用されます。

• usedAssertionCacheProperties(optional): object プロパティ
  タイトル: Properties

  使用可能なその他のプロパティ: additionalProperties

  使用済みアサーション・キャッシュ・クラスに渡されるプロパティ。

{
    "type":"object",
    "properties":{
        "ACSRequiresSSL":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether the Assertion Consumer Service requires SSL.</p>"
        },
        "ARSRequiresSSL":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether the Assertion Retrieval Service requires SSL.</p>"
        },
        "ARSRequiresTwoWaySSL":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the Assertion Retrieval Service requires two-way SSL authentication.</p>"
        },
        "ITSRequiresSSL":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether the Intersite Transfer Service requires SSL.</p>"
        },
        "POSTOneUseCheckEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether the POST one-use check is enabled.</p>"
        },
        "POSTRecipientCheckEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether the POST recipient check is enabled. When true, the recipient of the SAML Response must match the URL in the HTTP Request.</p>"
        },
        "SSLClientIdentityAlias":{
            "default":null,
            "type":"string",
            "description":"<p>The alias used to store and retrieve the Destination Site's SSL client identity in the keystore.</p>"
        },
        "SSLClientIdentityPassPhrase":{
            "type":"string",
            "format":"password",
            "description":"<p>The passphrase used to retrieve the Destination Site's SSL client identity from the keystore.</p>"
        },
        "allowedTargetHosts":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>List of hosts to compare against the host in the SAML SP target redirect URL. When the list is empty, the target redirect URL will not be checked.</p>"
        },
        "assertionConsumerURIs":{
            "default":[
                "/samlacs/acs"
            ],
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The Assertion Consumer URIs.</p>"
        },
        "assertionRetrievalURIs":{
            "default":[
                "/samlars/ars"
            ],
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>One or more URIs on which to listen for incoming assertion retrieval requests.</p><p>For artifact profile, the destination site receives a SAML artifact that represents a source site (why we need the source site ID values) and an assertion ID. The destination site sends a request containing the artifact to the source site's assertion retrieval URL, and the source site responds with the corresponding assertion. You may configure multiple URIs here, although typically one will be sufficient. The URI includes the application context, followed by the resource context. For example:</p><p><code> /my_application/saml/ars</code></p><p>which would be accessible from the outside as <code>https://my.example.com/my_application/saml/ars</code></p>"
        },
        "assertionStoreClassName":{
            "default":null,
            "type":"string",
            "description":"<p>The class that provides persistent storage for assertions, if you use an Assertion Store class other than the default class.</p>"
        },
        "assertionStoreProperties":{
            "default":null,
            "type":"object",
            "description":"<p>Properties passed to Assertion Store class initStore() method.</p><p>This may be useful if you have implemented a custom Assertion Store class.</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "destinationSiteEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the Destination Site is enabled.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "intersiteTransferURIs":{
            "default":[
                "/samlits_ba/its",
                "/samlits_ba/its/post",
                "/samlits_ba/its/artifact",
                "/samlits_cc/its",
                "/samlits_cc/its/post",
                "/samlits_cc/its/artifact"
            ],
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The Intersite Transfer URIs.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "signingKeyAlias":{
            "default":null,
            "type":"string",
            "description":"<p>The alias used to store and retrieve the Source Site's signing key in the keystore. This key is used to sign POST profile responses.</p>"
        },
        "signingKeyPassPhrase":{
            "type":"string",
            "format":"password",
            "description":"<p>The passphrase used to retrieve the Source Site's signing key from the keystore.</p>"
        },
        "sourceIdBase64":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The Source Site ID base64-encoded.</p><p>This read-only value is a Base64 representation of a 20-byte binary value that is calculated from the <code>SourceSiteURL</code>. If you want to configure ARTIFACT profile with another site, you will need to give a <code>SourceId</code> value to the other site. This value is automatically updated when the <code>SourceSiteURL</code> changes.</p>"
        },
        "sourceIdHex":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The Source Site ID in hexadecimal.</p><p>This read-only value is a hexadecimal representation of a 20-byte binary value that is calculated from the <code>SourceSiteURL</code>. If you want to configure ARTIFACT profile with another site, you will need to give a <code>SourceId</code> value to the other site. This value is automatically updated when the <code>SourceSiteURL</code> changes.</p>"
        },
        "sourceSiteEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Indicates whether the Source Site is enabled.</p>"
        },
        "sourceSiteURL":{
            "default":null,
            "type":"string",
            "description":"<p>The URL for the Source Site.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "usedAssertionCacheClassName":{
            "default":null,
            "type":"string",
            "description":"<p>The class used as the persistent store for the Used Assertion Cache. When no class is specified, the default Used Assertion Cache implementation is used.</p>"
        },
        "usedAssertionCacheProperties":{
            "default":null,
            "type":"object",
            "description":"<p>Properties to be passed to the Used Assertion Cache class.</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        }
    },
    "description":""
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

SAML SPターゲットのリダイレクトURLのホストと比較するホストのリスト。リストが空の場合、ターゲットのリダイレクトURLはチェックされません。

ソースの表示

• 配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>List of hosts to compare against the host in the SAML SP target redirect URL. When the list is empty, the target redirect URL will not be checked.</p>"
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

アサーション・コンシューマURI。

デフォルト値: [ "/samlacs/acs" ]

ソースの表示

• 配列: string

{
    "default":[
        "/samlacs/acs"
    ],
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The Assertion Consumer URIs.</p>"
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

受信するアサーション取得リクエストをリスニングするための1つ以上のURI。

アーティファクト・プロファイルの場合、宛先サイトでは、ソース・サイト(ソース・サイトのID値が必要)とアサーションIDを表すSAMLアーティファクトを受信し、ソース・サイトのアサーション検索URLに、そのアーティファクトを含むリクエストを送信します。ソース・サイトでは、対応するアサーションに応答します。複数のURIを構成できますが、通常は1つで十分です。URIは、アプリケーション・コンテキストとリソース・コンテキストで構成されます。次に例を示します。

/my_application/saml/ars

これはhttps://my.example.com/my_application/saml/arsとして外部からアクセス可能です。

デフォルト値: [ "/samlars/ars" ]

ソースの表示

• 配列: string

{
    "default":[
        "/samlars/ars"
    ],
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>One or more URIs on which to listen for incoming assertion retrieval requests.</p><p>For artifact profile, the destination site receives a SAML artifact that represents a source site (why we need the source site ID values) and an assertion ID. The destination site sends a request containing the artifact to the source site's assertion retrieval URL, and the source site responds with the corresponding assertion. You may configure multiple URIs here, although typically one will be sufficient. The URI includes the application context, followed by the resource context. For example:</p><p><code> /my_application/saml/ars</code></p><p>which would be accessible from the outside as <code>https://my.example.com/my_application/saml/ars</code></p>"
}

ネストされたスキーマ: プロパティ

型: object

タイトル: Properties

使用可能なその他のプロパティ

ソースの表示

• string

{
    "default":null,
    "type":"object",
    "description":"<p>Properties passed to Assertion Store class initStore() method.</p><p>This may be useful if you have implemented a custom Assertion Store class.</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

Assertion StoreクラスのinitStore()メソッドに渡されるプロパティ。

カスタムAssertion Storeクラスを実装している場合に便利です。

デフォルト値: oracle.doceng.json.BetterJsonNull@5cecce11

ネストされたスキーマ: 項目

型: array

タイトル: Items

サイト間転送URI。

デフォルト値: [ "/samlits_ba/its", "/samlits_ba/its/post", "/samlits_ba/its/artifact", "/samlits_cc/its", "/samlits_cc/its/post", "/samlits_cc/its/artifact" ]

ソースの表示

• 配列: string

{
    "default":[
        "/samlits_ba/its",
        "/samlits_ba/its/post",
        "/samlits_ba/its/artifact",
        "/samlits_cc/its",
        "/samlits_cc/its/post",
        "/samlits_cc/its/artifact"
    ],
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The Intersite Transfer URIs.</p>"
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

この構成MBeanのすべてのタグを返します

ソースの表示

• 配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

ネストされたスキーマ: プロパティ

型: object

タイトル: Properties

使用可能なその他のプロパティ

ソースの表示

• string

{
    "default":null,
    "type":"object",
    "description":"<p>Properties to be passed to the Used Assertion Cache class.</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

使用済みアサーション・キャッシュ・クラスに渡されるプロパティ。

デフォルト値: oracle.doceng.json.BetterJsonNull@2f8620cf

先頭に戻る