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 Authentication API

Authenticate users and issue or refresh session tokens.

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

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

This API exposes 4 operations across 4 paths, and defines 8 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.

4 operations 4 paths 8 schemas 4 POST

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 Authentication 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 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 4

Authenticate users and issue or refresh session tokens.

POST
/v2/account/authenticate/device
Authenticate a user with a device id against the server.
authenticateDevice 2 params body → 200
POST
/v2/account/authenticate/email
Authenticate a user with an email and password against the server.
authenticateEmail 2 params body → 200
POST
/v2/account/authenticate/custom
Authenticate a user with a custom id against the server.
authenticateCustom 2 params body → 200
POST
/v2/account/session/refresh
Refresh a user's session using a refresh token retrieved from a previous authentication request.
sessionRefresh body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Session (3 properties), AuthenticateEmailRequest (3 properties), AccountEmail (3 properties), AuthenticateDeviceRequest (3 properties). Each schema is shown below with its type and property counts.

AuthenticateDeviceRequest
object
3 properties
AccountCustom
object
Send a custom id to the server.
2 properties 1 required
SessionRefreshRequest
object
2 properties
AccountDevice
object
Send a device to the server. Used with authenticate/link/unlink and register.
2 properties 1 required
AuthenticateEmailRequest
object
3 properties
Session
object
A user's session used to authenticate messages.
3 properties
AuthenticateCustomRequest
object
3 properties
AccountEmail
object
Send an email with password to the server.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nakama-authentication-api-openapi.yml Raw ↑

Other APIs Nakama publishes across the network.

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