This command line allows user to perform action which requires admin privileges and requires the admin password. The most common use cases are installation of catalog, database and indexes, create users, query the audit etc. As oppose to "opencga.sh", "opencga-admin.sh" does not use RESTful web services and must have direct access to the server to execute commands. The following section explains a few use cases.
User Registration
opencga-admin.sh users create --name John --u john --email john@mail.com --user-password
Import Users From LDAP
opencga-admin.sh users import --auth-origin {originId} --user {userId}
Import Groups Of Users
# Import groups of users
opencga-admin.sh users import --auth-origin {originId} --group {ldapGroupName}
# Import a group (ldapGroupName) of users, create a group (newCatalogGroup) within a study (study) containing the users imported
opencga-admin.sh users import --auth-origin {originId} --group {ldapGroupName} --study-group {newCatalogGroup} --study {study}
Group Synchronisation
opencga-admin.sh users sync --auth-origin {originId} --from {ldapGroupName} --to {catalogGroupName} --study {study}
Table of Contents: