Skip to content
Ona API Reference
Ona Docs
API Reference
Users

GetUser

users.get_user(UserGetUserParams**kwargs) -> UserGetUserResponse
POST/gitpod.v1.UserService/GetUser

Gets basic information about a specific user by their ID.

Use this method to:

  • Retrieve user profile information
  • Get user details for display purposes
  • Fetch user metadata for administrative tasks

Examples

  • Get user by ID:

    Retrieves basic user information by user ID.

    userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
ParametersExpand Collapse
user_id: Optional[str]
formatuuid
ReturnsExpand Collapse
class UserGetUserResponse: …
user: User
id: str

id is a UUID of the user

formatuuid
avatar_url: Optional[str]

avatar_url is a link to the user avatar

created_at: Optional[datetime]

created_at is the creation time

formatdate-time
email: Optional[str]

email is the user’s email address

name: Optional[str]

name is the full name of the user

organization_id: Optional[str]

organization_id is the id of the organization this account is owned by.

+optional if not set, this account is owned by the installation.

formatuuid
status: Optional[UserStatus]

status is the status the user is in

One of the following:
"USER_STATUS_UNSPECIFIED"
"USER_STATUS_ACTIVE"
"USER_STATUS_SUSPENDED"
"USER_STATUS_LEFT"

GetUser

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.users.get_user(
    user_id="f53d2330-3795-4c5d-a1f3-453121af9c60",
)
print(response.user)
{
  "user": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "avatarUrl": "avatarUrl",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "email": "email",
    "name": "name",
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "status": "USER_STATUS_UNSPECIFIED"
  }
}
Returns Examples
{
  "user": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "avatarUrl": "avatarUrl",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "email": "email",
    "name": "name",
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "status": "USER_STATUS_UNSPECIFIED"
  }
}