Administrative Mitgliedschaftsaktion ausführen

{
  "operationId": "put_v2_usermembership_id",
  "summary": "Administrative Mitgliedschaftsaktion ausführen",
  "description": "Führt data.action cancel, renewal, adjust-validity, credit-uses oder payment-link aus. Ohne unterstützte action folgt request_method_not_supported. Pflichtfelder je Aktion entsprechen den benannten Unterrouten; keine allgemeine Feldaktualisierung. Versionierte Änderungen verlangen den zuletzt gelesenen Stand, neue Kaufzuweisung erfolgt per POST. payment-link liefert statt Mitgliedschaft ein Linkobjekt.",
  "tags": [
    "usermembership"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "v2 object identifier in the selected account.",
      "schema": {
        "type": "string",
        "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
        "examples": [
          "usermembership_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "data enthält das dokumentierte Ergebnis; error=false und success=true. Listen liefern zusätzlich total (Gesamtzahl vor Pagination).",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "usermembership_012345abcdef_123456",
              "version": 1,
              "user": "user_012345abcdef_123456",
              "user_information": {
                "name": "",
                "email": ""
              },
              "plan": "membershipplan_012345abcdef_123456",
              "plan_version": 1,
              "name": "Jahresmitgliedschaft",
              "status": "active",
              "active": true,
              "valid_from": 1790000000,
              "valid_until": 1821536000,
              "granted_uses": null,
              "remaining_uses": null,
              "membership_promo_code": null,
              "source": "admin_purchase",
              "renewal": {
                "auto_renew": false,
                "cancel_at_period_end": false,
                "cancel_requested_at": null,
                "cancel_effective_at": null,
                "next_renewal_at": null
              },
              "current_period": "membershipperiod_012345abcdef_123456",
              "created_at": 1790000000,
              "updated_at": 1790000000,
              "plan_snapshot": {
                "name": "Jahresmitgliedschaft",
                "validity": {
                  "type": "relative_duration",
                  "from": null,
                  "until": null,
                  "value": 1,
                  "unit": "year",
                  "uses": null,
                  "promo_code_redemption": false
                },
                "discount": {
                  "type": "percent",
                  "value": "10.00",
                  "currency": null
                },
                "sale": {
                  "amount": "120.00",
                  "currency": "CHF",
                  "vat": null
                }
              },
              "periods": [
                {
                  "id": "membershipperiod_012345abcdef_123456",
                  "membership": "usermembership_012345abcdef_123456",
                  "type": "initial",
                  "period_start": 1790000000,
                  "period_end": 1821536000,
                  "payment_status": "free",
                  "amounts": {
                    "gross": "0.00",
                    "net": "0.00",
                    "tax": "0.00",
                    "currency": "CHF"
                  },
                  "vat": {
                    "id": null,
                    "rate": "0.0000",
                    "label": ""
                  },
                  "title": "Jahresmitgliedschaft",
                  "plan_version": 1,
                  "design": null,
                  "transaction": null,
                  "invoice": null,
                  "invoice_number": null,
                  "payment": null,
                  "reminder_due_at": 1818944000,
                  "renewal_due_at": 1821536000,
                  "created_at": 1790000000,
                  "updated_at": 1790000000
                }
              ],
              "ledger_summary": {
                "balance": 0,
                "events": 0
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "version": {
                        "type": "integer"
                      },
                      "user": {
                        "type": "string",
                        "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "user_information": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "name",
                          "email"
                        ]
                      },
                      "plan": {
                        "type": "string",
                        "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "plan_version": {
                        "type": "integer"
                      },
                      "name": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "pending_payment",
                          "scheduled",
                          "active",
                          "expired",
                          "exhausted",
                          "cancelled",
                          "payment_failed"
                        ]
                      },
                      "active": {
                        "type": "boolean"
                      },
                      "valid_from": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "valid_until": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "granted_uses": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "remaining_uses": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "membership_promo_code": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "source": {
                        "type": "string"
                      },
                      "renewal": {
                        "type": "object",
                        "properties": {
                          "auto_renew": {
                            "type": "boolean"
                          },
                          "cancel_at_period_end": {
                            "type": "boolean"
                          },
                          "cancel_requested_at": {
                            "type": [
                              "integer",
                              "null"
                            ]
                          },
                          "cancel_effective_at": {
                            "type": [
                              "integer",
                              "null"
                            ]
                          },
                          "next_renewal_at": {
                            "type": [
                              "integer",
                              "null"
                            ]
                          }
                        },
                        "additionalProperties": true
                      },
                      "current_period": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "created_at": {
                        "type": "integer"
                      },
                      "updated_at": {
                        "type": "integer"
                      },
                      "plan_snapshot": {
                        "type": [
                          "object",
                          "array"
                        ],
                        "properties": {
                          "name": {
                            "type": "string"
                          },
                          "validity": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string",
                                "enum": [
                                  "fixed_range",
                                  "relative_duration",
                                  "usage_count"
                                ]
                              },
                              "from": {
                                "type": [
                                  "integer",
                                  "null"
                                ]
                              },
                              "until": {
                                "type": [
                                  "integer",
                                  "null"
                                ]
                              },
                              "value": {
                                "type": [
                                  "integer",
                                  "null"
                                ]
                              },
                              "unit": {
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "uses": {
                                "type": [
                                  "integer",
                                  "null"
                                ]
                              },
                              "promo_code_redemption": {
                                "type": "boolean"
                              }
                            },
                            "additionalProperties": true
                          },
                          "discount": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string",
                                "enum": [
                                  "percent",
                                  "fixed"
                                ]
                              },
                              "value": {
                                "type": "string",
                                "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                                "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                              },
                              "currency": {
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            },
                            "additionalProperties": true
                          },
                          "sale": {
                            "type": "object",
                            "properties": {
                              "amount": {
                                "type": "string",
                                "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                                "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                              },
                              "currency": {
                                "type": "string"
                              },
                              "vat": {
                                "type": [
                                  "string",
                                  "null"
                                ],
                                "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                              }
                            },
                            "additionalProperties": true
                          },
                          "renewal": {
                            "type": "object",
                            "additionalProperties": true
                          },
                          "design": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID des aktuellen Kontos."
                          }
                        },
                        "additionalProperties": true,
                        "items": {},
                        "description": "Gespeicherter, versionsabhängiger Kaufsnapshot. Enthält ggf. weitere öffentliche Kauf-/Rechtskonfiguration; interne vat_id/design_id werden in v2-Referenzen umgewandelt."
                      },
                      "periods": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            },
                            "membership": {
                              "type": "string",
                              "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            },
                            "type": {
                              "type": "string"
                            },
                            "period_start": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "period_end": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "payment_status": {
                              "type": "string"
                            },
                            "amounts": {
                              "type": "object",
                              "properties": {
                                "gross": {
                                  "type": "string",
                                  "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                                  "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                                },
                                "net": {
                                  "type": "string",
                                  "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                                  "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                                },
                                "tax": {
                                  "type": "string",
                                  "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                                  "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                                },
                                "currency": {
                                  "type": "string"
                                }
                              },
                              "additionalProperties": true,
                              "required": [
                                "gross",
                                "net",
                                "tax",
                                "currency"
                              ]
                            },
                            "vat": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": [
                                    "string",
                                    "null"
                                  ],
                                  "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                                  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                                },
                                "rate": {
                                  "type": "string"
                                },
                                "label": {
                                  "type": "string"
                                }
                              },
                              "additionalProperties": true,
                              "required": [
                                "id",
                                "rate",
                                "label"
                              ]
                            },
                            "title": {
                              "type": "string"
                            },
                            "plan_version": {
                              "type": "integer"
                            },
                            "design": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            },
                            "transaction": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            },
                            "invoice": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            },
                            "invoice_number": {
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "payment": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            },
                            "reminder_due_at": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "renewal_due_at": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "created_at": {
                              "type": "integer"
                            },
                            "updated_at": {
                              "type": "integer"
                            }
                          },
                          "additionalProperties": true,
                          "required": [
                            "id",
                            "membership",
                            "type",
                            "period_start",
                            "period_end",
                            "payment_status",
                            "amounts",
                            "vat",
                            "title",
                            "plan_version",
                            "design",
                            "transaction",
                            "invoice",
                            "invoice_number",
                            "payment",
                            "reminder_due_at",
                            "renewal_due_at",
                            "created_at",
                            "updated_at"
                          ]
                        }
                      },
                      "ledger_summary": {
                        "type": "object",
                        "properties": {
                          "balance": {
                            "type": "integer"
                          },
                          "events": {
                            "type": "integer"
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "balance",
                          "events"
                        ]
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "id",
                      "version",
                      "user",
                      "user_information",
                      "plan",
                      "plan_version",
                      "name",
                      "status",
                      "active",
                      "valid_from",
                      "valid_until",
                      "granted_uses",
                      "remaining_uses",
                      "membership_promo_code",
                      "source",
                      "renewal",
                      "current_period",
                      "created_at",
                      "updated_at",
                      "plan_snapshot",
                      "periods",
                      "ledger_summary"
                    ]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "period": {
                        "type": "string",
                        "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "invoice": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      },
                      "expires_at": {
                        "type": "integer"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "period",
                      "invoice",
                      "url",
                      "expires_at"
                    ]
                  }
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "version": {
                      "type": [
                        "integer",
                        "number",
                        "string",
                        "boolean"
                      ],
                      "description": "Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden."
                    },
                    "mode": {
                      "type": "string",
                      "enum": [
                        "period_end",
                        "immediate"
                      ],
                      "default": "period_end"
                    },
                    "reason": {
                      "type": "string",
                      "minLength": 1,
                      "description": "Nichtleerer, revisionssicher protokollierter Kündigungsgrund."
                    },
                    "request_id": {
                      "type": "string"
                    },
                    "action": {
                      "const": "cancel"
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "action",
                    "version",
                    "reason"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "version": {
                      "type": [
                        "integer",
                        "number",
                        "string",
                        "boolean"
                      ],
                      "description": "Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden."
                    },
                    "enabled": {
                      "type": [
                        "boolean",
                        "integer",
                        "string"
                      ],
                      "description": "Normalisierung mit FILTER_VALIDATE_BOOL; z.B. true/false, 1/0 und \"true\"/\"false\"."
                    },
                    "reason": {
                      "type": "string",
                      "minLength": 1
                    },
                    "request_id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 128,
                      "pattern": "^[A-Za-z0-9._:-]+$",
                      "description": "Clientseitig stabiler Schlüssel für genau diesen Vorgang; nach Whitespace-Trim 1–128 Zeichen."
                    },
                    "action": {
                      "const": "renewal"
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "action",
                    "version",
                    "reason",
                    "request_id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "version": {
                      "type": [
                        "integer",
                        "number",
                        "string",
                        "boolean"
                      ],
                      "description": "Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden."
                    },
                    "valid_until": {
                      "type": [
                        "integer",
                        "number",
                        "string",
                        "boolean"
                      ],
                      "description": "Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden."
                    },
                    "reason": {
                      "type": "string",
                      "minLength": 1
                    },
                    "request_id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 128,
                      "pattern": "^[A-Za-z0-9._:-]+$",
                      "description": "Clientseitig stabiler Schlüssel für genau diesen Vorgang; nach Whitespace-Trim 1–128 Zeichen."
                    },
                    "action": {
                      "const": "adjust-validity"
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "action",
                    "version",
                    "valid_until",
                    "reason",
                    "request_id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "version": {
                      "type": [
                        "integer",
                        "number",
                        "string",
                        "boolean"
                      ],
                      "description": "Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden."
                    },
                    "quantity": {
                      "type": [
                        "integer",
                        "number",
                        "string",
                        "boolean"
                      ],
                      "description": "Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden."
                    },
                    "reason": {
                      "type": "string",
                      "minLength": 1
                    },
                    "idempotency_key": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 128,
                      "pattern": "^[A-Za-z0-9._:-]+$",
                      "description": "Clientseitig stabiler Schlüssel für genau diesen Vorgang; nach Whitespace-Trim 1–128 Zeichen."
                    },
                    "action": {
                      "const": "credit-uses"
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "action",
                    "version",
                    "quantity",
                    "reason",
                    "idempotency_key"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "action": {
                      "const": "payment-link"
                    },
                    "period": {
                      "type": "string",
                      "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID des aktuellen Kontos."
                    },
                    "language": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "action",
                    "period"
                  ]
                }
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Administrative Mitgliedschaftsaktion ausführen",
            "value": {
              "data": {
                "action": "cancel",
                "version": 1,
                "mode": "period_end",
                "reason": "Kündigung durch Kunde"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/01-membership.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Usermembership.php",
    "method": "updateUsermembership",
    "line": 194
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "usermembership",
    "short": "usme",
    "checkedByDispatcher": true,
    "levels": [
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}