user

Operations about user

Find out more about our store

Create user

This can only be done by the logged in user.

Request
Request Body schema: application/json

Created user object

id
integer <int64>
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
integer <int32>

User Status

Responses
default

successful operation

post/user
Request samples
application/json
{
  • "id": 0,
  • "username": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "password": "string",
  • "phone": "string",
  • "userStatus": 0
}

Creates list of users with given input array

Request
Request Body schema: application/json

List of user object

Array
id
integer <int64>
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
integer <int32>

User Status

Responses
default

successful operation

post/user/createWithArray
Request samples
application/json
[
  • {
    }
]

Creates list of users with given input array

Request
Request Body schema: application/json

List of user object

Array
id
integer <int64>
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
integer <int32>

User Status

Responses
default

successful operation

post/user/createWithList
Request samples
application/json
[
  • {
    }
]

Logs user into the system

Request
query Parameters
username
required
string

The user name for login

password
required
string

The password for login in clear text

Responses
200

successful operation

400

Invalid username/password supplied

get/user/login
Response samples
No sample

Logs out current logged in user session

Responses
default

successful operation

get/user/logout

Get user by user name

Request
path Parameters
username
required
string

The name that needs to be fetched. Use user1 for testing.

Responses
200

successful operation

400

Invalid username supplied

404

User not found

get/user/{username}
Response samples
No sample

Updated user

This can only be done by the logged in user.

Request
path Parameters
username
required
string

name that need to be updated

Request Body schema: application/json

Updated user object

id
integer <int64>
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
integer <int32>

User Status

Responses
200

OK

400

Invalid user supplied

404

User not found

put/user/{username}
Request samples
application/json
{
  • "id": 0,
  • "username": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "password": "string",
  • "phone": "string",
  • "userStatus": 0
}

Delete user

This can only be done by the logged in user.

Request
path Parameters
username
required
string

The name that needs to be deleted

Responses
200

OK

400

Invalid username supplied

404

User not found

delete/user/{username}