TSP_OIDC_OKTA.xml 5.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  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="TSP_OIDC_OKTA">
  7. <!-- identityProviderType: Specifies the implementation of an OpenID Connect identity
  8. provider. -->
  9. <crn:parameter name="identityProviderType">
  10. <crn:value xsi:type="xsd:string">OKTA</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://hostname:443/.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. <!-- claimName: Specifies the name of the claim that will be provided to the target namespace. -->
  62. <!-- A string that represents the name of the claim from the id_token that will be provided
  63. to the target namespace. This value must be a single string value in the id_token
  64. and must exist for all account objects. -->
  65. <crn:parameter name="claimName">
  66. <crn:value xsi:type="xsd:string">MANDATORY</crn:value>
  67. </crn:parameter>
  68. <!-- trustedEnvName: Specifies the environment variable name that will be used to transfer
  69. the claim to the target namespace. -->
  70. <!-- A string that represents the environment variable name that will be used to transfer
  71. the claim to the target namespace. This value is dependent on the target namespace
  72. type and corresponds to how the target namespace will obtain the user's identity.
  73. For example, the LDAP and Active Directory namespace types both expect the user's
  74. identity to be passed in the REMOTE_USER environment variable. -->
  75. <crn:parameter name="trustedEnvName">
  76. <crn:value xsi:type="xsd:string">REMOTE_USER</crn:value>
  77. </crn:parameter>
  78. <!-- redirectNsID: Specifies the namespace ID that will be invoked with the claim obtained
  79. from the OpenID identity provider. -->
  80. <!-- A string that represents the ID of the namespace that will be invoked with the claim
  81. obtained from the OpenID identity provider. This value must match the namespace ID
  82. of a configured namespace (e.g., LDAP, AD, etc). -->
  83. <crn:parameter name="redirectNsID">
  84. <crn:value xsi:type="xsd:string">MANDATORY</crn:value>
  85. </crn:parameter>
  86. </crn:instance>