## ShareResourceWithPrincipal

`groups.shares.create(ShareCreateParams**kwargs)  -> object`

**post** `/gitpod.v1.GroupService/ShareResourceWithPrincipal`

Shares a resource directly with a principal (user or service account).

Use this method to:

- Grant a user or service account direct access to a runner, project, or other resource
- Share resources without creating and managing groups manually

### Examples

- Share a runner with a user:

  Grants admin access to a runner for a specific user.

  ```yaml
  resourceType: RESOURCE_TYPE_RUNNER
  resourceId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  principal: PRINCIPAL_USER
  principalId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
  role: RESOURCE_ROLE_RUNNER_ADMIN
  ```

- Share a runner with a service account:

  Grants user access to a runner for a service account.

  ```yaml
  resourceType: RESOURCE_TYPE_RUNNER
  resourceId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  principal: PRINCIPAL_SERVICE_ACCOUNT
  principalId: "a1b2c3d4-5678-90ab-cdef-1234567890ab"
  role: RESOURCE_ROLE_RUNNER_USER
  ```

### Authorization

Requires admin role on the specific resource.

### Parameters

- `principal: Optional[Principal]`

  Type of principal to share with (user or service account)

  - `"PRINCIPAL_UNSPECIFIED"`

  - `"PRINCIPAL_ACCOUNT"`

  - `"PRINCIPAL_USER"`

  - `"PRINCIPAL_RUNNER"`

  - `"PRINCIPAL_ENVIRONMENT"`

  - `"PRINCIPAL_SERVICE_ACCOUNT"`

  - `"PRINCIPAL_RUNNER_MANAGER"`

- `principal_id: Optional[str]`

  ID of the principal (user or service account) to share with

- `resource_id: Optional[str]`

  ID of the resource to share

- `resource_type: Optional[ResourceType]`

  Type of resource to share (runner, project, etc.)

  - `"RESOURCE_TYPE_UNSPECIFIED"`

  - `"RESOURCE_TYPE_ENVIRONMENT"`

  - `"RESOURCE_TYPE_RUNNER"`

  - `"RESOURCE_TYPE_PROJECT"`

  - `"RESOURCE_TYPE_TASK"`

  - `"RESOURCE_TYPE_TASK_EXECUTION"`

  - `"RESOURCE_TYPE_SERVICE"`

  - `"RESOURCE_TYPE_ORGANIZATION"`

  - `"RESOURCE_TYPE_USER"`

  - `"RESOURCE_TYPE_ENVIRONMENT_CLASS"`

  - `"RESOURCE_TYPE_RUNNER_SCM_INTEGRATION"`

  - `"RESOURCE_TYPE_HOST_AUTHENTICATION_TOKEN"`

  - `"RESOURCE_TYPE_GROUP"`

  - `"RESOURCE_TYPE_PERSONAL_ACCESS_TOKEN"`

  - `"RESOURCE_TYPE_USER_PREFERENCE"`

  - `"RESOURCE_TYPE_SERVICE_ACCOUNT"`

  - `"RESOURCE_TYPE_SECRET"`

  - `"RESOURCE_TYPE_SSO_CONFIG"`

  - `"RESOURCE_TYPE_DOMAIN_VERIFICATION"`

  - `"RESOURCE_TYPE_AGENT_EXECUTION"`

  - `"RESOURCE_TYPE_RUNNER_LLM_INTEGRATION"`

  - `"RESOURCE_TYPE_AGENT"`

  - `"RESOURCE_TYPE_ENVIRONMENT_SESSION"`

  - `"RESOURCE_TYPE_USER_SECRET"`

  - `"RESOURCE_TYPE_ORGANIZATION_POLICY"`

  - `"RESOURCE_TYPE_ORGANIZATION_SECRET"`

  - `"RESOURCE_TYPE_PROJECT_ENVIRONMENT_CLASS"`

  - `"RESOURCE_TYPE_BILLING"`

  - `"RESOURCE_TYPE_PROMPT"`

  - `"RESOURCE_TYPE_COUPON"`

  - `"RESOURCE_TYPE_COUPON_REDEMPTION"`

  - `"RESOURCE_TYPE_ACCOUNT"`

  - `"RESOURCE_TYPE_INTEGRATION"`

  - `"RESOURCE_TYPE_WORKFLOW"`

  - `"RESOURCE_TYPE_WORKFLOW_EXECUTION"`

  - `"RESOURCE_TYPE_WORKFLOW_EXECUTION_ACTION"`

  - `"RESOURCE_TYPE_SNAPSHOT"`

  - `"RESOURCE_TYPE_PREBUILD"`

  - `"RESOURCE_TYPE_ORGANIZATION_LLM_INTEGRATION"`

  - `"RESOURCE_TYPE_CUSTOM_DOMAIN"`

  - `"RESOURCE_TYPE_ROLE_ASSIGNMENT_CHANGED"`

  - `"RESOURCE_TYPE_GROUP_MEMBERSHIP_CHANGED"`

  - `"RESOURCE_TYPE_WEBHOOK"`

  - `"RESOURCE_TYPE_SCIM_CONFIGURATION"`

  - `"RESOURCE_TYPE_SERVICE_ACCOUNT_SECRET"`

  - `"RESOURCE_TYPE_ANNOUNCEMENT_BANNER"`

  - `"RESOURCE_TYPE_SERVICE_ACCOUNT_TOKEN"`

  - `"RESOURCE_TYPE_ROLE_ASSIGNMENT"`

  - `"RESOURCE_TYPE_WARM_POOL"`

  - `"RESOURCE_TYPE_NOTIFICATION"`

