Refresh principal token

Motivation

Refreshes a valid principal token

Functional design

POST /api/v2/apps/{owner}/{app}/auth/refresh

Headers

Key	Value
Content-Type	application/json
Authorization	Bearer {PrincipalToken}

Parameters

Parameter	Type	Description
owner	string	name of a user who owns the application
app	string	name of an application

Result

Code	Description	Body
200	OK	Returns a refreshed principal token, see below
400	Bad Request	error object
401	Unauthorized	error object
403	Forbidden	error object
429	Too may requests, rate limiting	error object
500+	Server errors / service unavailable	error object

Example result 200:

{
  "principalToken": "abc.def.ghi",
  "expiresInSeconds": 3600, // seconds
  "profileWSID": 1234567890
}

Technical design

Components

• pkg/router
  • URL path handler ~cmp.routerRefreshHandler~covrd¹✅
    • sends APIPath_Auth_Refresh request to QueryProcessor;
• pkg/processors/query2
  • IApiPathHandler implementation for handling APIPath_Auth_Refresh in the AppWorkspace
    • ~cmp.authRefreshHandler~covrd²✅
      1. extracts profile WSID from token and makes federation post to refresh token:
      2. sends federation request to refresh token: ~cmp.authRefreshHandler.refreshToken~uncvrd³❓
  • newQueryProcessorPipeline: provide API handler for APIPath_Auth_Refresh
    • ~cmp.provideAuthRefreshHandler~covrd⁴✅
  • openapi:
    • add /auth/refresh to the list of API paths; ~cmp.provideAuthRefreshPath~covrd⁵✅
• pkg/sys/it
  • integration test for /refresh
    • ~it.TestRefresh~covrd⁶✅

Footnotes

1. [~server.authnz/cmp.routerRefreshHandler~impl] pkg/router/impl_apiv2.go:448:impl ↩

2. [~server.authnz/cmp.authRefreshHandler~impl] pkg/processors/query2/impl_auth_refresh_handler.go:17:impl ↩

3. [~server.authnz/cmp.authRefreshHandler.refreshToken~impl] ↩

4. [~server.authnz/cmp.provideAuthRefreshHandler~impl] pkg/processors/query2/impl.go:145:impl ↩

5. [~server.authnz/cmp.provideAuthRefreshPath~impl] pkg/processors/query2/impl_openapi.go:458:impl ↩

6. [~server.authnz/it.TestRefresh~impl] pkg/sys/it/impl_qpv2_test.go:2626:impl ↩