Import Identifiers Mapping

Import Opal server entity identifiers.

opal import-ids-map <CREDENTIALS> <OPTIONS> [EXTRAS]


Option Description
--type TYPE, -t TYPE Entity type of the data (e.g. Participant)
--map MAP, -m MAP Mapping name, i.e. the name associated to the identifiers that will be mapped to the system identifiers
--separator SEP, -s SEP Identifiers separator (default is “,”)


Authentication can be done by username/password credentials OR by personal access token OR by certificate/private key pair (two-way SSL authentication).

Option Description
--opal OPAL, -o OPAL Opal server base url
--user USER, -u USER Credentials auth: user name (requires a password)
--password PASSWORD, -p PASSWORD Credentials auth: user password (requires a user name)
--token TOKEN, -tk TOKEN Token auth: user’s personal access token
--ssl-cert SSL_CERT, -sc SSL_CERT Two-way SSL auth: certificate/public key file (requires a private key)
--ssl-key SSL_KEY, -sk SSL_KEY Two-way SSL auth: private key file (requires a certificate)


Option Description
-h, --help Show the command help’s message.
--verbose, -v Verbose output.
--json, -j Output pretty-print JSON


Import identifiers mapping from keyboard entries.

opal import-ids-map --opal --user administrator --password password --type Participant --map foo

Import identifiers mapping from a file.

opal import-ids-map --opal --user administrator --password password --type Participant --map foo < idsmap.txt

Example of a file of identifiers mapping: