> ## 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.

# Set Suspended

> Sets whether a user account is suspended.

`Unary` · [`Users`](https://ona.com/docs/api-reference/generated/user/overview)

Sets whether a user account is suspended.

Use this method to:

* Suspend problematic users
* Reactivate suspended accounts
* Manage user access

### Examples

* Suspend user:

  Suspends a user account.

  ```yaml theme={null}
  userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
  suspended: true
  ```

* Reactivate user:

  Removes suspension from a user account.

  ```yaml theme={null}
  userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
  suspended: false
  ```

## Endpoint

```text theme={null}
POST /api/gitpod.v1.UserService/SetSuspended
```

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

## Request example

```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.UserService/SetSuspended" \
  --header "Authorization: Bearer $ONA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "userId": "<user-id>"
}'
```

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

ona = create_client_from_env()
request = user_pb2.SetSuspendedRequest(
    user_id="<user-id>",
)
response = ona.services.user.set_suspended(request)
print(response)
```

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

async function main() {
  const ona = createClientFromEnv();
  const request = create(SetSuspendedRequestSchema, {
    userId: "<user-id>",
  });
  const response = await ona.services.user.setSuspended(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.SetSuspendedRequest{
		UserId: "<user-id>",
	})
	response, err := ona.Services.User.SetSuspended(context.Background(), request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response.Msg)
}
```

```json Request body theme={null}
{
  "userId": "<user-id>"
}
```

## Request

`gitpod.v1.SetSuspendedRequest`

| Field | Type | Required | Description |
| - | - | - | - |
| `userId` | string | No | Constraints: `string.uuid=true`. |
| `suspended` | boolean | No | |

## Response

`gitpod.v1.SetSuspendedResponse`

This message has no fields.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.