Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version 4

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: update for ob2.0

...

Tip
titleBefore you begin:

Configure the Consent Management application to try out the Consent Manager Portal.

Expand
titleClick here to see how to configure Consent Management application

WSO2 Open Banking solution includes consent revocation apps that support bank customers (PSUs) and banks (ASPSPs) to revoke consents. The consent revocation app provided to PSU is known as Self-care portal and the consent revocation app provided to ASPSP is known as Customer Care portal. 

In order to manage the consents granted to a Third-Party Provider using the Self-care portal,  do the following configurations. 

Multiexcerpt
MultiExcerptNameConfiguringConsentManagementApplication
  1. Go to the Identity and Access Management Console at https://<WSO2_OB_IAM_HOST>:9446/carbon.
  2. On the Main tab, click Home > Identity > Service Providers > Add.
  3. By default, the mode is set to Manual Configuration. Leave it as it is.
  4. Enter consentmgt as the Service Provider’s name. 
  5. Click Register.
  6. Click Inbound Authentication configuration > OAuth/OpenID Connect configuration > Configure.

  7. Set the values for the following parameters and keep the default value for the other parameters.

    ParameterValue
    OAuth Version2.0
    Allowed Grant Type

    code

    Callback URL

    The first and second URLs are respectively; redirect and logout URLs.

    Regex-based consumer URLs are supported when defining the callback URL. This enables you to configure multiple callback URLs for one application by entering a regex pattern as the value for the callback URL field.

    You must have the prefix regexp= before your regex pattern. To define a normal URL, you can specify the callback URL without this prefix.

  8. Click Add.

    The OAuth client key/client ID and OAuth client secret are generated. Those are used in .

  9. Open the <WSO2_OB_IAM_HOME> /repository/deployment/server/jaggeryapps/consentmgt/configs/conf.json file and modify the following parameters:

    ParameterDescription

    apimHost

    		Hostname of the API Management server

    applicationId

    		OAuth Client Key generated in the above step
    authCredential

    Base64 encoded CLIENT_ID:CLIENT_SECRET value (in the given format). 

    For example, 

    Values to encodeBase64 encoded value

    Y2VuZFhvTTJ5U0RtMndQU1FXdGxSejMzTjdFYTpJMjZlN3kxODlUbnQ0czkybmh3NFV4NUhxaDBh

    redirectUrl

    		The URL you are redirected to when you log in to the application.

    logoutUrl

    		The URL you are redirected to when you log out from the application.
    DeployedSpecificationPossible values are UK, BERLIN, AU, and STET. By default, the value is set to UK.

    ClientIDAndSecret

    Given below is a sample file for the Berlin specification:



...

  1. Go to the Consent Manager portal at https://<WSO2_OB_IAM_HOST>:9446/consentmgt.

  2. Enter the username and password provided by the bank. Click Continue.

  3. In the Consent Manager portal's home page, you can view a list of Accounts and Payments consents that you have granted access to account information.

  4. Consent status is displayed to the right of the selected consent. Available consent statuses are rejected, awaiting authorisation, authorised, and revoked.. The statuses of the consents are as follows: 

    Localtabgroup
    Localtab
    titleAccount Consents

    Status

    Description

    ReceivedThe consent data is received and technically correct, but it is not authorised yet.
    RejectedThe consent is rejected as data is not authorised.
    ValidThe consent is accepted and can GET account data.
    Revoked by PSUThe consent is revoked by the PSU towards the ASPSP.
    ExpiredThe consent is expired. The expiration time can be defined by the TPP.
    Terminated by TPPThe consent type used when the TPP deletes the consent resource.
    Localtab
    titlePayment Consents
    • There can be several payment accounts for the same ASPSP where you have granted consent to access different data.

    • Preceding check of technical validation was successful. Customer profile check was also successful.

      StatusDescription
      ReceivedThe consent data is received and technically correct, but it is not authorised yet.
      RejectedThe consent is rejected as data is not authorised.
      AcceptedCustomerProfileThe customer profile associated with the consent was checked successfully.
  5. After reviewing the consent, you may revoke it. 

  6. Optionally, you can enter a reason for the revocation.

    Tip

    Revocation reasons help you to find more information later. It is not mandatory to provide a reason for revocation.

  7. Click Revoke to confirm the revocation. 

  8. The status of the consent is now changed to Revoked. You can still find the history of consents remaining in the list.

...

Tip
titleBefore you begin:

Create a user whose role is defined as a customer care officer. 

