User API: Profile, API Keys, and SSH Keys - OneCLI

The user endpoints act on your own account. Use them to read and update your profile, get or rotate your workspace API key, register SSH keys for agent access, and delete your account. Your API key authenticates every other call, so treat it like any other secret. To get started with a key, see the Quickstart.

Endpoints

Endpoint	Method and path	What it does
Get your profile	`GET /user`	Get your OneCLI profile.
Update your profile	`PATCH /user`	Update your OneCLI profile details, such as your display name, so teammates see current info.
Delete your account	`DELETE /user`	Delete your OneCLI account.
Preview account deletion	`GET /user/deletion-impact`	See what deleting your account would do to each of your organizations before you commit to it.
Get your workspace API key	`GET /user/api-key`	Get your personal API key for the current workspace.
Regenerate your workspace API key	`POST /user/api-key/regenerate`	Replace your workspace API key with a new one.
List your SSH keys	`GET /user/ssh-keys`	List the SSH public keys on your account that you can use to get agent SSH certificates.
Register an SSH key	`POST /user/ssh-keys`	Add an ed25519 SSH public key to your account so you can connect to agents over SSH.
Remove an SSH key	`DELETE /user/ssh-keys/{keyId}`	Remove an SSH public key from your account so it can no longer get agent SSH certificates.

Next steps

API overview: base URLs, authentication, and pagination
Errors: status codes and the error format
Editions: which endpoints each edition serves