S28-3980 What's this UUID #1114

RuthKirby · 2025-07-02T13:12:09Z

JIRA ticket(s)

S28-3980

Change description

Adds Super User Admin endpoint for developer investigation

…28-3980-whats-this-uuid

# Conflicts: # infrastructure/main.tf

hmcts-jenkins-cnp · 2025-07-02T14:06:20Z

Plan Result (stg)

⚠️ Resource Deletion will happen

This plan contains resource delete operation. Please check the plan result very carefully!

Plan: 1 to add, 5 to change, 1 to destroy.

Update
- module.apim_subscription_editvm[0].azurerm_api_management_subscription.subscription
- module.apim_subscription_portal[0].azurerm_api_management_subscription.subscription
- module.apim_subscription_powerplatform[0].azurerm_api_management_subscription.subscription
- module.apim_subscription_smoketest[0].azurerm_api_management_subscription.subscription
- module.pre-api-exception-alert[0].azurerm_resource_group_template_deployment.custom_alert[0]
Replace
- module.pre_api[0].azurerm_api_management_api.api

Change Result (Click me)

  # module.apim_subscription_editvm[0].azurerm_api_management_subscription.subscription will be updated in-place
  ~ resource "azurerm_api_management_subscription" "subscription" {
      ~ allow_tracing       = false -> true
        id                  = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/subscriptions/8265f455-2bf2-4c4b-8ba3-bfd0a2f5a6b7"
        # (10 unchanged attributes hidden)
    }

  # module.apim_subscription_portal[0].azurerm_api_management_subscription.subscription will be updated in-place
  ~ resource "azurerm_api_management_subscription" "subscription" {
      ~ allow_tracing       = false -> true
        id                  = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/subscriptions/500e642d-76ef-4d82-8741-bf9e9d979705"
        # (10 unchanged attributes hidden)
    }

  # module.apim_subscription_powerplatform[0].azurerm_api_management_subscription.subscription will be updated in-place
  ~ resource "azurerm_api_management_subscription" "subscription" {
      ~ allow_tracing       = false -> true
        id                  = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/subscriptions/37f73c17-345b-4c67-81d5-50d582e97227"
        # (10 unchanged attributes hidden)
    }

  # module.apim_subscription_smoketest[0].azurerm_api_management_subscription.subscription will be updated in-place
  ~ resource "azurerm_api_management_subscription" "subscription" {
      ~ allow_tracing       = false -> true
        id                  = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/subscriptions/da1d82f9-7187-4cb6-a6dd-b0020311f3bb"
        # (10 unchanged attributes hidden)
    }

  # module.pre-api-exception-alert[0].azurerm_resource_group_template_deployment.custom_alert[0] will be updated in-place
  ~ resource "azurerm_resource_group_template_deployment" "custom_alert" {
        id                       = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/pre-stg/providers/Microsoft.Resources/deployments/PRE_API_exception"
        name                     = "PRE_API_exception"
        tags                     = {}
      ~ template_content         = jsonencode(
          ~ {
              ~ parameters     = {
                  ~ actionGroupName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ actionGroupRg            = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertDesc                = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertName                = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsQuery         = {
                      ~ type = "String" -> "string"
                    }
                  ~ commonTags               = {
                      ~ type = "String" -> "string"
                    }
                  ~ customEmailSubject       = {
                      ~ type = "String" -> "string"
                    }
                  ~ frequencyInMinutes       = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ location                 = {
                      ~ type = "String" -> "string"
                    }
                  ~ severityLevel            = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ timeWindowInMinutes      = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ triggerThreshold         = {
                      ~ type = "String" -> "string"
                    }
                  ~ triggerThresholdOperator = {
                      ~ type          = "String" -> "string"
                        # (2 unchanged attributes hidden)
                    }
                }
                # (4 unchanged attributes hidden)
            }
        )
        # (6 unchanged attributes hidden)
    }

  # module.pre_api[0].azurerm_api_management_api.api must be replaced
-/+ resource "azurerm_api_management_api" "api" {
      ~ id                    = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/apis/pre-api;rev=105" -> (known after apply)
      ~ is_current            = true -> (known after apply)
      ~ is_online             = false -> (known after apply)
        name                  = "pre-api"
      ~ revision              = "105" -> "106" # forces replacement
      + version               = (known after apply)
      + version_set_id        = (known after apply)
        # (12 unchanged attributes hidden)

      ~ subscription_key_parameter_names (known after apply)
      - subscription_key_parameter_names {
          - header = "Ocp-Apim-Subscription-Key" -> null
          - query  = "subscription-key" -> null
        }

        # (1 unchanged block hidden)
    }

Plan: 1 to add, 5 to change, 1 to destroy.

hmcts-jenkins-cnp · 2025-07-02T14:06:57Z

Plan Result (prod)

