BFF API - SOM GUI API Specification

Endpoints

User

Overview

The User API provides access to user-related actions and permissions. It allows retrieval of available actions that a user can perform within the system.

Get User Available Actions

GET /currentUser/availableActions

• Description: Retrieves the list of actions that the authenticated user can perform.
• Authentication: Required (Bearer Token)
• Responses:
  • 200 OK: Returns an array of available user actions.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: User not found.
  • 500 Internal Server Error: Unexpected server error.

Security

Authentication

• Authentication Method: Bearer Token (JWT-based authentication)
• Scheme: HTTP Bearer

Response Codes

• 200 OK: Successful request.
• 400 Bad Request: The request contains invalid parameters.
• 401 Unauthorized: Authentication token is missing or invalid.
• 404 Not Found: The requested resource was not found.
• 500 Internal Server Error: A server-side error occurred while processing the request.

Components

Security Schemes

• bearerAuth: HTTP Bearer authentication scheme using JWT.

Headers

• X-SortDirection: Determines sorting direction.
• X-PageIndex: Specifies the page index for pagination.
• X-PageSize: Defines the number of records per page.
• X-Total: Indicates the total number of records available.

Schemas

• UserAvailableActions: Defines possible actions a user can perform, including:
  • BROWSE_AUDIT_LOG
  • BROWSE_ORDERS
  • CANCEL_ORDERS
  • BROWSE_ERRORS
  • RETRY_ERROR
  • SKIP_ERROR
  • DEPLOY_PRODUCT_CATALOGUE
  • IMPORT_PRODUCT_CATALOGUE
  • BROWSE_PRODUCT_CATALOGUE
  • FORCE_FINISH_EXECUTION_PLAN_STEP
  • RERUN_EXECUTION_PLAN_STEP
  • ASSIGN_USER_TO_ERROR
  • BROWSE_USERS
  • BROWSE_DYNAMIC_MAPPER_DOMAINS