D4Science D4Science Don't have a D4Science account? Create one Could not find what you are looking for? Contact us.

UserManager Resource

Manage users

GET /users

Get a list of users

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Response Codes
code condition
200 Success.
Response Body
media type data type description
application/json UsersList (JSON) list of users

Example

Request
GET /users
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "users" : [ {
    "userName" : "...",
    "homeVersion" : 12345
  }, {
    "userName" : "...",
    "homeVersion" : 12345
  } ]
}

POST /users

Create a new user
Only users with Infrastructure-Manager role allowed

Request Parameters
name type description
password form user password
user form user name
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Request Body
media type data type
application/x-www-form-urlencoded (custom)
Response Codes
code condition
200 User created.
400 Wrong set of parameters.
403 You're not allowed to create users.
415 Wrong content type.
Response Body
media type data type description
text/plain string user name

Example

Request
POST /users
Content-Type: application/x-www-form-urlencoded
Accept: text/plain
Authorization:  ...

user=nome.utente&password=passw0rd

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

DELETE /users/{user}

Delete a user
Only users with Infrastructure-Manager role allowed

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
user path user name
Response Codes
code condition
200 User deleted.
403 You're not allowed to delete users.
406 User does not exist.
Response Body
media type data type description
text/plain string user name

Example

Request
DELETE /users/{user}
Content-Type: */*
Accept: text/plain
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

GET /users/{user}

Get user details

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
user path user name
Response Codes
code condition
200 User found.
406 User does not exist.
Response Body
media type data type description
application/json SHUBUser (JSON) user detail

Example

Request
GET /users/{user}
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "userName" : "...",
  "homeVersion" : 12345
}

PUT /users/{user}

Update user to the last 'home' version
Only users with Infrastructure-Manager role allowed

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
user path user name
Request Body
media type data type
application/x-www-form-urlencoded (custom)
Response Codes
code condition
200 Home update done.
403 You're not allowed to create users.
415 Wrong content type.
Response Body
media type data type description
application/json string (JSON) user id

Example

Request
PUT /users/{user}
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /users/{user}/groups

Get a list of groups for the specified user

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
user path user name
Response Codes
code condition
200 User found.
500 User does not exist.
Response Body
media type data type description
application/json array of string (JSON) List of groups

Example

Request
GET /users/{user}/groups
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...