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:
- Make sure the user has an NIH user account.
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:
- Consider specifying the user's first name and last name. Otherwise, the system creates the account using the first and last name associated with the NIH user ID.
- Specify a default base path for the user.
- Specify the user's DOC. If your user account has the group administrator role, the DOC you specify must match your own.
- If you want the system to send an email notification to the new user at the time of user account creation, include the notifyUser attribute and set it to true.
- If you want to subscribe the user to data transfer notifications, specify those notifications.
Run the following command:
dm_register_user [optional parameters] <userId> <description.json>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:
- If you specify this parameter, the system saves the response from the server to the specified file in the specified location.
- If you omit this parameter, the system saves the file as register_user-response-header.tmp in your home directory.
[-o <output-file>] An optional parameter, specifying a path and filename in your local system. The system always creates an output file:
- If you specify this parameter, the system saves the output to the specified file in the specified location.
- If you omit this parameter, the system saves the output as register_user-response-message.json.tmp in your home directory.
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: