PUT

/api/v1/extensions/{id}/groups

Gruppenzuordnung atomar ändern; gilt auch für neue Profile und beim nächsten Start

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request PUT \
  "$ADBR_API_URL/api/v1/extensions/{id}/groups" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs. Erstelle request.json anhand des folgenden Körperschemas, bevor du den Befehl ausführst.

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: extensions:write, profiles:write

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Kontorechte, Anfrageinhalt, Tresorzustand und Ressourcenrechte können weitere Voraussetzungen setzen.

Parameter#

Parameter	Ort	Pflicht	Beschreibung
`id`	path	Ja

Vollständige Parameterschemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Anfragekörper#

Erforderlich.

Feld	Typ	Pflicht
`group_ids`	`array`	Ja
`profile_ids`	`array`	Nein
`revision`	`string`	Ja

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "group_ids",
          "revision"
        ],
        "properties": {
          "group_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 10000
          },
          "profile_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 10000
          },
          "revision": {
            "type": "string",
            "minLength": 64,
            "maxLength": 64
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "revision",
          "groups"
        ],
        "properties": {
          "revision": {
            "type": "string"
          },
          "groups": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "name",
                "profile_count",
                "selected",
                "profiles"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "profile_count": {
                  "type": "integer"
                },
                "selected": {
                  "type": "boolean"
                },
                "profiles": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id",
                      "name",
                      "selected"
                    ],
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "selected": {
                        "type": "boolean"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

default · HTTP-Fehlerhülle. Status und error.code bezeichnen den Fehler.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

Allgemeine Authentifizierungs- und Transportfehler können zusätzlich zu den dokumentierten Antworten auftreten.

OpenAPI-Definition#

Vollständige Operationsdefinition

OpenAPI JSON

{
  "summary": "Gruppenzuordnung atomar ändern; gilt auch für neue Profile und beim nächsten Start",
  "tags": [
    "Erweiterungen"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "group_ids",
            "revision"
          ],
          "properties": {
            "group_ids": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 10000
            },
            "profile_ids": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 10000
            },
            "revision": {
              "type": "string",
              "minLength": 64,
              "maxLength": 64
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "extensions:write",
    "profiles:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "revision",
              "groups"
            ],
            "properties": {
              "revision": {
                "type": "string"
              },
              "groups": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "profile_count",
                    "selected",
                    "profiles"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "profile_count": {
                      "type": "integer"
                    },
                    "selected": {
                      "type": "boolean"
                    },
                    "profiles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "name",
                          "selected"
                        ],
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "selected": {
                            "type": "boolean"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}