Skip to content
Ona API Reference
Ona Docs
API Reference
Users

SetSuspended

users.set_suspended(UserSetSuspendedParams**kwargs) -> object
POST/gitpod.v1.UserService/SetSuspended

Sets whether a user account is suspended.

Use this method to:

  • Suspend problematic users
  • Reactivate suspended accounts
  • Manage user access

Examples

  • Suspend user:

    Suspends a user account.

    userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
suspended: true

  • Reactivate user:

    Removes suspension from a user account.

    userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
suspended: false
ParametersExpand Collapse
suspended: Optional[bool]
user_id: Optional[str]
formatuuid
ReturnsExpand Collapse
object

SetSuspended

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.set_suspended(
    suspended=False,
    user_id="f53d2330-3795-4c5d-a1f3-453121af9c60",
)
print(response)
{}
Returns Examples
{}