Clients

A client can access APIs after it is added to the Clients section. After adding the client, a Client Subscription is added to the APIs, thereby binding them with a single API consumer key which allows them to access the subscribed API products.

Click the Clients icon in the Applications screen to add and configure client details.

Other than adding a client from this section, a client account gets created automatically while creating an organization; the email id provided for the Administration ID property in the Organization Configuration page will be the name of the client.

Adding a new Client

1. Click the Add button on the upper-right part of the Clients tab in the Applications screen

2. Provide a valid email ID in the ID text field.

   

   The ID text field accepts only an email ID.

3. Click Add to add the client.
   

   

4. Provide the client name and other attributes under the Configuration tab.

   

   Refer to the Configuration Properties section below to understand each property.

   

   Enabling the Notify Client option alerts the client with a notification message to the registered mail ID about the new client addition.

   

   

   Refer to the Configuration Properties section below to understand each property.

5. Click the Save button to apply the changes after adding the client.

   

   • The font colour of the client name changes from red to green after saving.
   • An error message appears if the email address is not valid.

   

   

   After saving, a subscription section gets added n the configuration properties. Refer to the Configuration Properties section below to understand each property.

Configuration Properties

Attribute	Description
Name	Provide a name to identify the client.
Notify Client	If enabled, an email alert notifying the addition of the new client will be sent to the email ID specified above. As this property is to notify the addition of a new client, this field will not be visible in the UI after the client gets saved. The subject and body of this notification mail are configured in the Client Notification section.
Status	Provide the status of the client from the options as below, as per requirement: Active: Activates the services for the client. Inactive: Services will not be available for the client.
Organization	Select the organization under which the client has to be part of. Choose "NONE" to avoid being part of any organization. The option chosen while configuring the client for the first time cannot be edited after saving.

Click the Save button to add a client with the above details (clicking the Reset icon at this point discards the changes).

Developers registered through the developer portal can be seen in the Clients list.

Removing clients

Click the Delete icon against the client to delete the specific policy. 

If the client is part of any of the below, it has to be removed from it first so that the client can be removed:

• Client Subscription
  

  

• Organization
  

  

More actions

The More actions icon on the upper-right part of the page helps to reset password and see subscription under the client.

Reset Password

Sends a reset mail to the registered mail ID.

Subscriptions

Shows subscriptions if any.

To copy, delete, import, and export multiple clients, refer to the Utilities section.