Skip to content
Ona API Reference
Ona Docs
API Reference
Groups

Memberships

CreateMembership
client.groups.memberships.create(MembershipCreateParams { groupId, subject } body, RequestOptionsoptions?): MembershipCreateResponse { member }
POST/gitpod.v1.GroupService/CreateMembership
DeleteMembership
client.groups.memberships.delete(MembershipDeleteParams { membershipId } body, RequestOptionsoptions?): MembershipDeleteResponse
POST/gitpod.v1.GroupService/DeleteMembership
ListMemberships
client.groups.memberships.list(MembershipListParams { token, pageSize, filter, 2 more } params, RequestOptionsoptions?): MembersPage<GroupMembership { id, avatarUrl, groupId, 2 more } >
POST/gitpod.v1.GroupService/ListMemberships
GetMembership
client.groups.memberships.retrieve(MembershipRetrieveParams { subject, groupId } body, RequestOptionsoptions?): MembershipRetrieveResponse { member }
POST/gitpod.v1.GroupService/GetMembership
ModelsExpand Collapse
GroupMembership { id, avatarUrl, groupId, 2 more }

GroupMembership represents a subject’s membership in a group

id?: string

Unique identifier for the group membership

formatuuid
avatarUrl?: string

Subject’s avatar URL

groupId?: string

Group identifier

formatuuid
name?: string

Subject’s display name

subject?: Subject { id, principal }

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

id?: string

id is the UUID of the subject

formatuuid
principal?: 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 { member }
member?: GroupMembership { id, avatarUrl, groupId, 2 more }

GroupMembership represents a subject’s membership in a group

id?: string

Unique identifier for the group membership

formatuuid
avatarUrl?: string

Subject’s avatar URL

groupId?: string

Group identifier

formatuuid
name?: string

Subject’s display name

subject?: Subject { id, principal }

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

id?: string

id is the UUID of the subject

formatuuid
principal?: 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 { member }
member?: GroupMembership { id, avatarUrl, groupId, 2 more }

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

id?: string

Unique identifier for the group membership

formatuuid
avatarUrl?: string

Subject’s avatar URL

groupId?: string

Group identifier

formatuuid
name?: string

Subject’s display name

subject?: Subject { id, principal }

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

id?: string

id is the UUID of the subject

formatuuid
principal?: 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"