Users

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

User actions

Logs user into the system

get

https://petstore.swagger.io/v2http://petstore.swagger.io/v2

/user/login

Query parameters

usernamestringRequired

The user name for login

passwordstringRequired

The password for login in clear text

Responses

200

successful operation

application/jsonapplication/xml

Responsestring

400

Invalid username/password supplied

get

/user/login

HTTPcURLJavaScriptPython

GET /v2/user/login?username=text&password=text HTTP/1.1
Host: petstore.swagger.io
Accept: */*

text

Logs out current logged in user session

get

https://petstore.swagger.io/v2http://petstore.swagger.io/v2

/user/logout

Responses

default

successful operation

get

/user/logout

HTTPcURLJavaScriptPython

GET /v2/user/logout HTTP/1.1
Host: petstore.swagger.io
Accept: */*

default

successful operation

No content

Creating users

Creates list of users with given input array

post

https://petstore.swagger.io/v2http://petstore.swagger.io/v2

/user/createWithList

Bodyobject[]

application/json

idinteger · int64Optional

usernamestringOptional

firstNamestringOptional

lastNamestringOptional

emailstringOptional

passwordstringOptional

phonestringOptional

userStatusinteger · int32Optional

User Status

Responses

default

successful operation

post

/user/createWithList

HTTPcURLJavaScriptPython

POST /v2/user/createWithList HTTP/1.1
Host: petstore.swagger.io
Content-Type: application/json
Accept: */*
Content-Length: 128

[
  {
    "id": 1,
    "username": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "password": "text",
    "phone": "text",
    "userStatus": 1
  }
]

default

successful operation

No content

Creates list of users with given input array

post

https://petstore.swagger.io/v2http://petstore.swagger.io/v2

/user/createWithArray

Bodyobject[]

application/json

idinteger · int64Optional

usernamestringOptional

firstNamestringOptional

lastNamestringOptional

emailstringOptional

passwordstringOptional

phonestringOptional

userStatusinteger · int32Optional

User Status

Responses

default

successful operation

post

/user/createWithArray

HTTPcURLJavaScriptPython

POST /v2/user/createWithArray HTTP/1.1
Host: petstore.swagger.io
Content-Type: application/json
Accept: */*
Content-Length: 128

[
  {
    "id": 1,
    "username": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "password": "text",
    "phone": "text",
    "userStatus": 1
  }
]

default

successful operation

No content