getUserByUsername
Query user information based on user name
Path Parameters
- username required
username
Header Parameters
- Authorization required
Oauth2 token or private token (needs to start with Bearer plus a space)
Responses
- 200
- 401
Success
- application/json
- application/xml
- Schema
- Example (from schema)
Schema
- login string
username
- id string
user id
- url string
The interface path to obtain user information based on the user name
- name string
nickname
- company string
company
- blog string
blog
- location string
location
- email string
email
- bio string
bio
- avatar_url string
avatar
- html_url string
home_url
- public_repos Integer
public_repos count
- total_private_repos Integer
private_repos count
- owned_private_repos Integer
number of private repos created by user
- created_at string
created_at
- updated_at
updated_at
{
"login": "mrpuatomgit",
"id": "63db126c0566d2f7d2c9498c",
"url": "https://api.atomgit.com/users/mrpuatomgit",
"name": "Joooooooo",
"company": "atom",
"blog": "https://youboke.com",
"location": "beijing",
"email": "example@atomgit.com",
"bio": "hello i am putianyang",
"avatar_url": "https://img-host/uploads/user/1656318880150_5104.png",
"html_url": "https://atomgit.com/mrpuatomgit",
"public_repos": 3,
"total_private_repos": 2,
"owned_private_repos": 1,
"created_at": "2023-02-02 09:31:24",
"updated_at": "2023-02-02 09:31:24"
}
- Schema
- Example (from schema)
Schema
- login string
username
- id string
user id
- url string
The interface path to obtain user information based on the user name
- name string
nickname
- company string
company
- blog string
blog
- location string
location
- email string
email
- bio string
bio
- avatar_url string
avatar
- html_url string
home_url
- public_repos Integer
public_repos count
- total_private_repos Integer
private_repos count
- owned_private_repos Integer
number of private repos created by user
- created_at string
created_at
- updated_at
updated_at
<root>
<login>mrpuatomgit</login>
<id>63db126c0566d2f7d2c9498c</id>
<url>https://api.atomgit.com/users/mrpuatomgit</url>
<name>Joooooooo</name>
<company>atom</company>
<blog>https://youboke.com</blog>
<location>beijing</location>
<email>example@atomgit.com</email>
<bio>hello i am putianyang</bio>
<avatar_url>https://img-host/uploads/user/1656318880150_5104.png</avatar_url>
<html_url>https://atomgit.com/mrpuatomgit</html_url>
<public_repos>3</public_repos>
<total_private_repos>2</total_private_repos>
<owned_private_repos>1</owned_private_repos>
<created_at>2023-02-02 09:31:24</created_at>
<updated_at>2023-02-02 09:31:24</updated_at>
</root>
The token is invalid, please check whether the token is correct.
- application/json
- application/xml
- Schema
- Example (from schema)
Schema
- error string
error name
- error_description string
wrong description
{
"error": "invalid_token",
"error_description": "Invalid token, please provide correct token"
}
- Schema
- Example (from schema)
Schema
- error string
error name
- error_description string
wrong description
<root>
<error>invalid_token</error>
<error_description>Invalid token, please provide correct token</error_description>
</root>
Loading...