> ## Documentation Index
> Fetch the complete documentation index at: https://ona.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Membership

> Creates a membership for a user in a group.

`Unary` · [`Groups`](/docs/api-reference/generated/group/overview)

Creates a membership for a user in a group.

Use this method to:

* Add users to groups
* Grant group-based permissions to users

### Examples

* Add a user to a group:

  Creates a membership for a user in a group.

  ```yaml theme={null}
  groupId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  subject:
    id: "f53d2330-3795-4c5d-a1f3-453121af9c60"
    principal: PRINCIPAL_USER
  ```

### Authorization

Requires `org:admin` permission on the organization or `group:admin` permission on the specific group.

## Endpoint

```text theme={null}
POST /api/gitpod.v1.GroupService/CreateMembership
```

Send a Bearer token as described in [Authentication](/docs/api-reference#authenticate-requests). If your organization uses a custom management-plane domain, replace `https://app.ona.com` with that domain.

## Request example

<CodeGroup>
  ```bash cURL theme={null}
  export ONA_HOST=https://app.ona.com
  export ONA_API_KEY=<your-token>

  curl --request POST \
    --url "$ONA_HOST/api/gitpod.v1.GroupService/CreateMembership" \
    --header "Authorization: Bearer $ONA_API_KEY" \
    --header "Content-Type: application/json" \
    --data '{
    "groupId": "<group-id>"
  }'
  ```

  ```python Python theme={null}
  import gitpod.v1.group_pb2 as group_pb2
  from ona_sdk import create_client_from_env

  ona = create_client_from_env()
  request = group_pb2.CreateMembershipRequest(
      group_id="<group-id>",
  )
  response = ona.services.group.create_membership(request)
  print(response)
  ```

  ```typescript TypeScript theme={null}
  import { create } from "@bufbuild/protobuf";
  import { createClientFromEnv } from "@gitpod/sdk";
  import { CreateMembershipRequestSchema } from "@gitpod/sdk/gitpod/v1/group_pb";

  async function main() {
    const ona = createClientFromEnv();
    const request = create(CreateMembershipRequestSchema, {
      groupId: "<group-id>",
    });
    const response = await ona.services.group.createMembership(request);
    console.log(response);
  }

  main().catch(console.error);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"log"

  	"connectrpc.com/connect"
  	"github.com/gitpod-io/gitpod-sdk-go/sdk"
  	gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
  )

  func main() {
  	ona, err := sdk.NewFromEnv()
  	if err != nil {
  		log.Fatal(err)
  	}

  	request := connect.NewRequest(&gitpodpb.CreateMembershipRequest{
  		GroupId: "<group-id>",
  	})
  	response, err := ona.Services.Group.CreateMembership(context.Background(), request)
  	if err != nil {
  		log.Fatal(err)
  	}
  	fmt.Println(response.Msg)
  }
  ```

  ```json Request body theme={null}
  {
    "groupId": "<group-id>"
  }
  ```
</CodeGroup>

## Request

`gitpod.v1.CreateMembershipRequest`

CreateMembership messages

| Field     | Type                               | Required | Description                      |
| --------- | ---------------------------------- | -------- | -------------------------------- |
| `groupId` | string                             | No       | Constraints: `string.uuid=true`. |
| `subject` | [Subject](#type-gitpod-v1-subject) | No       | Subject to add to the group      |

## Response

`gitpod.v1.CreateMembershipResponse`

| Field    | Type                                                | Required | Description |
| -------- | --------------------------------------------------- | -------- | ----------- |
| `member` | [GroupMembership](#type-gitpod-v1-group-membership) | No       |             |

## Related types

<a id="type-gitpod-v1-group-membership" />

<Accordion title="GroupMembership">
  GroupMembership represents a subject's membership in a group

  `gitpod.v1.GroupMembership`

  | Field       | Type                               | Required | Description                                                                 |
  | ----------- | ---------------------------------- | -------- | --------------------------------------------------------------------------- |
  | `id`        | string                             | No       | Unique identifier for the group membership Constraints: `string.uuid=true`. |
  | `subject`   | [Subject](#type-gitpod-v1-subject) | No       | Subject (user, runner, environment, service account, etc.)                  |
  | `groupId`   | string                             | No       | Group identifier Constraints: `string.uuid=true`.                           |
  | `name`      | string                             | No       | Subject's display name                                                      |
  | `avatarUrl` | string                             | No       | Subject's avatar URL                                                        |
</Accordion>

<a id="type-gitpod-v1-subject" />

<Accordion title="Subject">
  `gitpod.v1.Subject`

  | Field       | Type                                   | Required | Description                                                                      |
  | ----------- | -------------------------------------- | -------- | -------------------------------------------------------------------------------- |
  | `id`        | string                                 | No       | id is the UUID of the subject Constraints: `ignore=1, string.uuid=true`.         |
  | `principal` | [Principal](#enum-gitpod-v1-principal) | No       | Principal is the principal of the subject Constraints: `enum.defined_only=true`. |
</Accordion>

<a id="enum-gitpod-v1-principal" />

<Accordion title="Principal">
  | Value                       | Number | Description |
  | --------------------------- | -----: | ----------- |
  | `PRINCIPAL_UNSPECIFIED`     |      0 |             |
  | `PRINCIPAL_ACCOUNT`         |      1 |             |
  | `PRINCIPAL_USER`            |      2 |             |
  | `PRINCIPAL_RUNNER`          |      3 |             |
  | `PRINCIPAL_ENVIRONMENT`     |      4 |             |
  | `PRINCIPAL_SERVICE_ACCOUNT` |      5 |             |
  | `PRINCIPAL_RUNNER_MANAGER`  |      6 |             |
</Accordion>