- `role: Optional[ResourceRole]`

  Role to grant the principal on the resource

  - `"RESOURCE_ROLE_UNSPECIFIED"`

  - `"RESOURCE_ROLE_ORG_ADMIN"`

  - `"RESOURCE_ROLE_ORG_MEMBER"`

  - `"RESOURCE_ROLE_ORG_RUNNERS_ADMIN"`

  - `"RESOURCE_ROLE_ORG_PROJECTS_ADMIN"`

  - `"RESOURCE_ROLE_ORG_AUTOMATIONS_ADMIN"`

  - `"RESOURCE_ROLE_ORG_GROUPS_ADMIN"`

  - `"RESOURCE_ROLE_ORG_AUDIT_LOG_READER"`

  - `"RESOURCE_ROLE_GROUP_ADMIN"`

  - `"RESOURCE_ROLE_GROUP_VIEWER"`

  - `"RESOURCE_ROLE_USER_IDENTITY"`

  - `"RESOURCE_ROLE_USER_VIEWER"`

  - `"RESOURCE_ROLE_USER_ADMIN"`

  - `"RESOURCE_ROLE_ENVIRONMENT_IDENTITY"`

  - `"RESOURCE_ROLE_ENVIRONMENT_ADMIN"`

  - `"RESOURCE_ROLE_ENVIRONMENT_USER"`

  - `"RESOURCE_ROLE_ENVIRONMENT_VIEWER"`

  - `"RESOURCE_ROLE_ENVIRONMENT_RUNNER"`

  - `"RESOURCE_ROLE_RUNNER_IDENTITY"`

  - `"RESOURCE_ROLE_RUNNER_ADMIN"`

  - `"RESOURCE_ROLE_RUNNER_LOCAL_ADMIN"`

  - `"RESOURCE_ROLE_RUNNER_MANAGED_ADMIN"`

  - `"RESOURCE_ROLE_RUNNER_USER"`

  - `"RESOURCE_ROLE_RUNNER_CONFIGURATION_READER"`

  - `"RESOURCE_ROLE_HOST_AUTHENTICATION_TOKEN_ADMIN"`

  - `"RESOURCE_ROLE_HOST_AUTHENTICATION_TOKEN_UPDATER"`

  - `"RESOURCE_ROLE_PROJECT_ADMIN"`

  - `"RESOURCE_ROLE_PROJECT_USER"`

  - `"RESOURCE_ROLE_PROJECT_EDITOR"`

  - `"RESOURCE_ROLE_ENVIRONMENT_SERVICE_ADMIN"`

  - `"RESOURCE_ROLE_ENVIRONMENT_SERVICE_VIEWER"`

  - `"RESOURCE_ROLE_ENVIRONMENT_SERVICE_USER"`

  - `"RESOURCE_ROLE_ENVIRONMENT_SERVICE_ENV"`

  - `"RESOURCE_ROLE_ENVIRONMENT_TASK_ADMIN"`

  - `"RESOURCE_ROLE_ENVIRONMENT_TASK_VIEWER"`

  - `"RESOURCE_ROLE_ENVIRONMENT_TASK_USER"`

  - `"RESOURCE_ROLE_ENVIRONMENT_TASK_ENV"`

  - `"RESOURCE_ROLE_SERVICE_ACCOUNT_IDENTITY"`

  - `"RESOURCE_ROLE_SERVICE_ACCOUNT_ADMIN"`

  - `"RESOURCE_ROLE_AGENT_EXECUTION_USER"`

  - `"RESOURCE_ROLE_AGENT_EXECUTION_ADMIN"`

  - `"RESOURCE_ROLE_AGENT_EXECUTION_RUNNER"`

  - `"RESOURCE_ROLE_AGENT_EXECUTION_OUTPUTS_REPORTER"`

  - `"RESOURCE_ROLE_AGENT_EXECUTION_VIEWER"`

  - `"RESOURCE_ROLE_AGENT_ADMIN"`

  - `"RESOURCE_ROLE_AGENT_VIEWER"`

  - `"RESOURCE_ROLE_AGENT_EXECUTOR"`

  - `"RESOURCE_ROLE_WORKFLOW_ADMIN"`

  - `"RESOURCE_ROLE_WORKFLOW_USER"`

  - `"RESOURCE_ROLE_WORKFLOW_VIEWER"`

  - `"RESOURCE_ROLE_WORKFLOW_EXECUTOR"`

  - `"RESOURCE_ROLE_SNAPSHOT_ADMIN"`

  - `"RESOURCE_ROLE_SNAPSHOT_RUNNER"`

  - `"RESOURCE_ROLE_WEBHOOK_ADMIN"`

  - `"RESOURCE_ROLE_WEBHOOK_VIEWER"`

  - `"RESOURCE_ROLE_WARMPOOL_RUNNER"`

  - `"RESOURCE_ROLE_WARMPOOL_ADMIN"`

  - `"RESOURCE_ROLE_WARMPOOL_VIEWER"`

  - `"RESOURCE_ROLE_SESSION_ADMIN"`

  - `"RESOURCE_ROLE_SESSION_USER"`

  - `"RESOURCE_ROLE_TEAM_ADMIN"`

  - `"RESOURCE_ROLE_TEAM_VIEWER"`

### Returns

- `object`

### Example

```python
import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
share = client.groups.shares.create(
    principal="PRINCIPAL_SERVICE_ACCOUNT",
    principal_id="a1b2c3d4-5678-90ab-cdef-1234567890ab",
    resource_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
    resource_type="RESOURCE_TYPE_RUNNER",
    role="RESOURCE_ROLE_RUNNER_USER",
)
print(share)
```

#### Response

```json
{}
```