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.
Adding a new Client
- Click the Add button on the upper-left part of the Clients tab in the Applications screen
Provide a valid email ID in the Client ID text field.
- Click OK to add the client.
Provide the client name and other attributes under the Configuration tab.
Click the Save button to apply the changes after adding the client.
Configuration Properties
Attribute | Description |
Client ID | The name provided while creating the client gets auto-populated. |
Client Name | Provide a name to identify the client. |
Status | Provide the status of the client from the options as below, as per requirement:
|
Organization | Select the organization under which the client has to be part of. Choose "NONE" to avoid being part of any organization. |
Email address of the client, which is used for all further communications including transmitting the secured keys. | |
Notify Client | If enabled, an email alert notifying the addition of the new client will be sent to the email ID specified above. |
Attributes | If there is a requirement to add additional attributes, click the Add button corresponding to the Attributes section and then add the attribute and the corresponding value. |
Subscriptions | This section gets added after saving a new client. After adding a subscription for the client from the Clent Subscriptions configuration section, it appears in this table. |
Click the Save button to add a client with the above details (clicking the Reset icon at this point discards the changes).
Saving and Removing clients and More options
Save
Ensure clicking the Save icon after configuring a client so that the it gets saved in the server. After saving the client, to edit the properties again, make the required changes in the configuration panel and then click Save.
Click Save all icon in the Clients section to save change made to all clients listed.
Remove
The Remove icon in the individual Client Configuration screen deletes the selected policy.
The Remove multiple icon under the Policies section allows deleting more than one policy.
Select the clients and click the Delete button.
More options
This option helps to copy, move, import, and export clients present in the selected Server Group. Refresh option helps to clear unsaved changes in clients.
Select the Server Group from which the operation has to be performed, click the More options button, and select the respective option to perform the operation.