SAMLIdentityProviderConfigRequest (iland cloud Java SDK 1.0.45 API)

All Known Implementing Classes:

ImmutableSAMLIdentityProviderConfigRequest
```
public interface SAMLIdentityProviderConfigRequest
```
SAML Identity Provider Configuration Request.

Author:

Nick Kasprzak

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Optional<String>`	`allowedClockSkew()` Gets allowed clock skew.
`Optional<Boolean>`	`backchannelSupported()` Enable if your SAML IDP supports backchannel logout.
`boolean`	`enabled()` Whether or not the identity provider is enabled.
`boolean`	`enforceSso()` Whether to enforce single sign on for all users.
`Optional<Boolean>`	`forceAuthn()` Indicates that the user will be forced to enter their credentials at the external IDP even if they are already logged in.
`Optional<SAMLNameIDPolicyFormat>`	`nameIdPolicyFormat()` Specifies the URI reference corresponding to a name identifier format.
`Optional<Boolean>`	`postBindingAuthnRequest()` When this realm requests authentication from the external SAML IDP, which SAML binding should be used? If set to off, then the Redirect Binding will be used.
`Optional<Boolean>`	`postBindingLogout()` Is post binding logout boolean.
`Optional<Boolean>`	`postBindingResponse()` When this realm responds to any SAML requests sent by the external IDP, which SAML binding should be used? If set to off, then the Redirect Binding will be used.
`Optional<String>`	`principalAttribute()` Way to identify and track external users from the assertion.
`Optional<SAMLPrincipalType>`	`principalType()` Specifies which part of the SAML assertion will be used to identify and track external user identities.
`Optional<SAMLSignatureKeyName>`	`samlXmlKeyNameTransformer()` Signed SAML documents contain identification of signing key in KeyName element.
`Optional<SAMLSignatureAlgorithm>`	`signatureAlgorithm()` If Want AuthnRequests Signed is on, then you can also pick the signature algorithm to use.
`Optional<String>`	`signingCertificate()` The public certificate that will be used to validate the signatures of SAML requests and responses from the external IDP.
`Optional<String>`	`singleLogoutServiceUrl()` This is an optional field that specifies the SAML logout endpoint.
`String`	`singleSignOnServiceUrl()` This is a required field and specifies the SAML endpoint to start the authentication process.
`Optional<Boolean>`	`validateSignature()` Whether or not the realm should expect that SAML requests and responses from the external IDP to be digitally signed.
`Optional<Boolean>`	`wantAssertionsEncrypted()` Is want assertions encrypted boolean.
`Optional<Boolean>`	`wantAssertionsSigned()` If Want AuthnRequests Signed is on, then you can also pick the signature algorithm to use.
`Optional<Boolean>`	`wantAuthnRequestsSigned()` If true, it will use the realm’s keypair to sign requests sent to the external SAML IDP.

- Method Detail
  - enforceSso
```
boolean enforceSso()
```
    Whether to enforce single sign on for all users. If enabled then local AD users of this company are forced to sign in through the identity provider.
  - enabled
```
boolean enabled()
```
    Whether or not the identity provider is enabled.
  - singleSignOnServiceUrl
```
String singleSignOnServiceUrl()
```
    This is a required field and specifies the SAML endpoint to start the authentication process. If your SAML IDP publishes an IDP entity descriptor, the value of this field will be specified there.
    
    Returns:
    
    specifies SAML endpoint
  - nameIdPolicyFormat
```
Optional<SAMLNameIDPolicyFormat> nameIdPolicyFormat()
```
    Specifies the URI reference corresponding to a name identifier format. Defaults to urn:oasis:names:tc:SAML:2.0:nameid-format:persistent.
  - principalType
```
Optional<SAMLPrincipalType> principalType()
```
    Specifies which part of the SAML assertion will be used to identify and track external user identities. Can be either Subject NameID or SAML attribute (either by name or by friendly name).
  - principalAttribute
```
Optional<String> principalAttribute()
```
    Way to identify and track external users from the assertion. Default is using Subject NameID, alternatively you can set up identifying attribute.
  - signatureAlgorithm
```
Optional<SAMLSignatureAlgorithm> signatureAlgorithm()
```
    If Want AuthnRequests Signed is on, then you can also pick the signature algorithm to use.
  - samlXmlKeyNameTransformer
```
Optional<SAMLSignatureKeyName> samlXmlKeyNameTransformer()
```
    Signed SAML documents contain identification of signing key in KeyName element. For Keycloak / RH-SSO counterparty, use KEY_ID, for MS AD FS use CERT_SUBJECT, for others check and use NONE if no other option works.
  - backchannelSupported
```
Optional<Boolean> backchannelSupported()
```
    Enable if your SAML IDP supports backchannel logout.
  - postBindingResponse
```
Optional<Boolean> postBindingResponse()
```
    When this realm responds to any SAML requests sent by the external IDP, which SAML binding should be used? If set to off, then the Redirect Binding will be used.
  - postBindingAuthnRequest
```
Optional<Boolean> postBindingAuthnRequest()
```
    When this realm requests authentication from the external SAML IDP, which SAML binding should be used? If set to off, then the Redirect Binding will be used.
  - postBindingLogout
```
Optional<Boolean> postBindingLogout()
```
    Is post binding logout boolean.
  - wantAuthnRequestsSigned
```
Optional<Boolean> wantAuthnRequestsSigned()
```
    If true, it will use the realm’s keypair to sign requests sent to the external SAML IDP.
  - wantAssertionsSigned
```
Optional<Boolean> wantAssertionsSigned()
```
    If Want AuthnRequests Signed is on, then you can also pick the signature algorithm to use.
  - wantAssertionsEncrypted
```
Optional<Boolean> wantAssertionsEncrypted()
```
    Is want assertions encrypted boolean.
  - forceAuthn
```
Optional<Boolean> forceAuthn()
```
    Indicates that the user will be forced to enter their credentials at the external IDP even if they are already logged in.
  - validateSignature
```
Optional<Boolean> validateSignature()
```
    Whether or not the realm should expect that SAML requests and responses from the external IDP to be digitally signed. It is highly recommended you turn this on!
  - allowedClockSkew
```
Optional<String> allowedClockSkew()
```
    Gets allowed clock skew.
  - singleLogoutServiceUrl
```
Optional<String> singleLogoutServiceUrl()
```
    This is an optional field that specifies the SAML logout endpoint. If your SAML IDP publishes an IDP entity descriptor, the value of this field will be specified there.
  - signingCertificate
```
Optional<String> signingCertificate()
```
    The public certificate that will be used to validate the signatures of SAML requests and responses from the external IDP.

Interface SAMLIdentityProviderConfigRequest

Method Summary

Method Detail

enforceSso

enabled

singleSignOnServiceUrl

nameIdPolicyFormat

principalType

principalAttribute

signatureAlgorithm

samlXmlKeyNameTransformer

backchannelSupported

postBindingResponse

postBindingAuthnRequest

postBindingLogout

wantAuthnRequestsSigned

wantAssertionsSigned

wantAssertionsEncrypted

forceAuthn

validateSignature

allowedClockSkew

singleLogoutServiceUrl

signingCertificate