hiper-backend
  1. user
hiper-backend
  • API Conventions
  • user
    • before login
      • login
      • register a user
      • request verification code
      • reset email
      • reset password
    • search users
      GET
    • get the user
      GET
    • get current user
      GET
    • update current user
      PATCH
  • game
    • create
      • create a game
    • administer
      • get settings related info about the game
      • update the game's game logic
      • update the game's match detail
    • get games
      GET
  • contest
    • create
      • create a contest
    • administer
      • get settings related info about the contest
      • update the registration password
    • get contests
      GET
    • register for contest
      PUT
    • exit contest
      DELETE
  • permission
    • grant creation permission
      PUT
    • revoke creation permission
      DELETE
  • base contest
    • administer
      • delete the game
      • add admin
      • relinquish admin
      • update contest script
      • update metadata
      • add a sdk
      • get a sdk
      • delete a sdk
      • update a sdk
      • update states
    • get the game
      GET
    • get AIs
      GET
    • commit an AI
      POST
    • get the ai
      GET
    • download the AI
      GET
    • edit ai note
      PUT
    • get contestants
      GET
    • assign an AI
      PUT
    • get current contestant
      GET
    • revoke the assigned AI
      DELETE
    • get matches
      GET
    • get a match
      GET
    • get sdks
      GET
  1. user

get the user

GET
/users/{username}

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
username
string 
required
Query Params
fields
string 
optional

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/users/?fields='

Responses

🟢200OK
application/json
Body
avatar_url
string 
required
nickname
string 
required
username
string 
required
bio
string 
optional
department
string 
optional
name
string 
optional
permissions
object 
required
global
can_create_game_or_contest
boolean 
required
Default:
true
school
string 
optional
contests_registered
array[object (contest) {5}] 
required
base_contest
object (base_contest) 
optional
id
integer 
required
my_privilege
enum<string> 
required
Allowed values:
adminregisteredunregistered
metadata
object (metadata) 
required
registration
object 
optional
email
string 
required
Example
{
    "avatar_url": "string",
    "nickname": "string",
    "username": "string",
    "bio": "string",
    "department": "string",
    "name": "string",
    "permissions": {
        "can_create_game_or_contest": "true"
    },
    "school": "string",
    "contests_registered": [
        {
            "base_contest": {
                "id": 0,
                "game_id": 0,
                "states": {
                    "assign_ai_enabled": true,
                    "commit_ai_enabled": true,
                    "contest_script_environment_enabled": true,
                    "private_match_enabled": true,
                    "public_match_enabled": true,
                    "test_match_enabled": true
                }
            },
            "id": 0,
            "my_privilege": "admin",
            "metadata": {
                "cover_url": "string",
                "readme": "string",
                "title": "string"
            },
            "registration": {
                "registration_enabled": true
            }
        }
    ],
    "email": "string"
}
Previous
search users
Next
get current user
Built with