Hellmade.HubAuth.Contracts

Shared contract package for downstream services that talk to Hub permission and directory APIs.

Why this package exists

Services, clients, and middleware need a stable shared shape for Hub auth-related payloads. This package keeps those contracts in one place so all consumers stay aligned.

What it includes

• HubAuthApiRoutes
• PermissionCheckResponse
• DirectoryUserProfileResponse
• DirectoryBatchRequest
• DirectoryBatchResponse

When to use it

Use this package when you need:

• shared route constants for Hub auth-related endpoints
• shared permission-check payload types
• shared directory/profile payload types

This package is especially useful for reusable backend clients and any shared code that must compile against the same Hub contract surface.

What it does not do

• no HTTP client logic
• no ASP.NET auth wiring
• no local authorization models
• no frontend UI/session behavior

Directory profile model

DirectoryUserProfileResponse represents Hub-owned profile metadata used by downstream services.

Fields include:

• UserId
• DisplayName
• Email
• ImageUrl
• ImageZoom
• ImageOffsetX
• ImageOffsetY
• FullName
• RawDisplayName
• Position
• AccountUrl

Example:

{
  "userId": "af44615b-222f-4000-89d6-fcef036f2990",
  "displayName": "Jane Doe",
  "email": "jane@example.com",
  "imageUrl": "https://hub.hellmadegames.com/api/v1/images/users/avatar.png",
  "imageZoom": 1.1,
  "imageOffsetX": 0,
  "imageOffsetY": 0,
  "fullName": "Jane Doe",
  "rawDisplayName": "Jane",
  "position": "Senior Product Designer",
  "accountUrl": "https://hub.hellmadegames.com/users/af44615b-222f-4000-89d6-fcef036f2990"
}

Typical consumers

• Hellmade.HubAuth.ServiceClients
• backend services that want compile-time alignment with Hub payloads

Related docs

• package overview: ../../README.md
• service clients package: ../Hellmade.HubAuth.ServiceClients/README.md