Users

Good to know: All the methods shown below are synced to an example OpenAPI file URL and are kept up to date automatically with changes to the API.

User actions

Logs user into the system

GET/api/v3/user/login
Query parameters
Response

successful operation

Headers
Body
string
Request
const response = await fetch('/api/v3/user/login', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
text

Logs out current logged in user session

GET/api/v3/user/logout
Response

successful operation

Request
const response = await fetch('/api/v3/user/logout', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Creating users

Creates list of users with given input array

Creates list of users with given input array

POST/api/v3/user/createWithList
Body
idinteger (int64)
Example: 10
usernamestring
Example: "theUser"
firstNamestring
Example: "John"
lastNamestring
Example: "James"
emailstring
Example: "john@email.com"
passwordstring
Example: "12345"
phonestring
Example: "12345"
userStatusinteger (int32)
User Status
Example: 1
Response

Successful operation

Body
idinteger (int64)
Example: 10
usernamestring
Example: "theUser"
firstNamestring
Example: "John"
lastNamestring
Example: "James"
emailstring
Example: "john@email.com"
passwordstring
Example: "12345"
phonestring
Example: "12345"
userStatusinteger (int32)
User Status
Example: 1
Request
const response = await fetch('/api/v3/user/createWithList', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();
Response
{
  "id": 10,
  "username": "theUser",
  "firstName": "John",
  "lastName": "James",
  "email": "john@email.com",
  "password": "12345",
  "phone": "12345",
  "userStatus": 1
}
PreviousPets

Last updated