⚠️ Resource Deletion will happen

This plan contains resource delete operation. Please check the plan result very carefully!

Plan: 1 to add, 2 to change, 1 to destroy.

Update
- module.pre-api-exception-alert[0].azurerm_resource_group_template_deployment.custom_alert[0]
- module.pre-api-liveness-alert[0].azurerm_resource_group_template_deployment.custom_alert[0]
Replace
- module.pre_api[0].azurerm_api_management_api.api

Change Result (Click me)

  # module.pre-api-exception-alert[0].azurerm_resource_group_template_deployment.custom_alert[0] will be updated in-place
  ~ resource "azurerm_resource_group_template_deployment" "custom_alert" {
        id                       = "/subscriptions/5ca62022-6aa2-4cee-aaa7-e7536c8d566c/resourceGroups/pre-prod/providers/Microsoft.Resources/deployments/PRE_API_exception"
        name                     = "PRE_API_exception"
        tags                     = {}
      ~ template_content         = jsonencode(
          ~ {
              ~ parameters     = {
                  ~ actionGroupName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ actionGroupRg            = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertDesc                = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertName                = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsQuery         = {
                      ~ type = "String" -> "string"
                    }
                  ~ commonTags               = {
                      ~ type = "String" -> "string"
                    }
                  ~ customEmailSubject       = {
                      ~ type = "String" -> "string"
                    }
                  ~ frequencyInMinutes       = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ location                 = {
                      ~ type = "String" -> "string"
                    }
                  ~ severityLevel            = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ timeWindowInMinutes      = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ triggerThreshold         = {
                      ~ type = "String" -> "string"
                    }
                  ~ triggerThresholdOperator = {
                      ~ type          = "String" -> "string"
                        # (2 unchanged attributes hidden)
                    }
                }
                # (4 unchanged attributes hidden)
            }
        )
        # (6 unchanged attributes hidden)
    }

  # module.pre-api-liveness-alert[0].azurerm_resource_group_template_deployment.custom_alert[0] will be updated in-place
  ~ resource "azurerm_resource_group_template_deployment" "custom_alert" {
        id                       = "/subscriptions/5ca62022-6aa2-4cee-aaa7-e7536c8d566c/resourceGroups/pre-prod/providers/Microsoft.Resources/deployments/PRE_API_liveness"
        name                     = "PRE_API_liveness"
        tags                     = {}
      ~ template_content         = jsonencode(
          ~ {
              ~ parameters     = {
                  ~ actionGroupName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ actionGroupRg            = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertDesc                = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertName                = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsQuery         = {
                      ~ type = "String" -> "string"
                    }
                  ~ commonTags               = {
                      ~ type = "String" -> "string"
                    }
                  ~ customEmailSubject       = {
                      ~ type = "String" -> "string"
                    }
                  ~ frequencyInMinutes       = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ location                 = {
                      ~ type = "String" -> "string"
                    }
                  ~ severityLevel            = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ timeWindowInMinutes      = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ triggerThreshold         = {
                      ~ type = "String" -> "string"
                    }
                  ~ triggerThresholdOperator = {
                      ~ type          = "String" -> "string"
                        # (2 unchanged attributes hidden)
                    }
                }
                # (4 unchanged attributes hidden)
            }
        )
        # (6 unchanged attributes hidden)
    }

  # module.pre_api[0].azurerm_api_management_api.api must be replaced
-/+ resource "azurerm_api_management_api" "api" {
      ~ id                    = "/subscriptions/5ca62022-6aa2-4cee-aaa7-e7536c8d566c/resourceGroups/ss-prod-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-prod/apis/pre-api;rev=105" -> (known after apply)
      ~ is_current            = true -> (known after apply)
      ~ is_online             = false -> (known after apply)
        name                  = "pre-api"
      ~ revision              = "105" -> "106" # forces replacement
      + version               = (known after apply)
      + version_set_id        = (known after apply)
        # (12 unchanged attributes hidden)

      ~ subscription_key_parameter_names (known after apply)
      - subscription_key_parameter_names {
          - header = "Ocp-Apim-Subscription-Key" -> null
          - query  = "subscription-key" -> null
        }

        # (1 unchanged block hidden)
    }

Plan: 1 to add, 2 to change, 1 to destroy.

RuthKirby · 2025-07-04T16:14:58Z

src/main/java/uk/gov/hmcts/reform/preapi/controllers/admin/AdminController.java

