Get User

Description

---

You may retrieve details on a User using the following APIs:

• Get User from username
• Get User from email

Get User from username

---

API URL: PUT https://userapi-demo.s2f.projectx.com/User/find/username

API Reference: /User/find/username

Parameters

Name	Type	Description	Required	Nullable
userName	string	The User's username.	Required	false

Example Request

cURL

  curl -X 'PUT' \
  'https://userapi-demo.s2f.projectx.com/User/find/username?userName=jdoe' \
  -H 'accept: text/plain'

Example Response

Success

{
  "userName": "jdoe",
  "email": "jdoe@projectx.com",
  "userId": 7,
  "firstName": "J",
  "lastName": "Doe",
  "hasSignedAgreements": true,
  "createdAt": "2024-07-20T01:07:58.497254+00:00",
  "roles": [
  ]
}

Error

{
Error: response status is 401
}

Get User from email

---

API URL: PUT https://userapi-demo.s2f.projectx.com/User/find

API Reference: /User/find

Parameters

Name	Type	Description	Required	Nullable
email	string	The User's email.	Required	false

Example Usage

cURL

curl -X 'PUT' \
  'https://userapi-demo.s2f.projectx.com/User/find?email=jdoe%projectx.com' \
  -H 'accept: text/plain'

Example Response

Success

{
  "userName": "jdoe",
  "email": "jdoe@projectx.com",
  "userId": 7,
  "firstName": "J",
  "lastName": "Doe",
  "hasSignedAgreements": false,
  "createdAt": "2024-07-20T01:07:58.497254+00:00",
  "roles": [
  ]
}

Error

{
Error: response status is 401
}