Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nakama Account API

Read, update, and delete the current account and link identities.

Nakama Account API is one of 11 APIs that Nakama publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, http://127.0.0.1:7350.

6 operations 4 paths 5 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
http://127.0.0.1:7350/v2
Authentication
HTTP Basic, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Nakama Account API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic auth using the server key as the username and an empty password. Guards the authenticate endpoints.
  • BearerAuth — The JWT session token returned by an authenticate call, sent as Authorization: Bearer .

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Account 6

Read, update, and delete the current account and link identities.

GET
/v2/account
Fetch the current user's account.
getAccount → 200
PUT
/v2/account
Update fields in the current user's account.
updateAccount body → 200
DELETE
/v2/account
Delete the current user's account.
deleteAccount → 200
POST
/v2/account/link/device
Add a device id to the social profiles on the current user's account.
linkDevice body → 200
POST
/v2/account/unlink/device
Remove a device id from the social profiles on the current user's account.
unlinkDevice body → 200
GET
/v2/user
Fetch zero or more users by id, username, and/or Facebook id.
getUsers 3 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are User (16 properties), Account (7 properties), UpdateAccountRequest (6 properties), AccountDevice (2 properties). Each schema is shown below with its type and property counts.

AccountDevice
object
Send a device to the server. Used with authenticate/link/unlink and register.
2 properties 1 required
Users
object
1 property
User
object
A user in the system.
16 properties
Account
object
A user's full account, including linked identities and wallet.
7 properties
UpdateAccountRequest
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nakama-account-api-openapi.yml Raw ↑

Other APIs Nakama publishes across the network.

Nakama Realtime Socket API
Nakama Console API
Nakama Authentication API
Nakama Friends API
Nakama Groups API
Nakama Leaderboards API
Nakama Notifications API
Nakama RPC API
Nakama Storage API
Nakama Tournaments API