Add requireReason (bool) to GET /webapi/sites/:site/context (#49413)

gravitational · Nov 27, 2024 · e5db273 · e5db273
1 parent 2b7e492
commit e5db273
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 1 deletion.
diff --git a/lib/web/apiserver.go b/lib/web/apiserver.go
@@ -1236,6 +1236,7 @@ func (h *Handler) getUserContext(w http.ResponseWriter, r *http.Request, p httpr
 	userContext.AccessCapabilities = ui.AccessCapabilities{
 		RequestableRoles:   res.RequestableRoles,
 		SuggestedReviewers: res.SuggestedReviewers,
+		RequireReason:      res.RequireReason,
 	}
 
 	userContext.AllowedSearchAsRoles = accessChecker.GetAllowedSearchAsRoles()

diff --git a/lib/web/ui/usercontext.go b/lib/web/ui/usercontext.go
@@ -39,6 +39,9 @@ type AccessCapabilities struct {
 	RequestableRoles []string `json:"requestableRoles"`
 	// SuggestedReviewers is a list of reviewers that the user can select when creating a request.
 	SuggestedReviewers []string `json:"suggestedReviewers"`
+	// RequireReason indicates whether the reason is required for the user to create an Access
+	// Request.
+	RequireReason bool `json:"requireReason"`
 }
 
 type authType string

diff --git a/web/packages/teleport/src/services/user/makeUserContext.ts b/web/packages/teleport/src/services/user/makeUserContext.ts
@@ -54,6 +54,7 @@ function makeAccessCapabilities(json): AccessCapabilities {
   return {
     requestableRoles: json.requestableRoles || [],
     suggestedReviewers: json.suggestedReviewers || [],
+    requireReason: json.requireReason || false,
   };
 }
 

diff --git a/web/packages/teleport/src/services/user/types.ts b/web/packages/teleport/src/services/user/types.ts
@@ -28,6 +28,7 @@ export interface AccessStrategy {
 export interface AccessCapabilities {
   requestableRoles: string[];
   suggestedReviewers: string[];
+  requireReason: boolean;
 }
 
 export interface UserContext {

diff --git a/web/packages/teleport/src/services/user/user.test.ts b/web/packages/teleport/src/services/user/user.test.ts
@@ -300,7 +300,11 @@ test('undefined values in context response gives proper default values', async (
     // Test undefined access strategy is set to default optional.
     accessStrategy: { type: 'optional', prompt: '' },
     // Test undefined roles and reviewers are set to empty arrays.
-    accessCapabilities: { requestableRoles: [], suggestedReviewers: [] },
+    accessCapabilities: {
+      requestableRoles: [],
+      suggestedReviewers: [],
+      requireReason: false,
+    },
     allowedSearchAsRoles: [],
     passwordState: PasswordState.PASSWORD_STATE_UNSPECIFIED,
   });