Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations

SetRole

organizations.set_role(OrganizationSetRoleParams**kwargs) -> object
POST/gitpod.v1.OrganizationService/SetRole

Manages organization membership and roles by setting a user’s role within the organization.

Use this method to:

  • Promote members to admin role
  • Change member permissions
  • Demote admins to regular members

Examples

  • Promote to admin:

    Makes a user an organization administrator.

    organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
role: ORGANIZATION_ROLE_ADMIN

  • Change to member:

    Changes a user’s role to regular member.

    organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
role: ORGANIZATION_ROLE_MEMBER
ParametersExpand Collapse
organization_id: str
formatuuid
user_id: str
formatuuid
role: Optional[OrganizationRole]
One of the following:
"ORGANIZATION_ROLE_UNSPECIFIED"
"ORGANIZATION_ROLE_ADMIN"
"ORGANIZATION_ROLE_MEMBER"
ReturnsExpand Collapse
object

SetRole

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.organizations.set_role(
    organization_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
    user_id="f53d2330-3795-4c5d-a1f3-453121af9c60",
    role="ORGANIZATION_ROLE_MEMBER",
)
print(response)
{}
Returns Examples
{}