[Issue 2673] Users token stub endpoint

api/openapi.generated.yml

@@ -43,6 +43,27 @@ paths:
       tags:
       - Health
       summary: Health
+  /v1/user/token:
+    post:
+      parameters: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OpportunityUserTokenResponseV1'
+          description: Successful response
+        '401':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          description: Authentication error
+      tags:
+      - Opportunity v1
+      summary: User Token
+      security:
+      - ApiKeyAuth: []
   /v1/opportunities/search:
     post:
       parameters: []
@@ -350,6 +371,45 @@ components:
           type: string
           description: An internal tracking ID
           example: 550e8400-e29b-41d4-a716-446655440000
+    UserV1:
+      type: object
+      properties:
+        user_id:
+          type: string
+          description: The internal ID of a user
+          example: 861a0148-cf2c-432b-b0b3-690016299ab1
+        email:
+          type: string
+          description: The email address returned from Oauth2 provider
+          example: [email protected]
+        external_user_type:
+          type: string
+          description: The Oauth2 provider through which a user was authenticated
+          example: login_gov
+    OpportunityUserTokenResponseV1:
+      type: object
+      properties:
+        message:
+          type: string
+          description: The message to return
+          example: Success
+        data:
+          description: The REST resource object
+        status_code:
+          type: integer
+          description: The HTTP status code
+          example: 200
+        token:
+          type: string
+          description: Internal token generated for a user
+        user:
+          type:
+          - object
+          allOf:
+          - $ref: '#/components/schemas/UserV1'
+        is_user_new:
+          type: boolean
+          description: Whether or not the user existed in our database
     FundingInstrumentFilterV1:
       type: object
       properties:

api/src/api/opportunities_v1/opportunity_routes.py

@@ -1,7 +1,7 @@
 import io
 import logging
 
-from flask import Response
+from flask import Response, request
 
 import src.adapters.db as db
 import src.adapters.db.flask_db as flask_db
@@ -212,3 +212,28 @@ def opportunity_versions_get(db_session: db.Session, opportunity_id: int) -> res
         data = get_opportunity_versions(db_session, opportunity_id)
 
     return response.ApiResponse(message="Success", data=data)
+
+
+@opportunity_blueprint.post("/user/token")
+@opportunity_blueprint.output(opportunity_schemas.OpportunityUserTokenResponseV1Schema)
+@opportunity_blueprint.auth_required(api_key_auth)
+def user_token() -> response.ApiResponse | Response:
+    logger.info("POST /v1/user/token")
+
+    header_token = request.headers.get("X-OAuth-login-gov")
+    if header_token:
+        data = {
+            "token": "the token goes here!",
+            "user": {
+                "user_id": "abc-...",
+                "email": "[email protected]",
+                "external_user_type": "login_gov",
+            },
+            "is_user_new": True,
+        }
+        return response.ApiResponse(message="Success", data=data)
+
+    message = "Missing X-OAuth-login-gov header"
+    logger.error(message)
+
+    return response.ApiResponse(message=message, status_code=400)

api/src/api/opportunities_v1/opportunity_schemas.py

@@ -535,3 +535,39 @@ class OpportunitySearchResponseV1Schema(AbstractResponseSchema, PaginationMixinS
         OpportunityFacetV1Schema(),
         metadata={"description": "Counts of filter/facet values in the full response"},
     )
+
+
+class UserV1Schema(Schema):
+    user_id = fields.String(
+        metadata={
+            "description": "The internal ID of a user",
+            "example": "861a0148-cf2c-432b-b0b3-690016299ab1",
+        }
+    )
+    email = fields.String(
+        metadata={
+            "description": "The email address returned from Oauth2 provider",
+            "example": "[email protected]",
+        }
+    )
+    external_user_type = fields.String(
+        metadata={
+            "description": "The Oauth2 provider through which a user was authenticated",
+            "example": "login_gov",
+        }
+    )
+
+
+class OpportunityUserTokenResponseV1Schema(AbstractResponseSchema):
+    token = fields.String(
+        metadata={
+            "description": "Internal token generated for a user",
+        }
+    )
+    user = fields.Nested(UserV1Schema())
+    is_user_new = fields.Boolean(
+        allow_none=False,
+        metadata={
+            "description": "Whether or not the user existed in our database",
+        },
+    )