Issue Principal Token (Login)

Motivation

Issue (create) a new principal token in exchange for valid credentials.

Functional Design

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

Headers

Key	Value
Content-Type	application/json

Parameters

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

Body

JSON object:

{
  "login": "login",
  "password": "password"
}

Result

Code	Description	Body
200	OK	Returns an access token, see below
400	Bad Request	error object
401	Unauthorized	error object
409	the profile workspace is not yet ready, repeat the request	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.routerLoginPathHandler~covrd¹✅:
    • reads Login and Password from the Body;
    • sends APIPath_Auth_Login request to QueryProcessor;
• pkg/processors/query2
  • IApiPathHandler implementation for handling APIPath_Auth_Login
    • ~cmp.authLoginHandler~covrd²✅
      1. using login from the argument, generates pseudo-WSID
      2. makes federation post to registry to issue a token
  • newQueryProcessorPipeline: provide API handler for APIPath_Auth_Login
    • ~cmp.provideAuthLoginHandler~covrd³✅
  • openapi:
    • add /auth/login to the list of API paths; ~cmp.provideAuthLoginPath~covrd⁴✅
    • add PrincipalToken component schema; ~cmp.principalTokenSchema~covrd⁵✅
• pkg/sys/it
  • integration test for /login
    • ~it.TestLogin~covrd⁶✅

Footnotes

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

2. [~server.authnz/cmp.authLoginHandler~impl] pkg/processors/query2/impl_auth_login_handler.go:20:impl ↩

3. [~server.authnz/cmp.provideAuthLoginHandler~impl] pkg/processors/query2/impl.go:142:impl ↩

4. [~server.authnz/cmp.provideAuthLoginPath~impl] pkg/processors/query2/impl_openapi.go:419:impl ↩

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

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