Onegini IdP API connection

This section describes the properties that are needed to connect Onegini UMA with Onegini CIM.

Connection properties

Property Default Example Description
oneginiIdpCcc.idp.protocol http http or https Protocol for Onegini CIM
oneginiIdpCcc.idp.host dev.onegini.me Host for Onegini CIM
oneginiIdpCcc.idp.port 80 80, 443 Port for Onegini CIM
oneginiIdpCcc.idp.personApi.​baseUri ${oneginiIdpCcc.idp.protocol}​://​${oneginiIdpCcc.idp.host}​:​${oneginiIdpCcc.idp.port}​/api/persons Base URI for Onegini CIM Person API calls. Should not end with a /
oneginiIdpCcc.idp.personApi.​username Username for Onegini CIM Person API calls
oneginiIdpCcc.idp.personApi.​password Password for Onegini CIM Person API calls
oneginiIdpCcc.idp.personApi.​maxResults 50 Threshold for search queries in Onegini CIM API
oneginiIdpCcc.idp.eventsApi.​username Username for Onegini CIM Events API calls
oneginiIdpCcc.idp.eventsApi.​password Password for Onegini CIM Events API calls
oneginiIdpCcc.idp.eventsApi.​baseUri ${oneginiIdpCcc.idp.protocol}​://​${oneginiIdpCcc.idp.host}​:​${oneginiIdpCcc.idp.port}​/api/events Base URI for Onegini CIM Events API calls. Should not end with a /
oneginiIdpCcc.idp.eventsApi.​pageSize 50 Maximum number of events that are returned in a single query

Person custom attributes

Onegini CIM supports "custom attributes" to add extra information to a Person like a loyalty card number or some other internal reference. These custom attributes can be used to lookup a user. To find users by these custom attributes they must be configured in Onegini UMA.

Property name: oneginiIdpCcc.idp.personApi.additionalSearchKeys. + name of the customAttribute

The value of this property is used as label.

Example:

oneginiIdpCcc.idp.personApi.customAttributes.insurancePolicy=Insurance policy
oneginiIdpCcc.idp.personApi.customAttributes.loyaltyCard=Flying miles

Onegini UMA Extension API connection

Onegini UMA gives possibility to retrieve some data from extension and this section describes the properties that are needed for the connection. Please keep in mind that extension also needs to be configured to work with Onegini UMA Extension API (please check extension documentation for required properties).

Connection properties

Property Default Example Description
oneginiIdpCcc.extension.enabled false true/false Defines whether integration with the extension is enabled.
oneginiIdpCcc.extension.maxResults 50 Threshold for search queries in Extension API
oneginiIdpCcc.extension.protocol http http/https Protocol for Extension API
oneginiIdpCcc.extension.host example.org Host for Extension API
oneginiIdpCcc.extension.port -1 8080 Port for Extension API
oneginiIdpCcc.extension.username Username for Extension Basic Auth
oneginiIdpCcc.extension.password Password for Extension Basic Auth
oneginiIdpCcc.extension.baseUri ${oneginiIdpCcc.extension.protocol}://
${oneginiIdpCcc.extension.host}:
${oneginiIdpCcc.extension.port}
Base URI for Extension API calls. Should not end with a /

Extension configuration

Profile attributes filtering based on predefined attributes names: ID, EMAIL_ADDRESSES, ADDRESSES, PHONE_NUMBERS, PREFERRED_LOCALE, GENDER, DISPLAY_NAME and should be used in extension configuration.

Example: ccc.modules.person.cim.detailProfileAttributes[0].attributeName=PHONE_NUMBERS ccc.modules.person.cim.detailProfileAttributes[1].attributeName=PREFERRED_LOCALE ccc.modules.person.cim.detailProfileAttributes[2].attributeName=EMAIL_ADDRESSES ccc.modules.person.cim.detailProfileAttributes[3].attributeName=DISPLAY_NAME