Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IdentityProvider

Federation trusted partner Identity Provider

Enumerations

Properties

Functions

Properties

Optional assertionAttribute

assertionAttribute: undefined | string

Assertion attribute name.

*Deprecated Since: 20.1.3**

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

Optional authnRequestBinding

authnRequestBinding: AuthnRequestBinding

HTTP binding to use for authentication requests.

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

Optional compartmentOcid

compartmentOcid: undefined | string

OCI Compartment Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Optional correlationPolicy

correlationPolicy: model.IdentityProviderCorrelationPolicy

Optional deleteInProgress

deleteInProgress: undefined | false | true

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Optional description

description: undefined | string

Description

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

Optional domainOcid

domainOcid: undefined | string

OCI Domain Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

enabled

enabled: boolean

Set to true to indicate Partner enabled.

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

Optional encryptionCertificate

encryptionCertificate: undefined | string

Encryption certificate

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

Optional externalId

externalId: undefined | string

An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.

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

Optional iconUrl

iconUrl: undefined | string

Identity Provider Icon URL.

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

Optional id

id: undefined | string

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

Optional idcsCreatedBy

idcsCreatedBy: model.IdcsCreatedBy

Optional idcsLastModifiedBy

idcsLastModifiedBy: model.IdcsLastModifiedBy

Optional idcsLastUpgradedInRelease

idcsLastUpgradedInRelease: undefined | string

The release number when the resource was upgraded.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Optional idcsPreventedOperations

idcsPreventedOperations: Array<IdcsPreventedOperations>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

*SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Optional idpSsoUrl

idpSsoUrl: undefined | string

Identity Provider SSO URL

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

Optional includeSigningCertInSignature

includeSigningCertInSignature: undefined | false | true

Set to true to include the signing certificate in the signature.

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

Optional jitUserProvAssignedGroups

jitUserProvAssignedGroups: Array<IdentityProviderJitUserProvAssignedGroups>

Refers to every group of which a JIT-provisioned User should be a member. Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true.

*Added In:** 20.1.3

*SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

Optional jitUserProvAttributeUpdateEnabled

jitUserProvAttributeUpdateEnabled: undefined | false | true

Set to true to indicate JIT User Creation is enabled

*Added In:** 20.1.3

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Optional jitUserProvAttributes

jitUserProvAttributes: model.IdentityProviderJitUserProvAttributes

Optional jitUserProvCreateUserEnabled

jitUserProvCreateUserEnabled: undefined | false | true

Set to true to indicate JIT User Creation is enabled

*Added In:** 20.1.3

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Optional jitUserProvEnabled

jitUserProvEnabled: undefined | false | true

Set to true to indicate JIT User Provisioning is enabled

*Added In:** 20.1.3

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Optional jitUserProvGroupAssertionAttributeEnabled

jitUserProvGroupAssertionAttributeEnabled: undefined | false | true

Set to true to indicate JIT User Provisioning Groups should be assigned based on assertion attribute

*Added In:** 20.1.3

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Optional jitUserProvGroupAssignmentMethod

jitUserProvGroupAssignmentMethod: JitUserProvGroupAssignmentMethod

The default value is 'Overwrite', which tells Just-In-Time user-provisioning to replace any current group-assignments for a User with those assigned by assertions and/or those assigned statically. Specify 'Merge' if you want Just-In-Time user-provisioning to combine its group-assignments with those the user already has.

*Added In:** 20.1.3

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

Optional jitUserProvGroupMappingMode

jitUserProvGroupMappingMode: JitUserProvGroupMappingMode

Property to indicate the mode of group mapping

*Added In:** 2205120021

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

Optional jitUserProvGroupMappings

jitUserProvGroupMappings: Array<IdentityProviderJitUserProvGroupMappings>

The list of mappings between the Identity Domain Group and the IDP group.

*Added In:** 2205120021

*SCIM++ Properties:** - idcsCompositeKey: [idpGroup] - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

Optional jitUserProvGroupSAMLAttributeName

jitUserProvGroupSAMLAttributeName: undefined | string

Name of the assertion attribute containing the users groups

*Added In:** 20.1.3

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

Optional jitUserProvGroupStaticListEnabled

jitUserProvGroupStaticListEnabled: undefined | false | true

