Platform

cxp orchestration / Reference / REST API

user

Operations about user

Operations

POST/user POST/user/createWithArray POST/user/createWithList GET/user/login GET/user/logout GET/user/{username}PUT/user/{username}DEL/user/{username}

POST

Create user

This can only be done by the logged in user.

Request

Request bodyapplication/json

Created user object

integer

username

string

firstName

string

lastName

string

email

string

password

string

phone

string

userStatus

integer

Responses

successful operation

POST/user

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://petstore.swagger.io/v2/user' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 2154,
  "username": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "password": "<string>",
  "phone": "<string>",
  "userStatus": 11
}'

POST

Creates list of users with given input array

Request

Request bodyapplication/json

List of user object

array<User>

integer

username

string

firstName

string

lastName

string

email

string

password

string

phone

string

userStatus

integer

Responses

successful operation

POST/user/createWithArray

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://petstore.swagger.io/v2/user/createWithArray' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": 2154,
    "username": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "password": "<string>",
    "phone": "<string>",
    "userStatus": 11
  }
]'

POST

Creates list of users with given input array

Request

Request bodyapplication/json

List of user object

array<User>

integer

username

string

firstName

string

lastName

string

email

string

password

string

phone

string

userStatus

integer

Responses

successful operation

POST/user/createWithList

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://petstore.swagger.io/v2/user/createWithList' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": 2154,
    "username": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "password": "<string>",
    "phone": "<string>",
    "userStatus": 11
  }
]'

GET

username

string

Required

password

string

Required

successful operation

Headers

X-Rate-Limit

integer

X-Expires-After

string

application/xml application/json

string

GET/user/login

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://petstore.swagger.io/v2/user/login?username={username}&password={password}' \
  --header 'Accept: application/xml'

200Response

"<string>"

GET

Logs out current logged in user session

Request

This request has no parameters.

Responses

successful operation

GET/user/logout

curl

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://petstore.swagger.io/v2/user/logout'

GET

Get user by user name

Request

Path parameters

username

string

Required

Responses

successful operation

application/xml application/json

User

GET/user/{username}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://petstore.swagger.io/v2/user/{username}' \
  --header 'Accept: application/xml'

200Response

{
  "id": 2154,
  "username": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "password": "<string>",
  "phone": "<string>",
  "userStatus": 11
}

PUT

Updated user

This can only be done by the logged in user.

Request

Path parameters

username

string

Required

Request bodyapplication/json

Updated user object

integer

username

string

firstName

string

lastName

string

email

string

password

string

phone

string

userStatus

integer

Responses

Invalid user supplied

PUT/user/{username}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://petstore.swagger.io/v2/user/{username}' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 2154,
  "username": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "password": "<string>",
  "phone": "<string>",
  "userStatus": 11
}'

DEL

Delete user

This can only be done by the logged in user.

Request

Path parameters

username

string

Required

Responses

Invalid username supplied

DEL/user/{username}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://petstore.swagger.io/v2/user/{username}'