Jump to

• Request
• Response

View This Federation Services

get

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

View this federation services.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this federation services.

Body ()

Root Schema : Federation Services

Type: object

Show Source

• ACSRequiresSSL(optional): boolean
  Default Value: true

  Specifies whether the Assertion Consumer Service requires SSL.

• allowedTargetHosts(optional): array Items
  Title: Items

  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.

• ARSRequiresSSL(optional): boolean
  Default Value: true

  Specifies whether the Assertion Retrieval Service requires SSL.

• ARSRequiresTwoWaySSL(optional): boolean
  Default Value: false

  Specifies whether the Assertion Retrieval Service requires two-way SSL authentication.

• assertionConsumerURIs(optional): array Items
  Title: Items

  The Assertion Consumer URIs.

• assertionRetrievalURIs(optional): array Items
  Title: Items

  One or more URIs on which to listen for incoming assertion retrieval requests.

  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:

  /my_application/saml/ars

  which would be accessible from the outside as https://my.example.com/my_application/saml/ars

• assertionStoreClassName(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@4e3c3ebc

  The class that provides persistent storage for assertions, if you use an Assertion Store class other than the default class.

• assertionStoreProperties(optional): object Properties
  Title: Properties

  Additional Properties Allowed: additionalProperties

  Properties passed to Assertion Store class initStore() method.

  This may be useful if you have implemented a custom Assertion Store class.

• destinationSiteEnabled(optional): boolean
  Default Value: false

  Specifies whether the Destination Site is enabled.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• intersiteTransferURIs(optional): array Items
  Title: Items

  The Intersite Transfer URIs.

• ITSRequiresSSL(optional): boolean
  Default Value: true

  Specifies whether the Intersite Transfer Service requires SSL.

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• POSTOneUseCheckEnabled(optional): boolean
  Default Value: true

  Specifies whether the POST one-use check is enabled.

• POSTRecipientCheckEnabled(optional): boolean
  Default Value: true

  Specifies whether the POST recipient check is enabled. When true, the recipient of the SAML Response must match the URL in the HTTP Request.

• signingKeyAlias(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@9dfd5c5

  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.

• signingKeyPassPhrase(optional): string(password)

  The passphrase used to retrieve the Source Site's signing key from the keystore.

• sourceIdBase64(optional): string
  Read Only: true

  The Source Site ID base64-encoded.

  This read-only value is a Base64 representation of a 20-byte binary value that is calculated from the SourceSiteURL. If you want to configure ARTIFACT profile with another site, you will need to give a SourceId value to the other site. This value is automatically updated when the SourceSiteURL changes.

• sourceIdHex(optional): string
  Read Only: true

  The Source Site ID in hexadecimal.

  This read-only value is a hexadecimal representation of a 20-byte binary value that is calculated from the SourceSiteURL. If you want to configure ARTIFACT profile with another site, you will need to give a SourceId value to the other site. This value is automatically updated when the SourceSiteURL changes.

• sourceSiteEnabled(optional): boolean
  Default Value: false

  Indicates whether the Source Site is enabled.

• sourceSiteURL(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@37fa4179

  The URL for the Source Site.

• SSLClientIdentityAlias(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@4e9bcce5

  The alias used to store and retrieve the Destination Site's SSL client identity in the keystore.

• SSLClientIdentityPassPhrase(optional): string(password)

  The passphrase used to retrieve the Destination Site's SSL client identity from the keystore.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• usedAssertionCacheClassName(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@4c6182b8

  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.

• usedAssertionCacheProperties(optional): object Properties
  Title: Properties

  Additional Properties Allowed: additionalProperties

  Properties to be passed to the Used Assertion Cache class.

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

Nested Schema : Items

Type: array

Title: Items

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.

Show Source

• Array of: 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>"
}

Nested Schema : Items

Type: array

Title: Items

The Assertion Consumer URIs.

Default Value: [ "/samlacs/acs" ]

Show Source

• Array of: string

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

Nested Schema : Items

Type: array

Title: Items

One or more URIs on which to listen for incoming assertion retrieval requests.

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:

/my_application/saml/ars

which would be accessible from the outside as https://my.example.com/my_application/saml/ars

Default Value: [ "/samlars/ars" ]

Show Source

• Array of: 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>"
}

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

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

Properties passed to Assertion Store class initStore() method.

This may be useful if you have implemented a custom Assertion Store class.

Default Value: oracle.doceng.json.BetterJsonNull@5cecce11

Nested Schema : Items

Type: array

Title: Items

The Intersite Transfer URIs.

Default Value: [ "/samlits_ba/its", "/samlits_ba/its/post", "/samlits_ba/its/artifact", "/samlits_cc/its", "/samlits_cc/its/post", "/samlits_cc/its/artifact" ]

Show Source

• Array of: 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>"
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

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

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

• string

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

Properties to be passed to the Used Assertion Cache class.

Default Value: oracle.doceng.json.BetterJsonNull@2f8620cf

Back to Top