@Generated(value="OracleSDKGenerator", comments="API Version: v1") public final class AppExtensionSamlServiceProviderApp extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
This extension defines attributes related to the Service Providers configuration.
Note: Objects should always be created or deserialized using the AppExtensionSamlServiceProviderApp.Builder
. This model
distinguishes fields that are null
because they are unset from fields that are explicitly
set to null
. This is done in the setter methods of the AppExtensionSamlServiceProviderApp.Builder
, which maintain a
set of all explicitly set fields called AppExtensionSamlServiceProviderApp.Builder.__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
AppExtensionSamlServiceProviderApp.Builder |
static class |
AppExtensionSamlServiceProviderApp.EncryptionAlgorithm
This attribute indicates the encryption algorithm used to encrypt the SAML assertion.
|
static class |
AppExtensionSamlServiceProviderApp.FederationProtocol
Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1).
|
static class |
AppExtensionSamlServiceProviderApp.KeyEncryptionAlgorithm
This attribute indicates the key encryption algorithm.
|
static class |
AppExtensionSamlServiceProviderApp.LogoutBinding
This attribute represents the HTTP binding that would be used while logout.
|
static class |
AppExtensionSamlServiceProviderApp.SignatureHashAlgorithm
This attribute represents the algorithm used to hash the signature.
|
static class |
AppExtensionSamlServiceProviderApp.SignResponseOrAssertion
Indicates which part of the response should be signed.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
AppExtensionSamlServiceProviderApp(String metadata,
String partnerProviderId,
String partnerProviderPattern,
String tenantProviderId,
String succinctId,
String assertionConsumerUrl,
String logoutRequestUrl,
String logoutResponseUrl,
String nameIdFormat,
String signingCertificate,
String encryptionCertificate,
AppExtensionSamlServiceProviderApp.EncryptionAlgorithm encryptionAlgorithm,
AppExtensionSamlServiceProviderApp.KeyEncryptionAlgorithm keyEncryptionAlgorithm,
Boolean encryptAssertion,
AppExtensionSamlServiceProviderApp.SignResponseOrAssertion signResponseOrAssertion,
Boolean includeSigningCertInSignature,
AppExtensionSamlServiceProviderApp.LogoutBinding logoutBinding,
Boolean logoutEnabled,
AppExtensionSamlServiceProviderApp.SignatureHashAlgorithm signatureHashAlgorithm,
AppExtensionSamlServiceProviderApp.FederationProtocol federationProtocol,
String nameIdUserstoreAttribute,
Boolean hokRequired,
String hokAcsUrl,
String lastNotificationSentTime,
AppOutboundAssertionAttributes outboundAssertionAttributes,
List<AppUserAssertionAttributes> userAssertionAttributes,
List<AppGroupAssertionAttributes> groupAssertionAttributes)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AppExtensionSamlServiceProviderApp.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAssertionConsumerUrl()
The attribute represents the URL to which the SAML Assertions will be sent by the SAML IdP.
|
Boolean |
getEncryptAssertion()
If true, indicates that the system must encrypt the Security Assertion Markup Language (SAML)
assertion.
|
AppExtensionSamlServiceProviderApp.EncryptionAlgorithm |
getEncryptionAlgorithm()
This attribute indicates the encryption algorithm used to encrypt the SAML assertion.
|
String |
getEncryptionCertificate()
This attribute represents the encryption certificate that an App uses to encrypt the Security
Assertion Markup Language (SAML) assertion.
|
AppExtensionSamlServiceProviderApp.FederationProtocol |
getFederationProtocol()
Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1).
|
List<AppGroupAssertionAttributes> |
getGroupAssertionAttributes()
Each value of this attribute describes an attribute of Group that will be sent in a Security
Assertion Markup Language (SAML) assertion.
|
String |
getHokAcsUrl()
Hok Assertion Consumer Service Url
|
Boolean |
getHokRequired()
If enabled, then the SAML Service supports Hok for this App.
|
Boolean |
getIncludeSigningCertInSignature()
If true, then the signing certificate is included in the signature.
|
AppExtensionSamlServiceProviderApp.KeyEncryptionAlgorithm |
getKeyEncryptionAlgorithm()
This attribute indicates the key encryption algorithm.
|
String |
getLastNotificationSentTime()
Records the notification timestamp for the SP whose signing certificate is about to expire.
|
AppExtensionSamlServiceProviderApp.LogoutBinding |
getLogoutBinding()
This attribute represents the HTTP binding that would be used while logout.
|
Boolean |
getLogoutEnabled()
If true, then the SAML Service supports logout for this App.
|
String |
getLogoutRequestUrl()
The URL to which the partner sends the logout request.
|
String |
getLogoutResponseUrl()
The URL to which the partner sends the logout response.
|
String |
getMetadata()
This attribute represents the metadata of a Security Provider in the Security Assertion
Markup Language protocol.
|
String |
getNameIdFormat()
This can be any string, but there are a set of standard nameIdFormats.
|
String |
getNameIdUserstoreAttribute()
Deprecated Since: 18.2.2
|
AppOutboundAssertionAttributes |
getOutboundAssertionAttributes() |
String |
getPartnerProviderId()
The ID of the Provider.
|
String |
getPartnerProviderPattern()
The pattern of the Provider.
|
AppExtensionSamlServiceProviderApp.SignatureHashAlgorithm |
getSignatureHashAlgorithm()
This attribute represents the algorithm used to hash the signature.
|
String |
getSigningCertificate()
This attribute represents the signing certificate that an App uses to verify the signed
authentication request.
|
AppExtensionSamlServiceProviderApp.SignResponseOrAssertion |
getSignResponseOrAssertion()
Indicates which part of the response should be signed.
|
String |
getSuccinctId()
This attribute represents the Succinct ID.
|
String |
getTenantProviderId()
The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead
of the one in SamlSettings) when interacting with this SP.
|
List<AppUserAssertionAttributes> |
getUserAssertionAttributes()
Each value of this attribute describes an attribute of User that will be sent in a Security
Assertion Markup Language (SAML) assertion.
|
int |
hashCode() |
AppExtensionSamlServiceProviderApp.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"metadata","partnerProviderId","partnerProviderPattern","tenantProviderId","succinctId","assertionConsumerUrl","logoutRequestUrl","logoutResponseUrl","nameIdFormat","signingCertificate","encryptionCertificate","encryptionAlgorithm","keyEncryptionAlgorithm","encryptAssertion","signResponseOrAssertion","includeSigningCertInSignature","logoutBinding","logoutEnabled","signatureHashAlgorithm","federationProtocol","nameIdUserstoreAttribute","hokRequired","hokAcsUrl","lastNotificationSentTime","outboundAssertionAttributes","userAssertionAttributes","groupAssertionAttributes"}) public AppExtensionSamlServiceProviderApp(String metadata, String partnerProviderId, String partnerProviderPattern, String tenantProviderId, String succinctId, String assertionConsumerUrl, String logoutRequestUrl, String logoutResponseUrl, String nameIdFormat, String signingCertificate, String encryptionCertificate, AppExtensionSamlServiceProviderApp.EncryptionAlgorithm encryptionAlgorithm, AppExtensionSamlServiceProviderApp.KeyEncryptionAlgorithm keyEncryptionAlgorithm, Boolean encryptAssertion, AppExtensionSamlServiceProviderApp.SignResponseOrAssertion signResponseOrAssertion, Boolean includeSigningCertInSignature, AppExtensionSamlServiceProviderApp.LogoutBinding logoutBinding, Boolean logoutEnabled, AppExtensionSamlServiceProviderApp.SignatureHashAlgorithm signatureHashAlgorithm, AppExtensionSamlServiceProviderApp.FederationProtocol federationProtocol, String nameIdUserstoreAttribute, Boolean hokRequired, String hokAcsUrl, String lastNotificationSentTime, AppOutboundAssertionAttributes outboundAssertionAttributes, List<AppUserAssertionAttributes> userAssertionAttributes, List<AppGroupAssertionAttributes> groupAssertionAttributes)
public static AppExtensionSamlServiceProviderApp.Builder builder()
Create a new builder.
public AppExtensionSamlServiceProviderApp.Builder toBuilder()
public String getMetadata()
This attribute represents the metadata of a Security Provider in the Security Assertion Markup Language protocol.
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getPartnerProviderId()
The ID of the Provider. This value corresponds to the entityID from the Service Provider metadata.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getPartnerProviderPattern()
The pattern of the Provider. This value corresponds to the entityID from the Service Provider metadata.
*Added In:** 2202230830
*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: request - type: string - uniqueness: none
public String getTenantProviderId()
The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this SP.
*Added In:** 19.2.1
*SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
public String getSuccinctId()
This attribute represents the Succinct ID.
*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: server
public String getAssertionConsumerUrl()
The attribute represents the URL to which the SAML Assertions will be sent by the SAML IdP.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getLogoutRequestUrl()
The URL to which the partner sends the logout request.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getLogoutResponseUrl()
The URL to which the partner sends the logout response.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getNameIdFormat()
This can be any string, but there are a set of standard nameIdFormats. If a nameIdFormat other than the standard list is chosen, it will be considered a custom nameidformat. The standard nameidformats include: saml-x509, saml-emailaddress, saml-windowsnamequalifier, saml-kerberos, saml-persistent, saml-transient, saml-unspecified, saml-none, and saml-persistent-opaque.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getSigningCertificate()
This attribute represents the signing certificate that an App uses to verify the signed authentication request.
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getEncryptionCertificate()
This attribute represents the encryption certificate that an App uses to encrypt the Security Assertion Markup Language (SAML) assertion.
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public AppExtensionSamlServiceProviderApp.EncryptionAlgorithm getEncryptionAlgorithm()
This attribute indicates the encryption algorithm used to encrypt the SAML assertion.
*SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public AppExtensionSamlServiceProviderApp.KeyEncryptionAlgorithm getKeyEncryptionAlgorithm()
This attribute indicates the key encryption algorithm.
*Added In:** 18.4.2
*SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public Boolean getEncryptAssertion()
If true, indicates that the system must encrypt the Security Assertion Markup Language (SAML) assertion.
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
public AppExtensionSamlServiceProviderApp.SignResponseOrAssertion getSignResponseOrAssertion()
Indicates which part of the response should be signed. A value of \“Assertion\” indicates that the Assertion should be signed. A value of \“Response\” indicates that the SSO Response should be signed. A value of \“AssertionAndResponse\” indicates that both the Assertion and the SSO Response should be signed.
*SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public Boolean getIncludeSigningCertInSignature()
If true, then the signing certificate is included in the signature.
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
public AppExtensionSamlServiceProviderApp.LogoutBinding getLogoutBinding()
This attribute represents the HTTP binding that would be used while logout.
*SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public Boolean getLogoutEnabled()
If true, then the SAML Service supports logout for this App.
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
public AppExtensionSamlServiceProviderApp.SignatureHashAlgorithm getSignatureHashAlgorithm()
This attribute represents the algorithm used to hash the signature.
*SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public AppExtensionSamlServiceProviderApp.FederationProtocol getFederationProtocol()
Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1).
*Added In:** 18.2.6
*SCIM++ Properties:** - caseExact: true - idcsDefaultValue: SAML2.0 - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getNameIdUserstoreAttribute()
Deprecated Since: 18.2.2
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - idcsValuePersistedInOtherAttribute: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none This property specifies which user attribute is used as the NameID value in the SAML assertion. This attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema.
public Boolean getHokRequired()
If enabled, then the SAML Service supports Hok for this App.
*Added In:** 2101262133
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
public String getHokAcsUrl()
Hok Assertion Consumer Service Url
*Added In:** 2101262133
*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
public String getLastNotificationSentTime()
Records the notification timestamp for the SP whose signing certificate is about to expire.
*Added In:** 2302092332
*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: dateTime - uniqueness: none
public AppOutboundAssertionAttributes getOutboundAssertionAttributes()
public List<AppUserAssertionAttributes> getUserAssertionAttributes()
Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion.
*Deprecated Since: 18.2.2**
*SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [name] - idcsSearchable: false - idcsValuePersistedInOtherAttribute: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none
public List<AppGroupAssertionAttributes> getGroupAssertionAttributes()
Each value of this attribute describes an attribute of Group that will be sent in a Security Assertion Markup Language (SAML) assertion.
*Deprecated Since: 18.2.2**
*SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [name] - idcsSearchable: false - idcsValuePersistedInOtherAttribute: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.