Get a user by ID

GET 
/users/:userId

The Get User request allows you to retrieve information about a specific user in ANSCER ANYA. This request takes in the user's unique ID as a parameter, and returns a JSON object containing information about the user, including their name, email, and role.

Request

Path Parameters

userId stringrequired

The ID of the user to retrieve, update or delete

Responses

200

User details

application/json

Schema

Schema

_id uuid
name string

Possible values: >= 3 characters and <= 50 characters

email email

Possible values: >= 5 characters and <= 255 characters

isActive boolean
role userRoles

Possible values: [developer, admin, user]

createdBy object
The user who created this user
_id string
name string
email email
updatedBy object
The user who last updated this user
_id string
name string
email email
createdAt date-time

The date and time this user was created

updatedAt date-time

The date and time this user was last updated

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "email": "user@example.com",
  "isActive": true,
  "role": "developer",
  "createdBy": {
    "_id": "string",
    "name": "string",
    "email": "user@example.com"
  },
  "updatedBy": {
    "_id": "string",
    "name": "string",
    "email": "user@example.com"
  },
  "createdAt": "2024-12-03T13:26:27.363Z",
  "updatedAt": "2024-12-03T13:26:27.363Z"
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

404

Resource not found.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Resource not found."
}

Example

{
  "message": "Resource not found."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...