Managing clients and integrations

Client is a data communication entity that is used to get access to data-residency services of InCountry Platform within the allocated environment.

All clients attribute to the specific environment within which they were created.

To view all the clients, on the sidebar, select Environments. The Environments page opens, as follows:

On the Environments page, you can view the list of available environments with the clients registered within each one. For each client, you can see its label and created date. No additional information about the client is provided.

Within each environment, you can have multiple clients that can manage regulated data that you store in InCountry Platform.

Additionally, for each environment you can set up integrations that can be used for operation of the InCountry for Salesforce app, data communication with REST API or management of serverless functions.

Managing clients

A client is an entity which represents an access point that you can use to connect to a specific Point-of-Presence in some country.

You can manage clients, as follows:

1. create new clients

2. edit names of existing clients

3. delete the no longer needed clients

Creating new clients

By default, InCountry Portal does not create a default client together with creation of a default environment. You can create a new client once needed.

To create a new client:

1. On the Environments page, locate the environment which you want to create a new client within.

2. Click the expand icon to show the list of clients and integrations.

3. Once expanded, on the Clients list, click the Create Client icon.

   

4. In the Create Client form, enter the name of the client.

   

5. Click Create.

6. Enter the confirmation code and click Next.

7. InCountry Portal generates the credentials (client ID and client secret) that you can you further use to manage data in InCountry Platform.

8. In the New Client is created form, copy the client credentials and save them in a secure place. Click Copy All to copy all the client credentials at once.

   

9. When complete, click Close.

A new client will appear within the environment.

Updating the client

You may need to rename the client in some cases if the current name does not reflect the actual purpose of the client.

1. Within the environment, locate the client which you want to rename.

   

2. Click the Change Client Name icon.

3. In the Change Client Name form, enter a new name for the client.

   

4. Click Update.

5. Enter the confirmation code and click Next.

Deleting the client

If you no longer need some client, you can delete it. After the removal, the client credentials will be no longer valid, so you cannot use them for further data management in InCountry Platform.

1. Within the environment, locate the client which you want to delete.

   

2. Click the Delete Client icon.

3. In the Delete the Client form, enter the label of the client you are deleting. This label is shown in the header of the form.

   

4. Once entered, click Confirm.

5. Enter the confirmation code you receive and click Next.

Managing integrations

An integration is an entity which represents a connection point which can be used to integrate your system with other components of the InCountry Platform.

You can manage integrations, as follows:

1. create new integrations

2. renew existing integrations

3. delete the no longer needed integrations

Creating new integrations

InCountry Portal does not create a default integration together with creation of a default environment. You can create integration of the three types, as follows:

1. Salesforce is used for operation of the InCountry Data Residency for Salesforce package.

2. Serverless is used for management of serverless functions on the target Point-of-Presence (PoP).

3. restapi-sse is used for data communication with REST API.

Creating a new Salesforce integration

1. On the Environments page, locate the environment which you want to create a new integration within.

2. Click the expand icon to show the list of clients and integrations.

   

3. Once expanded, on the Integrations list, click the Create Integration icon.

4. In the Create Integration form, define configuration of the integration, as follows:

   • Type - select the Salesforce integration type from the list.

   • Label - enter the label of the integration.

   • Country - select the country for integration setup.

     

5. Click Create.

   

6. In the New Integration is created form, save the Client ID and Client Secret, as well as the REST API address. You can click Copy All to save this information.

7. When complete, click Close.

Creating a new Serverless integration

1. On the Environments page, locate the environment which you want to create a new integration within.

2. Click the expand icon to show the list of clients and integrations.

3. Once expanded, on the Integrations list, click the Create Integration icon.

   

4. In the Create Integration form, specify the following information:

   • Type - select the Serverless integration type from the list.

   • Label - enter the label of the integration.

   • Country - select the country for integration setup.

5. Click Create.

6. Enter the confirmation code and click Next.

   

7. In the New Integration is created form, save the Client ID and Client Secret, as well as the REST API address. You can click Copy All to save this information.

8. When complete, click Close.

A new serverless integration will appear on the list with other integrations within the current environment.

Creating a new REST API integration

1. On the Environments page, locate the environment which you want to create a new integration within.

2. Click the expand icon to show the list of clients and integrations.

3. Once expanded, on the Integrations list, click the Create Integration icon.

   

4. In the Create Integration form, define configuration of the integration, as follows:

   1.Type - select the restapi-sse integration type from the list.

   2.Label - enter the label of the integration.

   3.Country - select the country for integration setup.

5. Enter the confirmation code.

   

6. In the New Integration is created form, save the Client ID and Client Secret, as well as the REST API address. You can click Copy All to save this information.

7. When complete, click Close.

A new REST API integration will appear on the list with other integrations within the current environment.

Renewing the integration

You can renew the client secret which is used within a particular integration. This may be required for key rotation or when you lost the client secret but do not want to create a new integration.

1. Within the environment, locate the integration which you want to renew.

   

2. Click the Renew Client Secret icon.

3. Enter the confirmation code.

   

4. In the Integration is updated form, save the Client ID and Client Secret, as well as the REST API address. You can click Copy All to save this information.

5. When complete, click Close.

Deleting the integration

If you no longer need some integration, you can delete it. After the removal, the issued certificates for the integration will be no longer valid, so you cannot use them for further data management in InCountry Platform.

1. Within the environment, locate the integration which you want to delete.

   

2. Click the Delete icon.

3. In the Delete the Integration form, enter the label of the integration you are deleting. This label is shown in the header of the form.

   

4. Once entered, click Confirm.

5. Enter the confirmation code you receive and click Next.