You are in REST API » v13.2 || Go to

Users

• Get all users data
• Get specific user data
• Create user
• Update user data
• Delete user
• Update user privileges
• Update user preferences

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":{"VIEW_PROJECT":{"104":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