Appearance
Verify username can be registered
About 171 wordsLess than 1 minute
apiUsersRegister
2025-05-19
MethodPOST
Request URL
/plugin/datafor-auth/api/user/isRightUsernameForAddAuthorization
Authentication is not required to use this API.
Content Typeapplication/x-www-form-urlencoded
Description
This API checks whether a given username can be used for registration. The verification is case-insensitive, meaning uppercase and lowercase variations of the same username are treated identically.
Request Example
username: adminRequest Schema
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
username | body | string | Yes | The username to be verified (case-insensitive). |
Response Examples
Successful Response (HTTP 200)
{
"success": true
}Failure Response (Example)
{
"msg": "Username already exists",
"success": false
}HTTP Responses
| HTTP Status Code | Meaning | Description | Data Schema |
|---|---|---|---|
| 200 | OK | Request was successful | Inline |
Response Data Schema (HTTP 200)
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | Indicates whether the username is available for registration. |
msg | string | No | Response message (only present when the username cannot be used). |