Expand
titleClick here to see how it is done...

  1. Sign in to the Identity and Access Management console (https://<WSO2_OB_IAM_HOST>:9446/carbon). Use the default super admin credentials:

    Username: admin@wso2.com

    Password: wso2123

    Note

    The above credentials are used for demo purposes only. It is recommended to change them in a production environment.

  2. On the Main  tab, click  Identity > Users and Roles > Add > Add New Role and create the following user:

    DomainRolePermissions

    Internal

    CustomerCareOfficer

    		No permissions required.

  3. On the  Main  tab, click  Identity > Users and Roles > Add > Add New User and create the following user:

    UserRoles
    ann@gold.comInternal/CustomerCareOfficer

  4. Click Finish.

Multiexcerpt
hiddentrue
MultiExcerptNameConfiguringSSO
Configuring SSO:

You can configure SSO for the Customer Care Portal.

Click here to see how it is done
  1. Create a Service provider with the following parameters.

    1. Sign in to the Identity and Access Management console at https://<WSO2_OB_KMIAM_HOST>:9446/carbon.

    2. Go to Home > Identity > Service Providers > Add.

    3. Use the Manual Configuration option and fill in the Basic Information.

    4. Click Register.

    5. Go to Inbound Authentication Configuration > SAML2 Web SSO Configuration > Configure.

    6. Configure the following:

      Manual ConfigurationValue
      Issuerccportal
      Assertion Consumer URLshttps://<OB_KMIAM_HOST>:9446/ccportal/jagg/jaggery_acs.jag

    7. Click Add to add Assertion Consumer URL.

    8. Click Register.

    9. Expand the Local and Outbound Authentication Configuration section and select the authenticators that are used to authenticate users in this service provider (sample value: Default).

    10. Check the Enable Authorization checkbox and click Update.

  2. Setting up the policy.
    1. Follow the instructions in Configuring Access Control Policy for a Service Provider - Setting up the policy and publish a policy using the authn_role_based_policy_template for the Internal/CustomerCareOfficer role.

    2. Given below is a sample policy file:

      xml
  3. Update SSO configurations.
    1. Open the <WSO2_OB_KMIAM_HOME>/repository/deployment/server/jaggeryapps/ccportal/configs/conf.json file.

    2. Update the ssoConfiguration section. Given below is a sample configuration:

      js

  4. Make sure the <WSO2_OB_KMIAM_HOME>/modules/sso/module.xml file contains the following:

    xml

  1. Sign in to the Customer Care Portal (https://<WSO2_OB_KMIAM_HOST>:9446/ccportal) using the username and password of a user with the Customer Care role. See Configuring Users and Roles, for more information on user roles.

    Multiexcerpt
    MultiExcerptNametroubleshootingForCustomerCarePortal
    Troubleshooting

    If you get hostname verification errors when accessing the Customer Care portal, add the following to the <WSO2_OB_IAM_HOME>/bin/wso2server.sh file and restart.

    • Dhttpclient.hostnameVerifier="DefaultAndLocalhost" \
    • Dorg.wso2.ignoreHostnameVerification=true \
  2.  You can filter the search results using the following parameters:
    Image Added

    • User ID: The user ID created for

      the

      a PSU in the online

      banking

      baking application. This is the same

      user that is used for generating the consent IDs

      ID used to generate the Consent ID.

    • Consent Type: Selected Accounts by default. You can select between Accounts , and Payments and CBPIIs.

    • Application: The TPP applications authorised for the ASPSP are listed here. You can select the TPP application the PSU has given consent to.

    • Status: Select the consent status. Possible values are: Rejected, Awaiting Authorisation, Authorised, and Revoked. 

    • Set Date Range: The date range in which the PSU’s consent is valid.

      Tip

      You can use one or more filter options and proceed to search.

    Image Removed

    Info

    WSO2 Open Baking is a solution developed with compliance to the PSD2. It is stated in the PSD2, a PSU cannot revoke a payment-order consent once it has been authorized.

  3. Click Search.

  4. A list of search results is displayed, as shown below. You can view the Account and Payment consent information by clicking the consent.

    Click the consent you want to revoke and view the consent details. 
  5. One consent ID can be granted to many accounts that belong to the same PSU. Therefore, there are two methods to revoke account consent.
    1. Revoke a consent -
      When a PSU has asked a customer care representative to revoke consent, customer care representative revokes all account consents with that consent ID.
    2. Revoke an account consent -
      An individual account consent can be revoked. It revokes only that account consent. 

  6. Click Revoke.

  7. Optionally, you are asked to enter a reason for the revocation.

    Tip

    Revocation reasons will help you to find more information later. It is not mandatory to provide a reason for revocation.


  8. Click Revoke to confirm the revocation. 

...