HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/users/{User.name}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Reference Resource: User
Name of the user.

Body Params
authorized_keys
object

Public keys for public key authentication of a user.

string
length ≤ 192

The plaintext password of the user, required for password updates when password complexity is enabled.

boolean

Disables a built-in user. Users that are not built-in should be deleted instead of using this column.

string
length ≤ 192

Encrypted password of the user. Management interfaces like REST or CLI may accept the plaintext value for this field when writing configurations but it is ultimately stored and read as a ciphertext. If not set, it indicates that the user is created with an empty password.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!