Skip to content
Ona API Reference
Ona Docs
API Reference
Groups

Memberships

CreateMembership
POST/gitpod.v1.GroupService/CreateMembership
DeleteMembership
POST/gitpod.v1.GroupService/DeleteMembership
ListMemberships
POST/gitpod.v1.GroupService/ListMemberships
GetMembership
POST/gitpod.v1.GroupService/GetMembership
ModelsExpand Collapse
GroupMembership object { id, avatarUrl, groupId, 2 more }

GroupMembership represents a subject’s membership in a group

id: optional string

Unique identifier for the group membership

formatuuid
avatarUrl: optional string

Subject’s avatar URL

groupId: optional string

Group identifier

formatuuid
name: optional string

Subject’s display name

subject: optional Subject { id, principal }

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

id: optional string

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"
MembershipCreateResponse object { member }
member: optional GroupMembership { id, avatarUrl, groupId, 2 more }

GroupMembership represents a subject’s membership in a group

id: optional string

Unique identifier for the group membership

formatuuid
avatarUrl: optional string

Subject’s avatar URL

groupId: optional string

Group identifier

formatuuid
name: optional string

Subject’s display name

subject: optional Subject { id, principal }

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

id: optional string

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"
MembershipDeleteResponse = unknown

Empty response

MembershipRetrieveResponse object { member }
member: optional GroupMembership { id, avatarUrl, groupId, 2 more }

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

id: optional string

Unique identifier for the group membership

formatuuid
avatarUrl: optional string

Subject’s avatar URL

groupId: optional string

Group identifier

formatuuid
name: optional string

Subject’s display name

subject: optional Subject { id, principal }

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

id: optional string

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"