+        description = "Checks if a UUID exists in any of the tables: User, Recording, CaptureSession, "
+            + "Booking, Case, Court.")
+    public ResponseEntity<String> checkUuidExists(@PathVariable UUID id) {
+        return ResponseEntity.ok("Uuid relates to a " + adminService.findUuidType(id));


We send back a pure string don't know if you want us to change to a valid json?

lydiaralphgov · 2025-07-06T15:06:08Z

src/main/java/uk/gov/hmcts/reform/preapi/services/admin/AdminService.java

+     */
+    @Getter
+    public enum UuidTableType {
+        USER,


app_access and portal_access would be useful too, as these are the X-User-Ids that sometimes pop up in e.g. the audit table

lydiaralphgov · 2025-07-07T08:00:28Z

pre-api-stg.yaml

+        - description: The User Id of the User making the request
+          format: uuid
+          in: header
+          name: X-User-Id


beware: user ID and X-User-Id are not quite the same. User ID = ID from users table. X-User-ID = ID from app_access or portal_access table. Or at least should be in theory, they do get a little bit interchanged.

lydiaralphgov · 2025-07-07T09:14:24Z

src/main/java/uk/gov/hmcts/reform/preapi/repositories/admin/AdminRepository.java

+     */
+    public Optional<String> findUuidType(UUID id) {
+        String query = """
+            (SELECT 'user' AS table_name FROM users WHERE id = ?


We might need to optimise this if it gets slow, but we can do that at a later date

lydiaralphgov · 2025-07-07T16:51:59Z

Ticket on hold - to review later

RuthKirby added 4 commits July 2, 2025 12:56

creates admin endpoint

4febcea

adds unit tests for admin endpoint

002a7f6

adds integration test tests for admin service

bc3eeaf

fix readme contents list

93b9855

RuthKirby requested a review from a team as a code owner July 2, 2025 13:12

pre-devops and others added 4 commits July 2, 2025 13:14

Update Swagger v2 Spec Bump APIm revision to 106

d889a74

checkstyle fixes

33c8fe1

Merge remote-tracking branch 'origin/S28-3980-whats-this-uuid' into S…

4cac144

…28-3980-whats-this-uuid

Merge branch 'master' into S28-3980-whats-this-uuid

68ea121

# Conflicts: # infrastructure/main.tf

RuthKirby changed the title ~~S28-3980 whats this UUID~~ S28-3980 What's this UUID Jul 2, 2025

Bump APIm revision to 106

de93c53

hmcts-jenkins-cnp bot deployed to preview July 2, 2025 14:03 View deployment

hmcts-jenkins-cnp bot added ns:pre prd:pre rel:pre-api-pr-1114 stg/destroy labels Jul 2, 2025

hmcts-jenkins-cnp bot added the prod/destroy label Jul 2, 2025

hmcts-jenkins-cnp bot deployed to preview July 2, 2025 14:07 View deployment

a-sealey-justice-gov added 3 commits July 4, 2025 17:09

Adds tests, comments and checkstyle fixes

fd6a3d4

Adds tests, comments and checkstyle fixes

c5f6f0d

Merge branch 'master' into S28-3980-whats-this-uuid

c62f209

RuthKirby commented Jul 4, 2025

View reviewed changes

pre-devops and others added 2 commits July 4, 2025 16:15

Bump APIm revision to 107

6772af9

checkstyle fixes

437faf9

lydiaralphgov reviewed Jul 6, 2025

View reviewed changes

lydiaralphgov reviewed Jul 7, 2025

View reviewed changes

lydiaralphgov marked this pull request as draft July 7, 2025 16:51

lydiaralphgov added the DO-NOT-MERGE label Jul 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

S28-3980 What's this UUID #1114

S28-3980 What's this UUID #1114

Uh oh!

RuthKirby commented Jul 2, 2025 •

edited by a-sealey-justice-gov

Loading

Uh oh!

hmcts-jenkins-cnp bot commented Jul 2, 2025

Uh oh!

hmcts-jenkins-cnp bot commented Jul 2, 2025

Uh oh!

RuthKirby Jul 4, 2025

Uh oh!

lydiaralphgov Jul 6, 2025

Uh oh!

lydiaralphgov Jul 7, 2025

Uh oh!

lydiaralphgov Jul 7, 2025

Uh oh!

lydiaralphgov commented Jul 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

S28-3980 What's this UUID #1114

Are you sure you want to change the base?

S28-3980 What's this UUID #1114

Uh oh!

Conversation

RuthKirby commented Jul 2, 2025 • edited by a-sealey-justice-gov Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

JIRA ticket(s)

Change description

Uh oh!

hmcts-jenkins-cnp bot commented Jul 2, 2025

Plan Result (stg)

⚠️ Resource Deletion will happen

Uh oh!

hmcts-jenkins-cnp bot commented Jul 2, 2025

Plan Result (prod)

⚠️ Resource Deletion will happen

Uh oh!

RuthKirby Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

lydiaralphgov Jul 6, 2025

Choose a reason for hiding this comment

Uh oh!

lydiaralphgov Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

lydiaralphgov Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

lydiaralphgov commented Jul 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

RuthKirby commented Jul 2, 2025 •

edited by a-sealey-justice-gov

Loading