OIDC_BlueID.xml 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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_BlueID">
  7. <!-- identityProviderType: Specifies the implementation of an OpenID Connect identity
  8. provider. -->
  9. <crn:parameter name="identityProviderType">
  10. <crn:value xsi:type="xsd:string">IBMid</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. <!-- issuer: Specifies the OpenID claim issuer. -->
  23. <!-- A string that represents the identity provider that issued the claims in the ID token.
  24. This value must match the value of the 'iss' entry in the ID token JSON document. -->
  25. <crn:parameter name="issuer">
  26. <crn:value xsi:type="xsd:string">https://idaas.iam.ibm.com</crn:value>
  27. </crn:parameter>
  28. <!-- oidcTokenEndpoint: Specifies the OpenID Connect token endpoint -->
  29. <!-- The token endpoint is used to retrieve the identity token after a successful authentication
  30. to the OpenID Connect identity provider. -->
  31. <crn:parameter name="oidcTokenEndpoint">
  32. <crn:value xsi:type="cfg:anyPathURI">https://idaas.iam.ibm.com:443/idaas/oidc/endpoint/default/token</crn:value>
  33. </crn:parameter>
  34. <!-- oidcAuthEndpoint: Specifies the OpenID Connect authorization endpoint. -->
  35. <!-- The authorization endpoint is a URL that your OpenID Connect identity provider uses
  36. for authentication. In most cases, the URL should use the https scheme. The authorization
  37. endpoint is invoked when users authenticate to the OpenID Connect identity provider. -->
  38. <crn:parameter name="oidcAuthEndpoint">
  39. <crn:value xsi:type="cfg:anyPathURI">https://idaas.iam.ibm.com:443/idaas/oidc/endpoint/default/authorize</crn:value>
  40. </crn:parameter>
  41. <!-- clientId: Specifies the OpenID Connect client identifier -->
  42. <!-- The client identity that is assigned to the application by the OpenID Connect identity
  43. provider. -->
  44. <crn:parameter name="clientId">
  45. <crn:value xsi:type="xsd:string">MANDATORY</crn:value>
  46. </crn:parameter>
  47. <!-- clientSecret: Specifies the client secret that is assigned to the application by
  48. the OpenID Connect identity provider. -->
  49. <!-- The client secret that is assigned to the application by the OpenID Connect identity
  50. provider. -->
  51. <crn:parameter name="clientSecret">
  52. <crn:value xsi:type="xsd:string" encrypted="true"></crn:value>
  53. </crn:parameter>
  54. <!-- idpCertificateFile: Specifies the location of the certificate that is used by the
  55. OpenID Connect identity provider to sign the identity token. -->
  56. <!-- A path to the file that contains the certificate used by the identity provider to
  57. sign the JSON Web Token. The path must include the certificate file name and be accessible
  58. to the running instance of Cognos Analytics. The certificate must be in a PEM format,
  59. include only the public key certificate, and include the begin and end certificate
  60. lines. The certificate file cannot be placed in the configuration/certs directory. -->
  61. <crn:parameter name="idpCertificateFile">
  62. <crn:value xsi:type="cfg:filePath"></crn:value>
  63. </crn:parameter>
  64. <!-- returnUrl: Return URL that is configured with the OpenID Connect identity provider. -->
  65. <!-- The return URL is invoked by the OpenID Connect identity provider after successfully
  66. authenticating a user. The URL format is https://dispatcherHOST:dispatcherPORT/bi/completeAuth.jsp
  67. or https://webserverHOST:webserverPORT/ibmcognos/bi/completeAuth.jsp. This URL completes
  68. Cognos Analytics authentication using the OpenID Connect identity provider. -->
  69. <crn:parameter name="returnUrl">
  70. <crn:value xsi:type="cfg:anyPathURI">https://host:443/bi/completeAuth.jsp</crn:value>
  71. </crn:parameter>
  72. <!-- selectableForAuth: Specifies whether the namespace is selectable for authentication. -->
  73. <!-- If this property is set to true, the namespace will be available for authentication
  74. in the logon page namespace selection prompt. Set this value to false if the namespace
  75. should not be available for selection on the logon page. -->
  76. <crn:parameter name="selectableForAuth">
  77. <crn:value xsi:type="xsd:boolean">true</crn:value>
  78. </crn:parameter>
  79. <!-- advancedProperties: Specifies a set of advanced properties. -->
  80. <!-- The user needs to provide the name and the value for each advanced property. -->
  81. <crn:parameter name="advancedProperties" opaque="true">
  82. <crn:value xsi:type="cfg:array"/>
  83. </crn:parameter>
  84. <!-- accountCamidProperty: Specifies the value used to uniquely identify account objects. -->
  85. <!-- Specify either an existing Content Manager account object model property (e.g., email,
  86. username, defaultName, etc) or the name of a configured custom property. A claim
  87. must be returned for all accounts from the Identity Provider for either the Content
  88. Manager account object model property or the configured custom property. The value
  89. selected must be unique across all account objects. The value selected should be
  90. constant over time with a low probability of needing to be changed. NOTE: this value
  91. should not be changed after initial namespace configuration. -->
  92. <crn:parameter name="accountCamidProperty">
  93. <crn:value xsi:type="xsd:string">email</crn:value>
  94. </crn:parameter>
  95. <!-- customProperties: Specifies a set of custom properties. -->
  96. <!-- Use this set of custom properties to define additional account information. The "name"
  97. field corresponds to the property name set in the account while the "value" corresponds
  98. to the claim name in the id_token. -->
  99. <crn:parameter name="customProperties" opaque="true">
  100. <crn:value xsi:type="cfg:array"/>
  101. </crn:parameter>
  102. <!-- tenantIdMapping: Specifies how namespace users are mapped to tenant IDs. -->
  103. <!-- Specifying a value for this parameter enables multitenancy. The tenant ID for a user
  104. can be determined using a pattern or a tenant provider class. The pattern is a AAA
  105. service search path to a property which defines a tenant ID. The search path must
  106. be relative to a user account. For example: '~/ancestors[2]/defaultName'. A tenant
  107. provider class is Java class which implements the the ITenantProvider interface.
  108. For more details please consult the installation and configuration guide. -->
  109. <crn:parameter name="tenantIdMapping" opaque="true">
  110. <crn:value xsi:type="cfg:tenancyInfo">
  111. <crn:item name="pattern" xsi:type="xsd:string"></crn:item>
  112. </crn:value>
  113. </crn:parameter>
  114. <!-- tenantBoundingSetMapping: Specifies how the tenant bounding set is determined for
  115. a user. -->
  116. <!-- This parameter is used when multitenancy is enabled. The tenant bounding set for
  117. a user can be determined using a pattern or a tenant bounding set provider class.
  118. The pattern is a AAA service search path to a property which defines a tenant bounding
  119. set. The search path must be relative to a user account. For example: '˜/parameters/boundingSet'.
  120. A tenant bounding set provider class is Java class which implements the the IBoundingSetProvider
  121. interface. For more details please consult the installation and configuration guide. -->
  122. <crn:parameter name="tenantBoundingSetMapping" opaque="true">
  123. <crn:value xsi:type="cfg:tenancyInfo">
  124. <crn:item name="pattern" xsi:type="xsd:string"></crn:item>
  125. </crn:value>
  126. </crn:parameter>
  127. </crn:instance>