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

Log into the system.

Query parameters
usernamestringOptional

The user name for login

passwordstringOptional

The password for login in clear text

Responses
200
successful operation
Responsestring
get
GET /api/v3/user/login HTTP/1.1
Host: 
Accept: */*

<?xml version="1.0"?>
<object>text</object>

Logs out current logged in user session.

get

Log user out of the system.

Responses
200
successful operation
get
GET /api/v3/user/logout HTTP/1.1
Host: 
Accept: */*

No content

Creating users

Creates list of users with given input array.

post

Creates list of users with given input array.

Bodyobject[]
idinteger · int64OptionalExample: 10
usernamestringOptionalExample: theUser
firstNamestringOptionalExample: John
lastNamestringOptionalExample: James
emailstringOptionalExample: john@email.com
passwordstringOptionalExample: 12345
phonestringOptionalExample: 12345
userStatusinteger · int32Optional

User Status

Example: 1
Responses
200
Successful operation
post
POST /api/v3/user/createWithList HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 145

[
  {
    "id": 10,
    "username": "theUser",
    "firstName": "John",
    "lastName": "James",
    "email": "john@email.com",
    "password": "12345",
    "phone": "12345",
    "userStatus": 1
  }
]
{
  "id": 10,
  "username": "theUser",
  "firstName": "John",
  "lastName": "James",
  "email": "john@email.com",
  "password": "12345",
  "phone": "12345",
  "userStatus": 1
}
PreviousPets

Last updated