Using the Consent Management REST APIs

The consent management APIs in WSO2 Identity Server collect and manage end user consents when user information is shared with external parties. The following sections guide you through the consent management concepts and the APIs you can invoke. 

Definitions for consent management

This section defines and explains commonly used terms in consent management. 

Configuring the PII controller

You can configure a default PII controller in one of the following ways:

• Via the management console

• Via the configuration file

Via the management console

1. Login to the management console.

2. Click Resident under Identity Providers and expand the Consent Management tab.

3. Configure the PII controller information.

   Open

   

Via the configuration file

1. Open the consent-mgt-config.xml file found in the <IS_HOME>/repository/conf folder and configure the following configuration block.

   <PIIController> <PiiController>Kim</PiiController> <Contact>Kim</Contact> <Email>kim@abc.com</Email> <Phone>+01433444333</Phone> <OnBehalf>false</OnBehalf> <PiiControllerUrl>https://sample.piicontroller.url</PiiControllerUrl> <Address> <Country>USA</Country> <Locality>Mountain View</Locality> <Region>CA</Region> <PostOfficeBoxNumber>233</PostOfficeBoxNumber> <PostalCode>94043</PostalCode> <StreetAddress>1600 Amphitheatre Pkwy</StreetAddress> </Address> </PIIController>

APIs and supported operations

Extension points

You can customize the REST APIs using the following extension points: 

• PIIController connector extension - A sample implementation that demonstrates registering a PII controller and providing PII controller information for consent receipts.
  

• Interceptor extension - A sample implementation that demonstrates registering a consent management interceptor and intercepting consent management related operations.