Skip to main content

Create group verification request

POST 
/groups-srv/verifications/requests

This API call creates a reusable group verification request that can be used later to verify user access. Verification requests are useful for defining access control rules that can be referenced by ID.

Purpose:

  • Create reusable access control rules that can be referenced by ID
  • Define complex verification criteria once and reuse across multiple verification calls
  • Centralize access control logic for easier management and updates

Request Structure:

  • name: Required, a descriptive name for the verification request
  • description: Optional, detailed description of what this verification request checks
  • matchCondition: Required, determines how multiple filters are combined ("and" or "or")
  • filters: Required array, must contain at least one filter with groupId, groupType, and/or roleFilter

Validation Rules:

  • name: Required, cannot be empty
  • matchCondition: Required, must be either "and" or "or"
  • filters: Required, must be a non-empty array
  • Each filter must specify at least one of: groupId or groupType
  • If groupId is specified, the group must exist
  • If groupType is specified, the group type must exist
  • If roleFilter is provided, it must have valid matchCondition and roles array

Business Rules:

  • Verification requests are stored and can be referenced by their unique ID
  • Use the verification request ID with the GET /groups-srv/verifications/{verificationId} endpoint to verify user access
  • Verification requests can be updated or deleted as needed
  • Changes to verification requests affect all future verifications using that request ID

Request​

Responses​

OK - Verification request updated (if ID already exists)