Manage an OpenAPI Client in RCMS

Manage an OpenAPI Client in RCMS

Manage an RCMS OpenAPI client when an integration's name changes, you need to stop its access, or the client is no longer required. The client list contains a separate entry for each API client.

Before you begin: Sign in to the correct RCMS company with access to OpenAPI. Identify the client and the integration that uses it.

Rename a client

  1. Select Support in the top navigation and open OpenAPI.
  2. Find the client and select the edit icon in its Action column.
  3. Update the name and select SAVE.
  4. Check the name in the client list.

Enable or disable a client

Find the client in OpenAPI and use its status switch to enable or disable it. Check the switch after the change.

Warning: Disabling or removing a client can interrupt the integration that uses it. Check with the integration owner before making the change.

Remove a client

  1. Identify the client you no longer need and check the integration using it.
  2. Select its delete icon in the Action column.
  3. Review the confirmation and select YES.
  4. Check that the client no longer appears in the list.

Keep API keys secret. For client creation, see Create an OpenAPI Client in RCMS. For activity records, see View and Export the RCMS OpenAPI Calling Log.