Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AppExtensionSamlServiceProviderApp

This extension defines attributes related to the Service Providers configuration.

Enumerations

Properties

Functions

Properties

Optional assertionConsumerUrl

assertionConsumerUrl: undefined | string

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

Optional encryptAssertion

encryptAssertion: undefined | false | true

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

Optional encryptionAlgorithm

encryptionAlgorithm: EncryptionAlgorithm

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

Optional encryptionCertificate

encryptionCertificate: undefined | string

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

Optional federationProtocol

federationProtocol: FederationProtocol

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

Optional groupAssertionAttributes

groupAssertionAttributes: Array<AppGroupAssertionAttributes>

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

Optional hokAcsUrl

hokAcsUrl: undefined | string

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

Optional hokRequired

hokRequired: undefined | false | true

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

Optional includeSigningCertInSignature

includeSigningCertInSignature: undefined | false | true

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

Optional keyEncryptionAlgorithm

keyEncryptionAlgorithm: KeyEncryptionAlgorithm

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

Optional lastNotificationSentTime

lastNotificationSentTime: undefined | string

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

Optional logoutBinding

logoutBinding: LogoutBinding

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

Optional logoutEnabled

logoutEnabled: undefined | false | true

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

Optional logoutRequestUrl

logoutRequestUrl: undefined | string

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

Optional logoutResponseUrl

logoutResponseUrl: undefined | string

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

Optional metadata

metadata: undefined | string

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

Optional nameIdFormat

nameIdFormat: undefined | string

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

Optional nameIdUserstoreAttribute

nameIdUserstoreAttribute: undefined | string

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.

Optional outboundAssertionAttributes

outboundAssertionAttributes: model.AppOutboundAssertionAttributes

Optional partnerProviderId

partnerProviderId: undefined | string

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

Optional partnerProviderPattern

partnerProviderPattern: undefined | string

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

Optional signResponseOrAssertion

signResponseOrAssertion: SignResponseOrAssertion

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

Optional signatureHashAlgorithm

signatureHashAlgorithm: SignatureHashAlgorithm

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

Optional signingCertificate

signingCertificate: undefined | string

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

Optional succinctId

succinctId: undefined | string

This attribute represents the Succinct ID.

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: server

Optional tenantProviderId

tenantProviderId: undefined | string

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

Optional userAssertionAttributes

userAssertionAttributes: Array<AppUserAssertionAttributes>

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

Functions

getDeserializedJsonObj

getJsonObj