---
title: "Change system admin username"
method: POST
path: "/admin/username"
tags: ["Administration"]
---

# Change system admin username

`POST /admin/username`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/admin/username`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/admin/username/post.ts> (a function with typed inputs; its response is checked against the schema)

Change system admin username.

## Request body

- object
  - `name` string, required: The user's account name. Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .). Username cannot start or end with period (.). `admin`, `system`, `administrator`, and `root` are reserved names for system admin only with case ignored.

## Response `200`

OK

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)