Creating an API Client Using the Command Prompt

Before you begin

You must have administrative access to the Windows server whereSOTI MobiControl is installed.

About this task

You can add an Application Programming Interface (API) client by running the SOTI MobiControl Administration Utility from the Windows command prompt with the appropriate parameters. An API client enables you to:

  • Authenticate securely when you connect external systems or tools to SOTI MobiControl.

  • Automate administrative tasks by sending Representational State Transfer (REST) API calls.

  • Experiment with the REST API in an interactive environment.

  • Integrate with third party applications.

Note: Use this method for versions earlier than SOTI MobiControl 2024.0.

Procedure

  1. Launch a Windows command prompt with administrative privileges.
  2. Navigate to the SOTI MobiControl directory.
  3. Run the following command: MCAdmin.exe APIClientAdd -n:{API client name} [-p:{API secret}] [-r:{Redirect URI}]
    Specify the parameters as follows:
    • API client name is a reference to your integrated application.
    • API secret (optional) is the passphrase used to protect the API. Store it securely because you cannot recover it if lost. If you do not provide one, the system generates it automatically.
    • Redirect URI (optional) is the destination endpoint. The authorization server returns the user agent here.

Results

When you enter the APIClientAdd command with the correct parameters, the SOTI MobiControl Administration Utility returns a summary showing the generated Client ID and Client secret.
Note: Copy and securely store the client ID and client secret before closing the dialog. You cannot retrieve the client secret later.