Registering a client with the REST API

The import CLI uses specific endpoints of the REST API for managing import mappings, import requests, and import results. The REST API requires HTTP basic authentication. Therefore, you must register a client that is defined by a key (user name) and a secret (password) with the REST API. During registration, you can restrict the access to specific REST API endpoints, signin IDs, and IP addresses.

Procedure

  1. Open a command line.
  2. Use the following syntax for your command:
    Read syntax diagramSkip visual syntax diagram siq4l client register deployment_type-s--scopescope-r--remote-addripaddress-l--login-idsigniniddefault--client-idclientid--passwordpwd hostname
    Where:
    deployment_type
    The StoredIQ® for Legal deployment type, which can be ova or openshift.
    -s scope
    --scope scope
    The first segment of a REST API endpoint path. You need access to the /import segment and optionally, the /attachments segment. Access to the latter is necessary for viewing the import results.
    -r ipaddr
    --remote-addr ipaddr
    The IP address that the REST API can be accessed from. You can include a subnet mask. For example, specify 192.168.0.1/24 to cover the IP addresses 192.168.0.1 - 192.168.0.24.
    -l signinid
    --login-id signinid
    The signin ID of the user to be authorized to access the REST API. As a minimum, the user must have the Import: General privilege. If the user is to import matters, the Import: Matters privilege is needed.
    –-client-id clientid
    The name for the client that you are registering. The default name is default.
    --password pwd
    The password of user ilgadmin. If you do not specify it, you are prompted for it.
    hostname
    The fully qualified host name of the virtual machine (VM) where StoredIQ for Legal is deployed.
    Example:
    Assume that you want to give users with the signin IDs procadmin and paralegal1 access to all import tasks and results from IP address 127.0.0.1. Also, assume that StoredIQ for Legal is deployed as OVA on the VM siq4l.myhost.yourserver.com. You decide not to specify a name for the client, and you want to be prompted for the ilgadmin password. Your command would then look as follows. Specify it on one line:
    siq4l client register ova -s import -s attachment
-r 127.0.0.1 -l procadmin -l paralegal1
siq4l.myhost.yourserver.com
  3. If you are prompted for the password for user ilgadmin, enter it.
    The key, the secret, the deployment type, and the host name are saved to the following file: clientid.credentials.
  4. At any time, you can unregister a client. Use the following syntax for your command:
    Read syntax diagramSkip visual syntax diagram siq4l client unregister -s--scopescope-r--remote-addripaddress-l--login-idsigniniddefault--client-idclientid--passwordpwd
  5. At any time, you can enter siq4l client --help if you need help with one of the commands. For an overview of the REST API endpoints that are used, see Overview of commands and REST API endpoints.