Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Get a player's profile, keys and VPN assignment

GET/api/admin/players/{id}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
idstringrequired
min length 1
Responses
200

Success

profileobjectrequired
Show properties
idstringrequired
namestringrequired
usernamestringrequired
emailstringrequired
createdAtstring<date-time>required
bannedbooleanrequired
banReasonstring | nullrequired
Show properties
Any of:
string
string
null
null
banExpiresstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
discordUserIdstring | nullrequired
Show properties
Any of:
string
string
null
null
discordLinkedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
teamobject | nullrequired
Show properties
Any of:
object
idstringrequired
namestring | nullrequired
Show properties
Any of:
string
string
null
null
handlestring | nullrequired
Show properties
Any of:
string
string
null
null
numbernumber | nullrequired
Show properties
Any of:
number
number
null
null
rolestring | nullrequired
Show properties
Any of:
string
string
string
string
null
null
joinedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
null
null
sshKeysobject[]required
Show properties
Array of object
idstringrequired
fingerprintstringrequired
labelstringrequired
createdAtstring<date-time>required
revokedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
vpnPeerobject | nullrequired
Show properties
Any of:
object
addressstringrequired
createdAtstring<date-time>required
rotatedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
revokedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
null
null
certificatesobject[]required
Show properties
Array of object
idstringrequired
tierLabelstringrequired
issuedAtstring<date-time>required
revokedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
401

Unauthorized

errorstringrequired
404

Response for status 404

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET '/api/admin/players/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "profile": {
    "id": "string",
    "name": "string",
    "username": "string",
    "email": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "banned": true,
    "banReason": "string",
    "banExpires": "2019-08-24T14:15:22Z",
    "discordUserId": "string",
    "discordLinkedAt": "2019-08-24T14:15:22Z",
    "team": {
      "id": "string",
      "name": "string",
      "handle": "string",
      "number": 0,
      "role": "member",
      "joinedAt": "2019-08-24T14:15:22Z"
    }
  },
  "sshKeys": [
    {
      "id": "string",
      "fingerprint": "string",
      "label": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "revokedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "vpnPeer": {
    "address": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "rotatedAt": "2019-08-24T14:15:22Z",
    "revokedAt": "2019-08-24T14:15:22Z"
  },
  "certificates": [
    {
      "id": "string",
      "tierLabel": "string",
      "issuedAt": "2019-08-24T14:15:22Z",
      "revokedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Was this page helpful?