Skip to main content
Version: 2.0.0

Eurofurence Identity

API v2 endpoints for the Eurofurence Identity service.

Response format

All v2 endpoints return JSON at the top level. List endpoints return a bare JSON array (no data/links/meta envelope). Single resources return a bare object.

Pagination

List endpoints are paginated. Pagination metadata is returned via HTTP response headers, following the GitHub REST API convention (RFC 5988):

HeaderDescription
LinkRelational URLs for prev, next, and (when available) first / last pages.
X-Per-PageNumber of items per page.
X-Current-PageThe current page number.
X-Total-CountTotal number of items (only present on endpoints that compute a total).
X-Total-PagesTotal number of pages (only present on endpoints that compute a total).

Clients should follow Link: ...; rel="next" until it is absent rather than computing page numbers themselves. Most list endpoints use cursor-style pagination without a total count (for performance) — X-Total-Count will not be present on those.

Supported query parameters: page (page number, 1-based) and, where noted, per_page.

OAuth2 Scopes

Identity

  • openid: Basic OpenID Connect functionality
  • profile: User's display name and avatar
  • email: User's email address and verification status
  • offline / offline_access: Refresh tokens

Staff

  • staff.my.read: Access to the authenticated user's own staff profile (firstname, lastname, phone, etc.)
  • staff.all.read: Access to all staff members' profiles (respects per-user visibility settings)

Groups

  • groups: User's group memberships (returned in userinfo)
  • groups.read: Read group details via the API
  • groups.write: Create/update groups and manage members
  • groups.delete: Delete groups

Other

  • view_full_staff_details: Access email addresses in group/user listings
  • metadata.read: Read per-app user metadata
  • metadata.write: Write per-app user metadata
  • notifications.send: Send notifications to users via the notification service (client credentials only)

Authentication

OpenID Connect

Security Scheme Type:

openIdConnect

OpenID Connect URL:

https://identity.eurofurence.org/.well-known/openid-configuration

Contact

Thiritin: me@thiritin.com