Get a user by username

1 parameter

usernamestringrequired

The username of the account to retrieve. Use user1 for testing.

4 status codes

200Returns the user object, including its identifier and account details.

emailstringoptional

firstNamestringoptional

idintegeroptional

lastNamestringoptional

passwordstringoptional

phonestringoptional

userStatusintegeroptional

User Status

usernamestringoptional

400Returned when the supplied username is invalid.

404Returned when the user is not found.

defaultReturned when an unexpected error occurs.

Error handling

A 400 is returned when the username path parameter is invalid. A 404 is returned when the specified user is not found.

import os

from testing_sdk import ClientConfig, ClientAuthConfig, SwaggerPetstoreOpenAPI30

config = ClientConfig(
    base_url="/api/v3",
    auth=ClientAuthConfig(api_key=os.environ["SWAGGER_PETSTORE_API_KEY"]),
)
client = SwaggerPetstoreOpenAPI30(config)

result = client.user.get_by_name(username="octocat")

{
  "email": "john@email.com",
  "firstName": "John",
  "id": 10,
  "lastName": "James",
  "password": "12345",
  "phone": "12345",
  "userStatus": 1,
  "username": "theUser"
}

Request

Response

Errors