OIDC_Ping.xml 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. <!-- MANDATORY: Defines a group of properties that allows the product to use an OpenID
  2. Connect identity provider for user authentication. -->
  3. <!-- Set the values for this group of properties to allow the product access to your existing
  4. OpenID Connect identity provider. This external resource must already exist in your
  5. environment and be configured to use for authentication. -->
  6. <crn:instance name="MANDATORY" class="OIDC_Ping">
  7. <!-- identityProviderType: Specifies the implementation of an OpenID Connect identity
  8. provider. -->
  9. <crn:parameter name="identityProviderType">
  10. <crn:value xsi:type="xsd:string">Ping</crn:value>
  11. </crn:parameter>
  12. <!-- id: Specifies a unique identifier for the authentication namespace. -->
  13. <!-- Use the namespace identifier to distinguish between multiple namespaces. Each namespace
  14. must have a unique identifier. When you select a namespace to use for authentication
  15. in the run-time environment, the identifier is used by the IBM Cognos components.
  16. Changing the namespace ID after the service has been started may invalidate the object
  17. security policies and the Cognos group and role memberships. The use of the colon
  18. in the Namespace ID is not supported. -->
  19. <crn:parameter name="id">
  20. <crn:value xsi:type="xsd:string">MANDATORY</crn:value>
  21. </crn:parameter>
  22. <!-- oidcDiscEndpoint: Specifies the OpenID Connect discovery endpoint -->
  23. <!-- The discovery endpoint is used to retrieve the OpenID Connect configuration that
  24. includes the authorization endpoint, token endpoint, jwks endpoint, and issuer. -->
  25. <crn:parameter name="oidcDiscEndpoint">
  26. <crn:value xsi:type="cfg:anyPathURI">https://pingfederatehost:9301/.well-known/openid-configuration</crn:value>
  27. </crn:parameter>
  28. <!-- clientId: Specifies the OpenID Connect client identifier -->
  29. <!-- The client identity that is assigned to the application by the OpenID Connect identity
  30. provider. -->
  31. <crn:parameter name="clientId">
  32. <crn:value xsi:type="xsd:string">MANDATORY</crn:value>
  33. </crn:parameter>
  34. <!-- clientSecret: Specifies the client secret that is assigned to the application by
  35. the OpenID Connect identity provider. -->
  36. <!-- The client secret that is assigned to the application by the OpenID Connect identity
  37. provider. -->
  38. <crn:parameter name="clientSecret">
  39. <crn:value xsi:type="xsd:string" encrypted="true"></crn:value>
  40. </crn:parameter>
  41. <!-- returnUrl: Return URL that is configured with the OpenID Connect identity provider. -->
  42. <!-- The return URL is invoked by the OpenID Connect identity provider after successfully
  43. authenticating a user. The URL format is https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp
  44. or https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL completes
  45. Cognos Analytics authentication using the OpenID Connect identity provider. -->
  46. <crn:parameter name="returnUrl">
  47. <crn:value xsi:type="cfg:anyPathURI">https://host:443/bi/completeAuth.jsp</crn:value>
  48. </crn:parameter>
  49. <!-- selectableForAuth: Specifies whether the namespace is selectable for authentication. -->
  50. <!-- If this property is set to true, the namespace will be available for authentication
  51. in the logon page namespace selection prompt. Set this value to false if the namespace
  52. should not be available for selection on the logon page. -->
  53. <crn:parameter name="selectableForAuth">
  54. <crn:value xsi:type="xsd:boolean">true</crn:value>
  55. </crn:parameter>
  56. <!-- advancedProperties: Specifies a set of advanced properties. -->
  57. <!-- The user needs to provide the name and the value for each advanced property. -->
  58. <crn:parameter name="advancedProperties" opaque="true">
  59. <crn:value xsi:type="cfg:array"/>
  60. </crn:parameter>
  61. <!-- accountCamidProperty: Specifies the value used to uniquely identify account objects. -->
  62. <!-- Specify either an existing Content Manager account object model property (e.g., email,
  63. username, defaultName, etc) or the name of a configured custom property. A claim
  64. must be returned for all accounts from the Identity Provider for either the Content
  65. Manager account object model property or the configured custom property. The value
  66. selected must be unique across all account objects. The value selected should be
  67. constant over time with a low probability of needing to be changed. NOTE: this value
  68. should not be changed after initial namespace configuration. -->
  69. <crn:parameter name="accountCamidProperty">
  70. <crn:value xsi:type="xsd:string">email</crn:value>
  71. </crn:parameter>
  72. <!-- customProperties: Specifies a set of custom properties. -->
  73. <!-- Use this set of custom properties to define additional account information. The "name"
  74. field corresponds to the property name set in the account while the "value" corresponds
  75. to the claim name in the id_token. -->
  76. <crn:parameter name="customProperties" opaque="true">
  77. <crn:value xsi:type="cfg:array"/>
  78. </crn:parameter>
  79. <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
  80. <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for a user
  81. can be determined using a pattern or a tenant provider class. The pattern is a AAA
  82. service search path to a property which defines a tenant ID. The search path must
  83. be relative to a user account. For example: '~/ancestors[2]/defaultName'. A tenant
  84. provider class is Java class which implements the the ITenantProvider interface.
  85. For more details please consult the installation and configuration guide. -->
  86. <crn:parameter name="tenantIdMapping" opaque="true">
  87. <crn:value xsi:type="cfg:tenancyInfo">
  88. <crn:item name="pattern" xsi:type="xsd:string"></crn:item>
  89. </crn:value>
  90. </crn:parameter>
  91. <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined for
  92. a user. -->
  93. <!-- This parameter is used when multitenancy is enabled. The tenant bounding set for
  94. a user can be determined using a pattern or a tenant bounding set provider class.
  95. The pattern is a AAA service search path to a property which defines a tenant bounding
  96. set. The search path must be relative to a user account. For example: '˜/parameters/boundingSet'.
  97. A tenant bounding set provider class is Java class which implements the the IBoundingSetProvider
  98. interface. For more details please consult the installation and configuration guide. -->
  99. <crn:parameter name="tenantBoundingSetMapping" opaque="true">
  100. <crn:value xsi:type="cfg:tenancyInfo">
  101. <crn:item name="pattern" xsi:type="xsd:string"></crn:item>
  102. </crn:value>
  103. </crn:parameter>
  104. </crn:instance>