Skip to content

Overview

Clients and tokens

A Login client acts for a user with a public client ID. An API client acts for your application with a client secret.

The client type decides which tokens your application receives and which endpoints those tokens can call.

Login clients

A Login client represents a user. It uses OpenID Connect (OIDC) with Authorization Code and Proof Key for Code Exchange (PKCE), with the S256 method. Its client ID is public, and it has no client secret. A browser app, a desktop app, or an extension can use it without a backend.

The access token of a Login client is a user-delegated token. It represents the user who authorized the client. For more information, see RemiliaNET login.

API clients

The developer portal names this client type API key. An API client represents your application, not a user. It uses the Client Credentials grant with a client secret.

The access token of an API client is an app-only token. The token has no user identity, and the flow returns no refresh token. The client secret belongs only on a server or in the operating system credential store of a personal tool.

Token kinds

The token endpoint returns these tokens:

Endpoint access

Each endpoint accepts some kinds of token. A public profile needs no token. GET /me and the account endpoints need a user-delegated token. The directory and global chat reads accept a user-delegated token or an app-only token.

An app-only token on an endpoint that acts for a user returns 403 requires_user. The scope reference lists the token kind and the scope of each endpoint.