endpoint-users.md

Endpoint: /users

This endpoint deals with users.

GET /users

Retrieve the whole collection of users. Accepts the following filter params:

• limit: Limit the number of results per page (default: 20).
• page: Select a page of results (default: 1).
• email: Find a user by its email (strict matching).
• ids: Get a list of users by ids.
• search: Get a list of users who's first name and last name match search.

Requires

• Scope: users:get

Response payload

{
  "results": [{
    "id": String,
    "firstName": String,
    "lastName": String,
    "email": String,
    "fallbackEmail": String,
    "description": String,
    "pictureProfileUrl": String,
    "createdAt": Date,
    "roles": [String]
  }],
  "page": Number,      // Requested page.
  "limit": Number,     // Requested limit of results per page.
  "pageCount": Number  // Amount of pages regarding the results per page.
}

POST /users

Creates a new user. Requires to specify at least one valid role in: tech, hr, finance, com, business and board. Also requires to have either hr or board in logged user roles to perform request.

Requires

• Role: rh or board
• Scope: users:create

Request payload

{
  "firstName": String,          // required
  "lastName": String,           // required
  "email": String,              // required
  "fallbackEmail": String,
  "description": String,
  "plainPassword": String,      // required
  "roles": [String]             // required
}

Response payload

{
  "id": String,
  "firstName": String,
  "lastName": String,
  "email": String,
  "fallbackEmail": String,
  "description": String,
  "pictureProfileUrl": String,
  "createdAt": Date,
  "roles": [String]
}

GET /users/{id}

Retrieve a user.

Requires

• Scope: users:get or profile:get if self getting

Response payload

{
  "id": String,
  "firstName": String,
  "lastName": String,
  "email": String,
  "fallbackEmail": String,
  "description": String,
  "pictureProfileUrl": String,
  "createdAt": Date,
  "roles": [String]
}

PUT /users/{id}

Updates a user. Connected user can edit himself. To edit user roles, connected user requires either hr or board in his roles.

Requires

• Role: rh or board
• Scope: users:modify or profile:modify if self editing

Request payload

{
  "firstName": String,
  "lastName": String,
  "email": String,
  "fallbackEmail": String,
  "description": String,
  "roles": [String]         // requires hr/board role
}

DELETE /users/{id}

Deletes an user. To delete a user, connected user requires either hr or board in his roles.

Requires

• Role: rh or board
• Scope: users:delete

Request payload

{
  "deleted": Boolean,
}

GET /users/me

Retrieve the user corresponding to given access token.

Requires

• Scope: profile:get

Response payload

{
  "id": String,
  "firstName": String,
  "lastName": String,
  "email": String,
  "fallbackEmail": String,
  "description": String,
  "pictureProfileUrl": String,
  "createdAt": Date,
  "roles": [String]
}