Contents

Popular
Contents

Clients can access APIs after they are 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

  1. Click the Add  button on the upper-left part of the Clients  tab in the Applications screen
  2. Provide a valid email ID in the Client ID text field.

    Icon

    Client ID text field accepts only a mail ID.

  3. Click OK to add the client.



  4. Provide the client name and attributes if any under the Configuration tab.

    Icon

    Email address with which the client gets added and subscriptions (if any are saved in the server) will be auto-populated.



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

    Icon
    • The font colour of the client name changes from red to green after saving.
    • A password will be sent to the client's email address. Click Resend if the client did not receive the mail.

 

 

 

Configuration Properties

AttributeDescription
Client IDThe name provided while creating the client gets auto-populated.
Client NameProvide a name to identify the client.
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.
EmailEmail address of the client, which is used for all further communications including transmitting the secured keys.
AttributesIf 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.

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

Icon
  • After saving the client, to edit the properties of the client, make the required changes in the configuration panel and then click Save.
  • To remove a client completely, select the client from the list under the Clients tab in the left navigation panel and click the Remove button on top.
    • To remove a client that is already added to a Client Subscription, it has to be removed from the subscription first.
Icon

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

Adaptavist ThemeBuilder EngineAtlassian Confluence