schema.wildfly-keycloak-saml_1_3.xsd Maven / Gradle / Ivy
The name of the deployment
List of service provider encryption and validation keys.
If the IDP requires that the client application (SP) sign all of its requests and/or if the IDP will encrypt assertions, you must define the keys used to do this. For client signed documents you must define both the private and public key or certificate that will be used to sign documents. For encryption, you only have to define the private key that will be used to decrypt.
When creating a Java Principal object that you obtain from methods like HttpServletRequest.getUserPrincipal(), you can define what name that is returned by the Principal.getName() method.
Defines what SAML attributes within the assertion received from the user should be used as role identifiers within the Java EE Security Context for the user.
By default Role attribute values are converted to Java EE roles. Some IDPs send roles via a member or memberOf attribute assertion. You can define one or more Attribute elements to specify which SAML attributes must be converted into roles.
Specifies the role mappings provider implementation that will be used to map the roles extracted from the SAML assertion into the final set of roles
that will be assigned to the principal. A provider is typically used to map roles retrieved from third party IDPs into roles that exist in the JEE application environment. It can also
assign extra roles to the assertion principal (for example, by connecting to an LDAP server to obtain more roles) or remove some of the roles that were set by the IDP.
Describes configuration of SAML identity provider for this service provider.
This is the identifier for this client. The IDP needs this value to determine who the client is that is communicating with it.
SSL policy the adapter will enforce.
SAML clients can request a specific NameID Subject format. Fill in this value if you want a specific format. It must be a standard SAML format identifier, i.e. urn:oasis:names:tc:SAML:2.0:nameid-format:transient. By default, no special format is requested.
URL of the logout page.
SAML clients can request that a user is re-authenticated even if they are already logged in at the IDP. Default value is false.
Attribute to inject the DOM representation of the assertion into the SamlPrincipal (respecting the original syntax). Default value is false
SAML clients can request that a user is never asked to authenticate even if they are not logged in at the IDP. Set this to true if you want this. Do not use together with forceAuthentication as they are opposite. Default value is false.
The session id is changed by default on a successful login on some platforms to plug a security attack vector. Change this to true to disable this. It is recommended you do not turn it off. Default value is false.
This should be set to true if your application serves both a web application and web services (e.g. SOAP or REST). It allows you to redirect unauthenticated users of the web application to the Keycloak login page, but send an HTTP 401 status code to unauthenticated SOAP or REST clients instead as they would not understand a redirect to the login page. Keycloak auto-detects SOAP or REST clients based on typical headers like X-Requested-With, SOAPAction or Accept. The default value is false.
Describes a single key used for signing or encryption.
Java keystore to load keys and certificates from.
Private key (PEM format)
Public key (PEM format)
Certificate key (PEM format)
Flag defining whether the key should be used for signing.
Flag defining whether the key should be used for encryption
Private key declaration
Certificate declaration
File path to the key store.
WAR resource path to the key store. This is a path used in method call to ServletContext.getResourceAsStream().
The password of the key store.
Key store format
Key alias
Alias that points to the key or cert within the keystore.
Keystores require an additional password to access private keys. In the PrivateKey element you must define this password within a password attribute.
Alias that points to the key or cert within the keystore.
Policy used to populate value of Java Principal object obtained from methods like HttpServletRequest.getUserPrincipal().
Name of the SAML assertion attribute to use within.
This policy just uses whatever the SAML subject value is. This is the default setting
This will pull the value from one of the attributes declared in the SAML assertion received from the server. You'll need to specify the name of the SAML assertion attribute to use within the attribute XML attribute.
All requests must come in via HTTPS.
Only non-private IP addresses must come over the wire via HTTPS.
no requests are required to come over via HTTPS.
Specifies SAML attribute to be converted into roles.
Specifies name of the SAML attribute to be converted into roles.
Specifies a configuration property for the provider.
The id of the role mappings provider that is to be used. Example: properties-based-provider.
The name (key) of the configuration property.
The value of the configuration property.
Configuration of the login SAML endpoint of the IDP.
Configuration of the logout SAML endpoint of the IDP
The Keys sub element of IDP is only used to define the certificate or public key to use to verify documents signed by the IDP.
Configuration of HTTP client used for automatic obtaining of certificates containing public keys for IDP signature verification via SAML descriptor of the IDP.
This defines the allowed clock skew between IDP and SP in milliseconds. The default value is 0.
issuer ID of the IDP.
If set to true, the client adapter will sign every document it sends to the IDP. Also, the client will expect that the IDP will be signing any documents sent to it. This switch sets the default for all request and response types.
Signature algorithm that the IDP expects signed documents to use. Defaults to RSA_SHA256
This is the signature canonicalization method that the IDP expects signed documents to use. The default value is https://www.w3.org/2001/10/xml-exc-c14n# and should be good for most IDPs.
The URL used to retrieve the IDP metadata, currently this is only used to pick up signing and encryption keys periodically which allow cycling of these keys on the IDP without manual changes on the SP side.
Should the client sign authn requests? Defaults to whatever the IDP signaturesRequired element value is.
Should the client expect the IDP to sign the assertion response document sent back from an auhtn request? Defaults to whatever the IDP signaturesRequired element value is.
Should the client expect the IDP to sign the individual assertions sent back from an auhtn request? Defaults to whatever the IDP signaturesRequired element value is.
SAML binding type used for communicating with the IDP. The default value is POST, but you can set it to REDIRECT as well.
SAML allows the client to request what binding type it wants authn responses to use. This value maps to ProtocolBinding attribute in SAML AuthnRequest. The default is that the client will not request a specific binding type for responses.
This is the URL for the IDP login service that the client will send requests to.
URL of the assertion consumer service (ACS) where the IDP login service should send responses to. By default it is unset, relying on the IdP settings. When set, it must end in "/saml". This property is typically accompanied by the responseBinding attribute.
Should the client sign authn requests? Defaults to whatever the IDP signaturesRequired element value is.
Should the client sign logout responses it sends to the IDP requests? Defaults to whatever the IDP signaturesRequired element value is.
Should the client expect signed logout request documents from the IDP? Defaults to whatever the IDP signaturesRequired element value is.
Should the client expect signed logout response documents from the IDP? Defaults to whatever the IDP signaturesRequired element value is.
This is the SAML binding type used for communicating SAML requests to the IDP. The default value is POST.
This is the SAML binding type used for communicating SAML responses to the IDP. The default value is POST.
This is the URL for the IDP's logout service when using the POST binding. This setting is REQUIRED if using the POST binding.
This is the URL for the IDP's logout service when using the REDIRECT binding. This setting is REQUIRED if using the REDIRECT binding.
If the the IDP server requires HTTPS and this config option is set to true the IDP's certificate
is validated via the truststore, but host name validation is not done. This setting should only be used during
development and never in production as it will partly disable verification of SSL certificates.
This seting may be useful in test environments. The default value is false.
This is the file path to a keystore file. This keystore contains client certificate
for two-way SSL when the adapter makes HTTPS requests to the IDP server.
Password for the client keystore and for the client's key.
Defines number of pooled connections.
If the the IDP server requires HTTPS and this config option is set to true you do not have to specify a truststore.
This setting should only be used during development and never in production as it will disable verification of SSL certificates.
The default value is false.
URL to HTTP proxy to use for HTTP connections.
The value is the file path to a keystore file. If you prefix the path with classpath:,
then the truststore will be obtained from the deployment's classpath instead. Used for outgoing
HTTPS communications to the IDP server. Client making HTTPS requests need
a way to verify the host of the server they are talking to. This is what the truststore does.
The keystore contains one or more trusted host certificates or certificate authorities.
You can create this truststore by extracting the public certificate of the IDP's SSL keystore.
Password for the truststore keystore.
The value is the allowed clock skew between the IDP and the SP.
Time unit for the value of the clock skew.