usersGetByUsername
Get a user
Details
- Method:
GET - Path:
/users/{username} - Operation ID:
users/get-by-username
Parameters
{
"username": {
"description": "The handle for the GitHub user account.",
"required": true,
"location": "path",
"type": "string"
}
}Response Schema
{
"oneOf": [
{
"title": "Private User",
"description": "Private User",
"type": "object",
"properties": {
"login": {
"type": "string",
"example": "octocat"
},
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user_view_type": {
"type": "string"
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"gravatar_id": {
"type": "string",
"example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"type": {
"type": "string",
"example": "User"
},
"site_admin": {
"type": "boolean"
},
"name": {
"type": "string",
"example": "monalisa octocat",
"nullable": true
},
"company": {
"type": "string",
"example": "GitHub",
"nullable": true
},
"blog": {
"type": "string",
"example": "https://github.com/blog",
"nullable": true
},
"location": {
"type": "string",
"example": "San Francisco",
"nullable": true
},
"email": {
"type": "string",
"format": "email",
"example": "octocat@github.com",
"nullable": true
},
"notification_email": {
"type": "string",
"format": "email",
"example": "octocat@github.com",
"nullable": true
},
"hireable": {
"type": "boolean",
"nullable": true
},
"bio": {
"type": "string",
"example": "There once was...",
"nullable": true
},
"twitter_username": {
"type": "string",
"example": "monalisa",
"nullable": true
},
"public_repos": {
"type": "integer",
"example": 2
},
"public_gists": {
"type": "integer",
"example": 1
},
"followers": {
"type": "integer",
"example": 20
},
"following": {
"type": "integer",
"example": 0
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2008-01-14T04:33:35Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2008-01-14T04:33:35Z"
},
"private_gists": {
"type": "integer",
"example": 81
},
"total_private_repos": {
"type": "integer",
"example": 100
},
"owned_private_repos": {
"type": "integer",
"example": 100
},
"disk_usage": {
"type": "integer",
"example": 10000
},
"collaborators": {
"type": "integer",
"example": 8
},
"two_factor_authentication": {
"type": "boolean",
"example": true
},
"plan": {
"type": "object",
"properties": {
"collaborators": {
"type": "integer"
},
"name": {
"type": "string"
},
"space": {
"type": "integer"
},
"private_repos": {
"type": "integer"
}
},
"required": [
"collaborators",
"name",
"space",
"private_repos"
]
},
"business_plus": {
"type": "boolean"
},
"ldap_dn": {
"type": "string"
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url",
"bio",
"blog",
"company",
"email",
"followers",
"following",
"hireable",
"location",
"name",
"public_gists",
"public_repos",
"created_at",
"updated_at",
"collaborators",
"disk_usage",
"owned_private_repos",
"private_gists",
"total_private_repos",
"two_factor_authentication"
]
},
{
"title": "Public User",
"description": "Public User",
"type": "object",
"properties": {
"login": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"user_view_type": {
"type": "string"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string",
"format": "uri"
},
"gravatar_id": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"company": {
"type": "string",
"nullable": true
},
"blog": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"format": "email",
"nullable": true
},
"notification_email": {
"type": "string",
"format": "email",
"nullable": true
},
"hireable": {
"type": "boolean",
"nullable": true
},
"bio": {
"type": "string",
"nullable": true
},
"twitter_username": {
"type": "string",
"nullable": true
},
"public_repos": {
"type": "integer"
},
"public_gists": {
"type": "integer"
},
"followers": {
"type": "integer"
},
"following": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"plan": {
"type": "object",
"properties": {
"collaborators": {
"type": "integer"
},
"name": {
"type": "string"
},
"space": {
"type": "integer"
},
"private_repos": {
"type": "integer"
}
},
"required": [
"collaborators",
"name",
"space",
"private_repos"
]
},
"private_gists": {
"type": "integer",
"example": 1
},
"total_private_repos": {
"type": "integer",
"example": 2
},
"owned_private_repos": {
"type": "integer",
"example": 2
},
"disk_usage": {
"type": "integer",
"example": 1
},
"collaborators": {
"type": "integer",
"example": 3
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url",
"bio",
"blog",
"company",
"email",
"followers",
"following",
"hireable",
"location",
"name",
"public_gists",
"public_repos",
"created_at",
"updated_at"
],
"additionalProperties": false
}
]
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('usersGetByUsername', {
# Add required parameters here
})