dm_register_user |
If your user account has the group administrator or system administrator role, you can register an NIH user account in the system, which allows that user to use DME.
To register a user:
In your local system, create a JSON file that specifies the user's information as follows:
{ "firstName": "John", "lastName": "Doe", "defaultBasePath" : "/FNLCR", "doc" : "FNLCR", "notifyUser" : "true", "subscriptions": [{ "eventType": "DATA_TRANSFER_DOWNLOAD_COMPLETED", "notificationDeliveryMethods": ["EMAIL"] }, { "eventType": "DATA_TRANSFER_DOWNLOAD_FAILED", "notificationDeliveryMethods": ["EMAIL"] }] } |
Include the following information in this JSON file:
Run the following command:
|
The following table describes each parameter:
Parameter | Description |
---|---|
[-h] | If you want to print a usage (help) message for this command, specify this option. |
[-D <REST-response>] | An optional parameter, specifying a path and filename in your local system. The system always creates a response file:
|
[-o <output-file>] | An optional parameter, specifying a path and filename in your local system. The system always creates an output file:
If the command is successful, the output file is empty. |
<userId> | Specify the user's NIH user ID. |
<description.json> | A path to the JSON file that specifies the information about the user. |
The system creates the new user with the user role. (To create a user with the group administrator role, contact NCIDataVault@mail.nih.gov.)
For example, the following command registers the doejohn9 user in the DME system, using information from the user-info.json file:
|