user

user

Operations about user

user Endpoints

Creates list of users with given input array

Body Parameters
  • body
    array object[]
    required

    List of user object

Responses
  • default

    successful operation

POST/user/createWithList
curl https://petstore.swagger.io/v2/user/createWithList \
  --request POST \
  --header 'Api_key: YOUR_SECRET_TOKEN' \
  --header 'Content-Type: text/plain;charset=UTF-8' \
  --data "[
  {
    "id": 1,
    "username": "",
    "firstName": "",
    "lastName": "",
    "email": "",
    "password": "",
    "phone": "",
    "userStatus": 1
  }
]"
No Body

successful operation

Get user by user name

Path Parameters
  • username
    required

    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}
curl https://petstore.swagger.io/v2/user/ \
  --header 'Api_key: YOUR_SECRET_TOKEN'

{
  "id": 1,
  "username": "…",
  "firstName": "…",
  "lastName": "…",
  "email": "…",
  "password": "…",
  "phone": "…",
  "userStatus": 1
}

successful operation

Updated user

This can only be done by the logged in user.

Path Parameters
  • username
    required

    name that need to be updated

Body Parameters
  • body
    object
    required
Responses
  • 400

    Invalid user supplied

  • 404

    User not found

PUT/user/{username}
curl https://petstore.swagger.io/v2/user/ \
  --request PUT \
  --header 'Api_key: YOUR_SECRET_TOKEN' \
  --header 'Content-Type: text/plain;charset=UTF-8' \
  --data "{
  "id": 1,
  "username": "",
  "firstName": "",
  "lastName": "",
  "email": "",
  "password": "",
  "phone": "",
  "userStatus": 1
}"
No Body

Invalid user supplied

Delete user

This can only be done by the logged in user.

Path Parameters
  • username
    required

    The name that needs to be deleted

Responses
  • 400

    Invalid username supplied

  • 404

    User not found

DELETE/user/{username}
curl https://petstore.swagger.io/v2/user/ \
  --request DELETE \
  --header 'Api_key: YOUR_SECRET_TOKEN' \
  --header 'Content-Type: text/plain;charset=UTF-8' \
  --data ""
No Body

Invalid username supplied

Logs user into the system

Query Parameters
  • username
    required

    The user name for login

  • password
    required

    The password for login in clear text

Responses
  • 200

    successful operation

  • 400

    Invalid username/password supplied

GET/user/login
curl https://petstore.swagger.io/v2/user/login \
  --header 'Api_key: YOUR_SECRET_TOKEN'

…

successful operation

Logs out current logged in user session

Responses
  • default

    successful operation

GET/user/logout
curl https://petstore.swagger.io/v2/user/logout \
  --header 'Api_key: YOUR_SECRET_TOKEN'
No Body

successful operation

Creates list of users with given input array

Body Parameters
  • body
    array object[]
    required

    List of user object

Responses
  • default

    successful operation

POST/user/createWithArray
curl https://petstore.swagger.io/v2/user/createWithArray \
  --request POST \
  --header 'Api_key: YOUR_SECRET_TOKEN' \
  --header 'Content-Type: text/plain;charset=UTF-8' \
  --data "[
  {
    "id": 1,
    "username": "",
    "firstName": "",
    "lastName": "",
    "email": "",
    "password": "",
    "phone": "",
    "userStatus": 1
  }
]"
No Body

successful operation

Create user

This can only be done by the logged in user.

Body Parameters
  • body
    object
    required
Responses
  • default

    successful operation

POST/user
curl https://petstore.swagger.io/v2/user \
  --request POST \
  --header 'Api_key: YOUR_SECRET_TOKEN' \
  --header 'Content-Type: text/plain;charset=UTF-8' \
  --data "{
  "id": 1,
  "username": "",
  "firstName": "",
  "lastName": "",
  "email": "",
  "password": "",
  "phone": "",
  "userStatus": 1
}"
No Body

successful operation