439e60273a2e

latestOpenAPI 3.0.02026-08-113221853.1 MB

Gates

Delete a Single Gate User ID Override

Removes a single user ID from the matching pass/fail userID override bucket on the gate. Idempotent: returns 200 even when the user ID is not currently overridden. Only clears the all-environments userID bucket; environment-scoped and custom-ID overrides are left untouched. The response body carries the full override set for the gate after the delete.

delete/console/v1/gates/{id}/overrides/userID/{userID}

Path parameters

idstring required

Gate name

userIDstring required

User ID to remove from the override

Query parameters

groupID'pass' | 'fail' required

Example:pass

Whether the user ID was overridden to pass or fail the gate.

Response

Delete Single Gate User ID Override Success

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Gate Overrides updated successfully.",
  "data": {
    "passingUserIDs": [
      "user_a"
    ],
    "failingUserIDs": [
      "user_c"
    ],
    "environmentOverrides": [
      {
        "environment": null,
        "unitID": "userID",
        "passingIDs": [
          "user_a"
        ],
        "failingIDs": [
          "user_c"
        ]
      },
      {
        "environment": "staging",
        "unitID": "userID",
        "passingIDs": [
          "user_b"
        ],
        "failingIDs": []
      },
      {
        "environment": null,
        "unitID": "stableID",
        "passingIDs": [
          "stable_a"
        ],
        "failingIDs": []
      }
    ]
  }
}