Skip to content
Ona API Reference
Ona Docs
API Reference
Groups

Memberships

CreateMembership
groups.memberships.create(MembershipCreateParams**kwargs) -> MembershipCreateResponse
POST/gitpod.v1.GroupService/CreateMembership
DeleteMembership
groups.memberships.delete(MembershipDeleteParams**kwargs) -> object
POST/gitpod.v1.GroupService/DeleteMembership
ListMemberships
groups.memberships.list(MembershipListParams**kwargs) -> SyncMembersPage[GroupMembership]
POST/gitpod.v1.GroupService/ListMemberships
GetMembership
groups.memberships.retrieve(MembershipRetrieveParams**kwargs) -> MembershipRetrieveResponse
POST/gitpod.v1.GroupService/GetMembership
ModelsExpand Collapse
class GroupMembership: …

GroupMembership represents a subject’s membership in a group

id: Optional[str]

Unique identifier for the group membership

formatuuid
avatar_url: Optional[str]

Subject’s avatar URL

group_id: Optional[str]

Group identifier

formatuuid
name: Optional[str]

Subject’s display name

subject: Optional[Subject]

Subject (user, runner, environment, service account, etc.)

id: Optional[str]

id is the UUID of the subject

formatuuid
principal: Optional[Principal]

Principal is the principal of the subject

One of the following:
"PRINCIPAL_UNSPECIFIED"
"PRINCIPAL_ACCOUNT"
"PRINCIPAL_USER"
"PRINCIPAL_RUNNER"
"PRINCIPAL_ENVIRONMENT"
"PRINCIPAL_SERVICE_ACCOUNT"
"PRINCIPAL_RUNNER_MANAGER"
class MembershipCreateResponse: …
member: Optional[GroupMembership]

GroupMembership represents a subject’s membership in a group

id: Optional[str]

Unique identifier for the group membership

formatuuid
avatar_url: Optional[str]

Subject’s avatar URL

group_id: Optional[str]

Group identifier

formatuuid
name: Optional[str]

Subject’s display name

subject: Optional[Subject]

Subject (user, runner, environment, service account, etc.)

id: Optional[str]

id is the UUID of the subject

formatuuid
principal: Optional[Principal]

Principal is the principal of the subject

One of the following:
"PRINCIPAL_UNSPECIFIED"
"PRINCIPAL_ACCOUNT"
"PRINCIPAL_USER"
"PRINCIPAL_RUNNER"
"PRINCIPAL_ENVIRONMENT"
"PRINCIPAL_SERVICE_ACCOUNT"
"PRINCIPAL_RUNNER_MANAGER"
class MembershipRetrieveResponse: …
member: Optional[GroupMembership]

The membership if found, nil if subject is not a member

id: Optional[str]

Unique identifier for the group membership

formatuuid
avatar_url: Optional[str]

Subject’s avatar URL

group_id: Optional[str]

Group identifier

formatuuid
name: Optional[str]

Subject’s display name

subject: Optional[Subject]

Subject (user, runner, environment, service account, etc.)

id: Optional[str]

id is the UUID of the subject

formatuuid
principal: Optional[Principal]

Principal is the principal of the subject

One of the following:
"PRINCIPAL_UNSPECIFIED"
"PRINCIPAL_ACCOUNT"
"PRINCIPAL_USER"
"PRINCIPAL_RUNNER"
"PRINCIPAL_ENVIRONMENT"
"PRINCIPAL_SERVICE_ACCOUNT"
"PRINCIPAL_RUNNER_MANAGER"