Variable Permission

Manage permissions on a project’s variable (in a table).

opal perm-variable <CREDENTIALS> [OPTIONS] [EXTRAS]

Options

Option	Description
--fetch, -f	Fetch permissions
--add, -a	Add a permission
--delete, -d	Delete a permission
--permission PERM, -pe PERM	Permission to apply: view
--subject SUBJECT, -s SUBJECT	Subject name to which the permission will be granted (required on add/delete)
--type TYPE, -ty TYPE	Subject type: user or group
--project PROJECT, -pr PROJECT	Project name on which the permission is to be set
--table TABLE, -t TABLE	Table name to which the variables belong
--variables VARIABLE [VARIABLE ...], -va VARIABLE [VARIABLE ...]	List of variable names on which the permission is to be get/set (default is all)

Credentials

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)

Extras

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

Example

Add view permission for subject demouser on variables GENDER and LAB_HDL of table CNSIM1 in datashield project:

opal perm-variable --opal https://opal-demo.obiba.org --user administrator --password password --type USER --subject demouser --project datashield --table CNSIM1 --variables GENDER LAB_HDL --permission view  --add

Remove the above permission:

opal perm-variable --opal https://opal-demo.obiba.org --user administrator --password password --type USER --subject demouser --project datashield --table CNSIM1 --variables GENDER LAB_HDL --delete