Set to true to indicate JIT User Provisioning Groups should be assigned from a static list

*Added In:** 20.1.3

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Optional jitUserProvIgnoreErrorOnAbsentGroups

jitUserProvIgnoreErrorOnAbsentGroups: undefined | false | true

Set to true to indicate ignoring absence of group while provisioning

*Added In:** 2111112015

*SCIM++ Properties:** - caseExact: false - idcsAddedSinceVersion: 30 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Optional lastNotificationSentTime

lastNotificationSentTime: undefined | string

Records the notification timestamp for the IdP 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

HTTP binding to use for logout.

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

Optional logoutEnabled

logoutEnabled: undefined | false | true

Set to true to enable logout.

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

Optional logoutRequestUrl

logoutRequestUrl: undefined | string

Logout request URL

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

Optional logoutResponseUrl

logoutResponseUrl: undefined | string

Logout response URL

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

Optional meta

meta: model.Meta

Optional metadata

metadata: undefined | string

Metadata

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

Optional nameIdFormat

nameIdFormat: undefined | string

Default authentication request name ID format.

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

Optional ocid

ocid: undefined | string

Unique OCI identifier for the SCIM Resource.

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

partnerName

partnerName: string

Unique name of the trusted Identity Provider.

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

Optional partnerProviderId

partnerProviderId: undefined | string

Provider ID

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

Optional requestedAuthenticationContext

requestedAuthenticationContext: Array<string>

SAML SP authentication type.

*Added In:** 2102181953

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

Optional requireForceAuthn

requireForceAuthn: undefined | false | true

This SP requires requests SAML IdP to enforce re-authentication.

*Added In:** 2102181953

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

Optional requiresEncryptedAssertion

requiresEncryptedAssertion: undefined | false | true

SAML SP must accept encrypted assertion only.

*Added In:** 2102181953

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

Optional samlHoKRequired

samlHoKRequired: undefined | false | true

SAML SP HoK Enabled.

*Added In:** 2102181953

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

schemas

schemas: Array<string>

REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

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

Optional serviceInstanceIdentifier

serviceInstanceIdentifier: undefined | string

The serviceInstanceIdentifier of the App that hosts this IdP. This value will match the opcServiceInstanceGUID of any service-instance that the IdP represents.

*Added In:** 18.2.6

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

Optional shownOnLoginPage

shownOnLoginPage: undefined | false | true

Set to true to indicate whether to show IdP in login page or not.

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

Optional signatureHashAlgorithm

signatureHashAlgorithm: SignatureHashAlgorithm

Signature hash algorithm.

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

Optional signingCertificate

signingCertificate: undefined | string

Signing certificate

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

Optional succinctId

succinctId: undefined | string

Succinct ID

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

Optional tags

tags: Array<Tags>

A list of tags on this resource.

*SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

Optional tenancyOcid

tenancyOcid: undefined | string

OCI Tenant Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

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 IdP.

*Added In:** 19.2.1

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

Optional type

type: Type

Identity Provider Type

*Added In:** 20.1.3

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: always - type: string - uniqueness: none

Optional urnIetfParamsScimSchemasOracleIdcsExtensionSocialIdentityProvider

urnIetfParamsScimSchemasOracleIdcsExtensionSocialIdentityProvider: model.ExtensionSocialIdentityProvider

Optional urnIetfParamsScimSchemasOracleIdcsExtensionX509IdentityProvider

urnIetfParamsScimSchemasOracleIdcsExtensionX509IdentityProvider: model.ExtensionX509IdentityProvider

Optional userMappingMethod

userMappingMethod: UserMappingMethod

User mapping method.

*Deprecated Since: 20.1.3**

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

Optional userMappingStoreAttribute

userMappingStoreAttribute: undefined | string

This property specifies the userstore attribute value that must match the incoming assertion attribute value or the incoming nameid attribute value in order to identify the user during SSO.
You can construct the userMappingStoreAttribute value by specifying attributes from the Oracle Identity Cloud Service Core Users schema. For examples of how to construct the userMappingStoreAttribute value, see the Example of a Request Body section of the Examples tab for the POST and PUT methods of the /IdentityProviders endpoint.

*Deprecated Since: 20.1.3**

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

Functions

getDeserializedJsonObj

getJsonObj