Managing clients and integrations

The 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 are attributed to the specific environment within which you created them.

To view the clients for a specific environment, on the menu, select Environments and then select the environment.

On the environment details page, you can view the three blocks, as follows:

• Clients - shows the number of clients created.

• Integrations - shows the number of integrations created.

• Encryption Keys - shows the number of encryption keys created.

Within each environment, you can have multiple clients that you can use to manage data records on the InCountry platform with the SDK. Additionally, you can create integrations for the operation of the InCountry Data Residency for Salesforce package, data communication through REST API, management of serverless functions, or operation of Border. Besides this, you can also manage encryption keys for a specific country where you store regulated data records.

Managing clients

A client is a set of credentials (Client ID and Client Secret) that you can use to connect to a secure data store provided by the InCountry platform in a specific 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 the creation of a default environment. You can create a new client once needed.

To create a new client:

1. Open a specific environment within which you want to create a new client.

   

2. Click Generate client.

   

3. On the New Client form, enter the name of the client.

4. Click Next.

   

5. Enter the verification code and click Create.

6. InCountry Portal generates the credentials (Client ID and Client secret) that you can you further use to manage data on the InCountry platform.

   

7. On the newly opened page, copy the Environment ID, Client ID, and Client Secret. Save them in a secure place as you will not be able to recover them. To download a text file with all these credentials, click Download text. To copy these credentials to the clipboard, click Copy to clipboard.

8. When complete, click Close.

A new client will appear within the environment.

Updating the client name

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

1. Open the environment.

2. Click the Environments block.

3. On the list with clients, locate the client you want to rename.

   

4. Click the Change Client Name icon.

   

5. On the Client Parameters page, update the name for the client.

6. Click Next.

7. Enter the verification code and click Update.

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 on the InCountry Platform. To get access to data stored within the environment, you will need to create a new client.

1. Open the environment.

2. Click the Environments block.

3. On the list with clients, locate the client you want to delete.

   

4. Click the Delete Client icon.

5. Enter the verification code and click Delete.

Managing integrations

Integration is an entity representing a connection point that 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 the creation of a default environment. You can create an integration of the four types, as follows:

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

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

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

4. Border is used for data communication through Border.

Creating a new Salesforce integration

1. Open the environment in which you want to create a new integration.

   

2. Click Create integration.

   

3. On the New Integration page, define the configuration of the integration, as follows:

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

   • Name- enter the name of the integration.

   • Country - select the country for integration setup.

4. Click Next.

5. Enter the verification code.

6. Click Create.

   

7. On the page with the created Salesforce integration, save the environment ID, Client ID, Client Secret, and REST API address. To download a text file with all these credentials, click Download text. To copy these credentials to the clipboard, click Copy to clipboard.

8. When complete, click Close.

Uploading the public certificate

Once you have created the Salesforce integration and registered a self-signed certificate in Salesforce, you need upload the public certificate in the CRT format to the InCountry Portal.

1. Open the environment where the Salesforce integration was created.

2. Click the Integrations block.

3. On the list with integrations, locate the integration of the Salesforce type.

   

4. Click the Upload Certificate icon.

   

5. Click Select Certificate and select the public certificate you downloaded from Salesforce.

6. Click Next.

7. Enter the verification code and click Upload.

Creating a new Serverless integration

1. Open the environment in which you want to create a new integration.

2. Click Create integration.

   

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

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

   • Name - enter the name of the integration.

   • Country - select the country for integration setup.

4. Click Next.

5. Enter the verification code.

6. Click Create.

   

7. On the page with the created serverless integration, save the environment ID, Client ID, Client Secret, and REST API address. To download a text file with all these credentials, click Download text. To copy these credentials to the clipboard, click Copy to clipboard.

8. When complete, click Close.

A new serverless integration will appear on the list with other integrations within the current environment. Having created a serverless integration, you can proceed with the publication of serverless scripts.

Creating a new REST API integration

1. Open the environment in which you want to create a new integration.

2. Click Create integration.

   

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

   • Type - select the REST API (SSE) integration type from the list.

   • Name - enter the name of the integration.

   • Country - select the country for integration setup.

4. Click Next.

5. Enter the verification code.

6. Click Create.

   

7. On the page with the created REST API integration, save the environment ID, Client ID, Client Secret, and REST API address. To download a text file with all these credentials, click Download text. To copy these credentials to the clipboard, click Copy to clipboard.

8. When complete, click Close.

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

Creating a new Border integration

1. Open the environment in which you want to create a new integration.

2. Click Create integration.

   

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

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

   • Name - enter the name of the integration.

   • Country - select the country for integration setup.

4. Click Next.

5. Enter the verification code.

6. Click Create.

   

7. On the page with the created REST API integration, save the environment ID and Border address. To download a text file with all these credentials, click Download text. To copy these credentials to the clipboard, click Copy to clipboard.

8. When complete, click Close.

A new REST API integration will appear on the list with other integrations within the current environment. You can proceed with defining the Border configuration.

Renewing the integration

You can renew Client ID and Client Secret that are 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. Open the environment.

   

2. Click the Integrations block.

3. On the list with integrations, locate the integration you want to renew.

   

4. Click the Renew Integration icon.

5. Confirm the operation by clicking Renew.

6. Enter the verification code.

7. On the page with the renewed integration, save the environment ID, Client ID, Client Secret, and REST API address. To download a text file with all these credentials, click Download text. To copy these credentials to the clipboard, click Copy to clipboard.

8. 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 on the InCountry platform.

1. Open the environment.

   

2. Click the Integrations block.

3. On the list with integrations, locate the integration you want to delete.

   

4. Click the Delete Integration icon.

5. On the Delete Integration page, enter the verification code.

6. Once entered, click Delete.