Swagger Petstore - OpenAPI 3.0
POST/user

Create a user

Creates a user from the supplied user details. Provide fields such as username, email, and password; the schema does not mark any fields as required. The operation is described as available only to the authenticated user.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

8 body fields

User details for creating a user. The request body is optional, and no fields are marked as required.

idintegeroptional
The user's identifier.
usernamestringoptional
The user's username.
firstNamestringoptional
The user's first name.
lastNamestringoptional
The user's last name.
emailstringoptional
The user's email address.
passwordstringoptional
The user's password.
phonestringoptional
The user's phone number.
userStatusintegeroptional
User Status

2 status codes
200Returns a user object with its identifier, username, name, email, password, phone number, and status.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultUnexpected error

Error handling

The request body is optional, and the schema marks no user fields as required. If supplied, id and userStatus must be integers, while the other user properties must be strings.