NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For HPCDATAMGM-1077: Added new options.

...

  1. Make sure the user has an NIH user account. 
  2. In your file system, create a JSON file that specifies the user's first name, last name, and default base path, as follows:

    Code Block
    {
       "firstName": "John",
       "lastName": "Doe",
       "defaultBasePath" : "/FNLCR",
       "doc" : "FNLCR"
    }
  3. Run the following command:

    Code Block
    dm_register_user [-hoptional parameters] <userId> <description.json> 

    The following table describes each parameter:

    ParameterDescription
    [-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 file 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 <status-file>]

    An optional parameter, specifying a path and filename in your file system. The system always creates a status file: 

    • If you specify this parameter, the system saves the status to the specified file in the specified location.
    • If you omit this parameter, the system saves the status as register_user-response-message.json.tmp in your home directory. 

    If the command is successful, the status 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.)

...