You are in REST API » v15.1 || Go to



Users


Get all users data

  • URL: /users/
  • Method: GET
  • Parameters: NONE
  • Example:
    curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
     https://minerva-dev.lcsb.uni.lu/minerva/api/users/
    

Get specific user data

  • URL: /users/{login}/
  • Method: GET
  • Parameters:
    • login - user login
  • Example:
    curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
     https://minerva-dev.lcsb.uni.lu/minerva/api/users/anonymous
    

Create user

  • URL: /users/{login}/
  • Method: POST
  • Parameters:
    • login - user login
    • name
    • surname
    • email
    • password
    • termsOfUseConsent - user agreed to Terms of Service
    • connectedToLdap - user is connected to ldap
  • Example:
    curl -X POST --data 'name=Guest account&password=xxx}' \
     --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    https://minerva-dev.lcsb.uni.lu/minerva/api/users/test
    

Update user data

  • URL: /users/{login}/
  • Method: PATCH
  • Parameters:
    • login - user login
    • body - json object with parameters to modify
      • name
      • surname
      • email
      • password
    • termsOfUseConsent - user agreed to Terms of Service
    • connectedToLdap - user is connected to ldap
  • Example:
    curl -X PATCH --data '{"user":{"name":"Guest account"}}' \
     --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
     https://minerva-dev.lcsb.uni.lu/minerva/api/users/anonymous
    

Delete user

  • URL: /users/{login}/
  • Method: DELETE
  • Parameters:
    • login - user login
  • Example:
    curl -X DELETE --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    https://minerva-dev.lcsb.uni.lu/minerva/api/users/test
    

Update user privileges

  • URL: /users/{login}:updatePrivileges
  • Method: PATCH
  • Parameters:
    • login - user login
    • body - json structure describing privileges, see example
  • Example:
    curl -X PATCH --data '{"privileges"::{"READ_PROJECT:empty":true}}' \
     --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    https://minerva-dev.lcsb.uni.lu/minerva/api/users/anonymous:updatePrivileges
    

Update user preferences

  • URL: /users/{login}:updatePreferences
  • Method: PATCH
  • Description: User preferences is a set of configuration parameters for user interface.
  • Parameters:
    • login - user login
    • body - TODO
  • Example: TODO

Request rest password

  • URL: /users/{login}:requestResetPassword
  • Method: POST
  • Parameters:
    • login - user login
  • Example:
    curl 'http://minerva-dev.lcsb.uni.lu/users/admin:requestResetPassword' -i -X POST
    

Rest password

  • URL: /users:resetPassword
  • Method: POST
  • Parameters:
    • password - new password
    • token - token obtained over email
  • Example:
    curl 'http://minerva-dev.lcsb.uni.lu/users:resetPassword' -i -X POST \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -d 'token=f31c68e3-a1bb-4531-825a-8bb1117c36c7&password=pass2'
    


Back to top