TabGeckoTeam · API
Generated from the OpenAPI snapshot. Source summaries remain unchanged; JSON schemas below are the exact exported definitions.
GET /api/v1/team/conflicts
Aktuelle Synchronisierungskonflikte anzeigen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"kind",
"name",
"token",
"local",
"cloud",
"can_keep_local"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"group"
]
},
{
"type": "string",
"enum": [
"trash"
]
}
]
},
"name": {
"type": "string"
},
"token": {
"type": "string"
},
"local": {
"type": "string"
},
"cloud": {
"type": "string"
},
"can_keep_local": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Aktuelle Synchronisierungskonflikte anzeigen",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"kind",
"name",
"token",
"local",
"cloud",
"can_keep_local"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"group"
]
},
{
"type": "string",
"enum": [
"trash"
]
}
]
},
"name": {
"type": "string"
},
"token": {
"type": "string"
},
"local": {
"type": "string"
},
"cloud": {
"type": "string"
},
"can_keep_local": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/conflicts/resolve
Angezeigten Synchronisierungskonflikt auflösen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"token",
"choice"
],
"properties": {
"token": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"choice": {
"anyOf": [
{
"type": "string",
"enum": [
"local"
]
},
{
"type": "string",
"enum": [
"cloud"
]
}
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Angezeigten Synchronisierungskonflikt auflösen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"token",
"choice"
],
"properties": {
"token": {
"type": "string",
"minLength": 64,
"maxLength": 64
},
"choice": {
"anyOf": [
{
"type": "string",
"enum": [
"local"
]
},
{
"type": "string",
"enum": [
"cloud"
]
}
]
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/synchronize
Automatischen Cloud-Profilabgleich jetzt ausführen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connected",
"local_connection",
"cloud_team_id",
"profile_sync",
"key_sync",
"hosting",
"server_url",
"links",
"group_sync",
"busy",
"cross_team_transfers",
"transfers"
],
"properties": {
"connected": {
"type": "boolean"
},
"local_connection": {
"type": "boolean"
},
"cloud_team_id": {
"type": [
"string",
"null"
]
},
"profile_sync": {
"type": "object",
"required": [
"running",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"key_sync": {
"type": "object",
"required": [
"running",
"checked",
"updated",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"checked": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"hosting": {
"type": "boolean"
},
"server_url": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"remote_id",
"version",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"warning": {
"type": [
"string",
"null"
]
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"dirty": {
"type": "boolean"
},
"auto_blocked": {
"type": "boolean"
},
"synced_seq": {
"type": "integer"
},
"synced_stamp": {
"type": "string"
}
}
}
},
"group_sync": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"remote_group_id",
"mode"
],
"properties": {
"group_id": {
"type": "string"
},
"remote_group_id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
},
"busy": {
"type": "array",
"items": {
"type": "string"
}
},
"cross_team_transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"target_team",
"mode",
"completed"
],
"properties": {
"profile_id": {
"type": "string"
},
"target_team": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"completed": {
"type": "boolean"
}
}
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase",
"started_at",
"updated_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing"
]
},
{
"type": "string",
"enum": [
"uploading"
]
},
{
"type": "string",
"enum": [
"downloading"
]
},
{
"type": "string",
"enum": [
"applying"
]
}
]
},
"started_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Automatischen Cloud-Profilabgleich jetzt ausführen",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connected",
"local_connection",
"cloud_team_id",
"profile_sync",
"key_sync",
"hosting",
"server_url",
"links",
"group_sync",
"busy",
"cross_team_transfers",
"transfers"
],
"properties": {
"connected": {
"type": "boolean"
},
"local_connection": {
"type": "boolean"
},
"cloud_team_id": {
"type": [
"string",
"null"
]
},
"profile_sync": {
"type": "object",
"required": [
"running",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"key_sync": {
"type": "object",
"required": [
"running",
"checked",
"updated",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"checked": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"hosting": {
"type": "boolean"
},
"server_url": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"remote_id",
"version",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"warning": {
"type": [
"string",
"null"
]
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"dirty": {
"type": "boolean"
},
"auto_blocked": {
"type": "boolean"
},
"synced_seq": {
"type": "integer"
},
"synced_stamp": {
"type": "string"
}
}
}
},
"group_sync": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"remote_group_id",
"mode"
],
"properties": {
"group_id": {
"type": "string"
},
"remote_group_id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
},
"busy": {
"type": "array",
"items": {
"type": "string"
}
},
"cross_team_transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"target_team",
"mode",
"completed"
],
"properties": {
"profile_id": {
"type": "string"
},
"target_team": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"completed": {
"type": "boolean"
}
}
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase",
"started_at",
"updated_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing"
]
},
{
"type": "string",
"enum": [
"uploading"
]
},
{
"type": "string",
"enum": [
"downloading"
]
},
{
"type": "string",
"enum": [
"applying"
]
}
]
},
"started_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/team/group-sync/{id}
Automatischen Cookie- oder Browserdatenabgleich einer lokalen Gruppe einstellen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"required": [
"remote_group_id",
"mode"
],
"properties": {
"remote_group_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
},
"additionalProperties": false
}
]
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Automatischen Cookie- oder Browserdatenabgleich einer lokalen Gruppe einstellen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"required": [
"remote_group_id",
"mode"
],
"properties": {
"remote_group_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
},
"additionalProperties": false
}
]
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/team/profiles/{id}
Team-Freigabe einschließlich aller Serverversionen löschen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok",
"pending_bytes"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"pending_bytes": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Freigabe einschließlich aller Serverversionen löschen",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok",
"pending_bytes"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"pending_bytes": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/team/profiles/{id}/versions/{version}
Alte Serverversion einer Team-Freigabe löschen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes | |
version | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "path",
"name": "version",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok",
"pending_bytes"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"pending_bytes": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Alte Serverversion einer Team-Freigabe löschen",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "path",
"name": "version",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok",
"pending_bytes"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"pending_bytes": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/hosted/config
Freigabe der lokalen Browserausführung anzeigen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled",
"profile_ids",
"max_sessions"
],
"properties": {
"enabled": {
"type": "boolean"
},
"profile_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"max_sessions": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Freigabe der lokalen Browserausführung anzeigen",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled",
"profile_ids",
"max_sessions"
],
"properties": {
"enabled": {
"type": "boolean"
},
"profile_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"max_sessions": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/team/hosted/config
Lokale Profile zur Browserausführung auf dem Teamhost freigeben
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled",
"profile_ids",
"max_sessions"
],
"properties": {
"enabled": {
"type": "boolean"
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 500,
"uniqueItems": true
},
"max_sessions": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled",
"profile_ids",
"max_sessions"
],
"properties": {
"enabled": {
"type": "boolean"
},
"profile_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"max_sessions": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Lokale Profile zur Browserausführung auf dem Teamhost freigeben",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled",
"profile_ids",
"max_sessions"
],
"properties": {
"enabled": {
"type": "boolean"
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 500,
"uniqueItems": true
},
"max_sessions": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled",
"profile_ids",
"max_sessions"
],
"properties": {
"enabled": {
"type": "boolean"
},
"profile_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"max_sessions": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/hosted/profiles
Ausführbare Profile und Sitzungen auf dem Teamhost
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled",
"max_sessions",
"items"
],
"properties": {
"enabled": {
"type": "boolean"
},
"max_sessions": {
"type": "integer"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"session"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"session": {
"anyOf": [
{
"type": "object",
"required": [
"remote_id",
"member_id",
"member_name",
"state",
"browser"
],
"properties": {
"remote_id": {
"type": "string"
},
"member_id": {
"type": "string"
},
"member_name": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"starting"
]
},
{
"type": "string",
"enum": [
"running"
]
},
{
"type": "string",
"enum": [
"stopping"
]
}
]
},
"browser": {
"anyOf": [
{
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer"
},
"ws_endpoint": {
"type": "string"
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"string",
"null"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"integer",
"null"
]
},
"exit_ip": {
"type": [
"string",
"null"
]
},
"proxy_country": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Ausführbare Profile und Sitzungen auf dem Teamhost",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled",
"max_sessions",
"items"
],
"properties": {
"enabled": {
"type": "boolean"
},
"max_sessions": {
"type": "integer"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"session"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"session": {
"anyOf": [
{
"type": "object",
"required": [
"remote_id",
"member_id",
"member_name",
"state",
"browser"
],
"properties": {
"remote_id": {
"type": "string"
},
"member_id": {
"type": "string"
},
"member_name": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"starting"
]
},
{
"type": "string",
"enum": [
"running"
]
},
{
"type": "string",
"enum": [
"stopping"
]
}
]
},
"browser": {
"anyOf": [
{
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer"
},
"ws_endpoint": {
"type": "string"
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"string",
"null"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"integer",
"null"
]
},
"exit_ip": {
"type": [
"string",
"null"
]
},
"proxy_country": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/hosted/profiles/{id}/start
Freigegebenen Browser auf dem lokalen Teamhost starten
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"remote_id",
"member_id",
"member_name",
"state",
"browser"
],
"properties": {
"remote_id": {
"type": "string"
},
"member_id": {
"type": "string"
},
"member_name": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"starting"
]
},
{
"type": "string",
"enum": [
"running"
]
},
{
"type": "string",
"enum": [
"stopping"
]
}
]
},
"browser": {
"anyOf": [
{
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer"
},
"ws_endpoint": {
"type": "string"
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"string",
"null"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"integer",
"null"
]
},
"exit_ip": {
"type": [
"string",
"null"
]
},
"proxy_country": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Freigegebenen Browser auf dem lokalen Teamhost starten",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"remote_id",
"member_id",
"member_name",
"state",
"browser"
],
"properties": {
"remote_id": {
"type": "string"
},
"member_id": {
"type": "string"
},
"member_name": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"starting"
]
},
{
"type": "string",
"enum": [
"running"
]
},
{
"type": "string",
"enum": [
"stopping"
]
}
]
},
"browser": {
"anyOf": [
{
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer"
},
"ws_endpoint": {
"type": "string"
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"string",
"null"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"integer",
"null"
]
},
"exit_ip": {
"type": [
"string",
"null"
]
},
"proxy_country": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/hosted/profiles/{id}/stop
Eigene Host-Sitzung beenden
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Eigene Host-Sitzung beenden",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/profile-groups
Zugängliche Team-Profilgruppen auflisten
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"member_ids",
"profiles"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"profiles": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Zugängliche Team-Profilgruppen auflisten",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"member_ids",
"profiles"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"profiles": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profile-groups
Team-Profilgruppe erstellen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"member_ids"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"member_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100,
"uniqueItems": true
}
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"member_ids",
"profiles"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"profiles": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Profilgruppe erstellen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"member_ids"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"member_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100,
"uniqueItems": true
}
]
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"member_ids",
"profiles"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"profiles": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/team/profile-groups/{id}
Team-Profilgruppe ändern
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"member_ids"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"member_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100,
"uniqueItems": true
}
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"member_ids",
"profiles"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"profiles": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Profilgruppe ändern",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"member_ids"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"member_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100,
"uniqueItems": true
}
]
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"member_ids",
"profiles"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"profiles": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/team/profile-groups/{id}
Nicht verwendete Team-Profilgruppe löschen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Nicht verwendete Team-Profilgruppe löschen",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/permission-groups
Team-Berechtigungsgruppen auflisten
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"permissions",
"members"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"members": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Berechtigungsgruppen auflisten",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"permissions",
"members"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"members": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/permission-groups
Team-Berechtigungsgruppe erstellen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"permissions"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
},
"maxItems": 11,
"uniqueItems": true
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"permissions",
"members"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"members": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Berechtigungsgruppe erstellen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"permissions"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
},
"maxItems": 11,
"uniqueItems": true
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"permissions",
"members"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"members": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/team/permission-groups/{id}
Team-Berechtigungsgruppe ändern
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"permissions"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
},
"maxItems": 11,
"uniqueItems": true
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"permissions",
"members"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"members": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Berechtigungsgruppe ändern",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"permissions"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
},
"maxItems": 11,
"uniqueItems": true
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"permissions",
"members"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"members": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/team/permission-groups/{id}
Nicht zugewiesene Team-Berechtigungsgruppe löschen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Nicht zugewiesene Team-Berechtigungsgruppe löschen",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/team/members/{id}/permission-group
Berechtigungsgruppe einem Teammitglied zuweisen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"group_id"
],
"properties": {
"group_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"minLength": 1,
"maxLength": 64
}
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"group_id"
],
"properties": {
"group_id": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Berechtigungsgruppe einem Teammitglied zuweisen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"group_id"
],
"properties": {
"group_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"minLength": 1,
"maxLength": 64
}
]
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"group_id"
],
"properties": {
"group_id": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/profiles/{id}/access
Empfängerauswahl einer Team-Freigabe
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"member_ids",
"group_id"
],
"properties": {
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"group_id": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Empfängerauswahl einer Team-Freigabe",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"member_ids",
"group_id"
],
"properties": {
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"group_id": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/team/profiles/{id}/access
Zugriff auf eine Team-Freigabe beschränken
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"member_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100,
"uniqueItems": true
}
]
},
"group_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"minLength": 1,
"maxLength": 64
}
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"member_ids",
"group_id"
],
"properties": {
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"group_id": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Zugriff auf eine Team-Freigabe beschränken",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"member_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100,
"uniqueItems": true
}
]
},
"group_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"minLength": 1,
"maxLength": 64
}
]
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"member_ids",
"group_id"
],
"properties": {
"member_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"group_id": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/team/members/{id}/role
Team-Rolle ändern
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"role"
],
"properties": {
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"role",
"public_key"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner"
]
},
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
},
"public_key": {
"type": "string"
},
"principal_id": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Rolle ändern",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"role"
],
"properties": {
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"role",
"public_key"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner"
]
},
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
},
"public_key": {
"type": "string"
},
"principal_id": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/team/profiles/{id}/versions
Frühere Cloud-Versionen löschen und aktuellen Stand behalten
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
base_version | query | Yes | |
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "query",
"name": "base_version",
"required": true
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok",
"pending_bytes"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"pending_bytes": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Frühere Cloud-Versionen löschen und aktuellen Stand behalten",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "query",
"name": "base_version",
"required": true
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok",
"pending_bytes"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"pending_bytes": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/profiles/{id}/versions
Zugängliche Versionen einer Team-Freigabe
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
before | query | No | |
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "query",
"name": "before",
"required": false
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items",
"next_before"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"group_id",
"version",
"size",
"updated_at",
"name",
"scope",
"kernel",
"synced_by"
],
"properties": {
"id": {
"type": "string"
},
"group_id": {
"type": [
"string",
"null"
]
},
"version": {
"type": "integer"
},
"size": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"name": {
"type": "string"
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"kernel": {
"type": [
"string",
"null"
]
},
"synced_by": {
"type": [
"string",
"null"
]
}
}
}
},
"next_before": {
"type": [
"integer",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Zugängliche Versionen einer Team-Freigabe",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "query",
"name": "before",
"required": false
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items",
"next_before"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"group_id",
"version",
"size",
"updated_at",
"name",
"scope",
"kernel",
"synced_by"
],
"properties": {
"id": {
"type": "string"
},
"group_id": {
"type": [
"string",
"null"
]
},
"version": {
"type": "integer"
},
"size": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"name": {
"type": "string"
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"kernel": {
"type": [
"string",
"null"
]
},
"synced_by": {
"type": [
"string",
"null"
]
}
}
}
},
"next_before": {
"type": [
"integer",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profiles/{id}/versions/{version}/restore
Frühere Cloud-Version im bestehenden Profil wiederherstellen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes | |
version | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "path",
"name": "version",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"row_version"
],
"properties": {
"profile_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"row_version": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"version",
"published",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"published": {
"type": "boolean"
},
"error": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Frühere Cloud-Version im bestehenden Profil wiederherstellen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"row_version"
],
"properties": {
"profile_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"row_version": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "path",
"name": "version",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"version",
"published",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"published": {
"type": "boolean"
},
"error": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profiles/{id}/versions/{version}/download
Frühere Team-Version als unabhängige lokale Kopie laden
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes | |
version | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "path",
"name": "version",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"version"
],
"properties": {
"profile_id": {
"type": "string"
},
"version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Frühere Team-Version als unabhängige lokale Kopie laden",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"in": "path",
"name": "version",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"version"
],
"properties": {
"profile_id": {
"type": "string"
},
"version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team
Team- und Synchronisierungsstatus
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connected",
"local_connection",
"cloud_team_id",
"profile_sync",
"key_sync",
"hosting",
"server_url",
"links",
"group_sync",
"busy",
"cross_team_transfers",
"transfers"
],
"properties": {
"connected": {
"type": "boolean"
},
"local_connection": {
"type": "boolean"
},
"cloud_team_id": {
"type": [
"string",
"null"
]
},
"profile_sync": {
"type": "object",
"required": [
"running",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"key_sync": {
"type": "object",
"required": [
"running",
"checked",
"updated",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"checked": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"hosting": {
"type": "boolean"
},
"server_url": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"remote_id",
"version",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"warning": {
"type": [
"string",
"null"
]
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"dirty": {
"type": "boolean"
},
"auto_blocked": {
"type": "boolean"
},
"synced_seq": {
"type": "integer"
},
"synced_stamp": {
"type": "string"
}
}
}
},
"group_sync": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"remote_group_id",
"mode"
],
"properties": {
"group_id": {
"type": "string"
},
"remote_group_id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
},
"busy": {
"type": "array",
"items": {
"type": "string"
}
},
"cross_team_transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"target_team",
"mode",
"completed"
],
"properties": {
"profile_id": {
"type": "string"
},
"target_team": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"completed": {
"type": "boolean"
}
}
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase",
"started_at",
"updated_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing"
]
},
{
"type": "string",
"enum": [
"uploading"
]
},
{
"type": "string",
"enum": [
"downloading"
]
},
{
"type": "string",
"enum": [
"applying"
]
}
]
},
"started_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team- und Synchronisierungsstatus",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connected",
"local_connection",
"cloud_team_id",
"profile_sync",
"key_sync",
"hosting",
"server_url",
"links",
"group_sync",
"busy",
"cross_team_transfers",
"transfers"
],
"properties": {
"connected": {
"type": "boolean"
},
"local_connection": {
"type": "boolean"
},
"cloud_team_id": {
"type": [
"string",
"null"
]
},
"profile_sync": {
"type": "object",
"required": [
"running",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"key_sync": {
"type": "object",
"required": [
"running",
"checked",
"updated",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"checked": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"hosting": {
"type": "boolean"
},
"server_url": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"remote_id",
"version",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"warning": {
"type": [
"string",
"null"
]
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"dirty": {
"type": "boolean"
},
"auto_blocked": {
"type": "boolean"
},
"synced_seq": {
"type": "integer"
},
"synced_stamp": {
"type": "string"
}
}
}
},
"group_sync": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"remote_group_id",
"mode"
],
"properties": {
"group_id": {
"type": "string"
},
"remote_group_id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
},
"busy": {
"type": "array",
"items": {
"type": "string"
}
},
"cross_team_transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"target_team",
"mode",
"completed"
],
"properties": {
"profile_id": {
"type": "string"
},
"target_team": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"completed": {
"type": "boolean"
}
}
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase",
"started_at",
"updated_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing"
]
},
{
"type": "string",
"enum": [
"uploading"
]
},
{
"type": "string",
"enum": [
"downloading"
]
},
{
"type": "string",
"enum": [
"applying"
]
}
]
},
"started_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/info
Team-Mitgliedschaft und Speicherlimit
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"member",
"quota",
"used",
"accounting"
],
"properties": {
"member": {
"type": "object",
"required": [
"id",
"name",
"role",
"public_key",
"permissions",
"permission_group_id"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner"
]
},
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
},
"public_key": {
"type": "string"
},
"principal_id": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"permission_group_id": {
"type": [
"string",
"null"
]
}
}
},
"quota": {
"type": "integer"
},
"used": {
"type": "integer"
},
"accounting": {
"anyOf": [
{
"type": "object",
"required": [
"pending",
"error"
],
"properties": {
"pending": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Mitgliedschaft und Speicherlimit",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"member",
"quota",
"used",
"accounting"
],
"properties": {
"member": {
"type": "object",
"required": [
"id",
"name",
"role",
"public_key",
"permissions",
"permission_group_id"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner"
]
},
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
},
"public_key": {
"type": "string"
},
"principal_id": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"permission_group_id": {
"type": [
"string",
"null"
]
}
}
},
"quota": {
"type": "integer"
},
"used": {
"type": "integer"
},
"accounting": {
"anyOf": [
{
"type": "object",
"required": [
"pending",
"error"
],
"properties": {
"pending": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/members
Team-Mitglieder
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"role",
"public_key",
"permissions",
"permission_group_id"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner"
]
},
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
},
"public_key": {
"type": "string"
},
"principal_id": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"permission_group_id": {
"type": [
"string",
"null"
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Mitglieder",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"role",
"public_key",
"permissions",
"permission_group_id"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner"
]
},
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
},
"public_key": {
"type": "string"
},
"principal_id": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"profiles:read"
]
},
{
"type": "string",
"enum": [
"profiles:create"
]
},
{
"type": "string",
"enum": [
"profiles:publish"
]
},
{
"type": "string",
"enum": [
"profiles:hosted"
]
},
{
"type": "string",
"enum": [
"profiles:delete"
]
},
{
"type": "string",
"enum": [
"profiles:history_delete"
]
},
{
"type": "string",
"enum": [
"workflows:share"
]
},
{
"type": "string",
"enum": [
"members:manage"
]
},
{
"type": "string",
"enum": [
"vaults:read"
]
},
{
"type": "string",
"enum": [
"vaults:publish"
]
},
{
"type": "string",
"enum": [
"vaults:delete"
]
}
]
}
},
"permission_group_id": {
"type": [
"string",
"null"
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/profiles
Für dieses Mitglied verschlüsselte Profile
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"group_id",
"version",
"size",
"updated_at",
"name",
"scope"
],
"properties": {
"id": {
"type": "string"
},
"group_id": {
"type": [
"string",
"null"
]
},
"version": {
"type": "integer"
},
"size": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"name": {
"type": "string"
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Für dieses Mitglied verschlüsselte Profile",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"group_id",
"version",
"size",
"updated_at",
"name",
"scope"
],
"properties": {
"id": {
"type": "string"
},
"group_id": {
"type": [
"string",
"null"
]
},
"version": {
"type": "integer"
},
"size": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"name": {
"type": "string"
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/cloud/connect
Cloud-Abgleich mit dem angemeldeten Kontoteam verbinden
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connected",
"local_connection",
"cloud_team_id",
"profile_sync",
"key_sync",
"hosting",
"server_url",
"links",
"group_sync",
"busy",
"cross_team_transfers",
"transfers"
],
"properties": {
"connected": {
"type": "boolean"
},
"local_connection": {
"type": "boolean"
},
"cloud_team_id": {
"type": [
"string",
"null"
]
},
"profile_sync": {
"type": "object",
"required": [
"running",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"key_sync": {
"type": "object",
"required": [
"running",
"checked",
"updated",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"checked": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"hosting": {
"type": "boolean"
},
"server_url": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"remote_id",
"version",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"warning": {
"type": [
"string",
"null"
]
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"dirty": {
"type": "boolean"
},
"auto_blocked": {
"type": "boolean"
},
"synced_seq": {
"type": "integer"
},
"synced_stamp": {
"type": "string"
}
}
}
},
"group_sync": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"remote_group_id",
"mode"
],
"properties": {
"group_id": {
"type": "string"
},
"remote_group_id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
},
"busy": {
"type": "array",
"items": {
"type": "string"
}
},
"cross_team_transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"target_team",
"mode",
"completed"
],
"properties": {
"profile_id": {
"type": "string"
},
"target_team": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"completed": {
"type": "boolean"
}
}
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase",
"started_at",
"updated_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing"
]
},
{
"type": "string",
"enum": [
"uploading"
]
},
{
"type": "string",
"enum": [
"downloading"
]
},
{
"type": "string",
"enum": [
"applying"
]
}
]
},
"started_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Cloud-Abgleich mit dem angemeldeten Kontoteam verbinden",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connected",
"local_connection",
"cloud_team_id",
"profile_sync",
"key_sync",
"hosting",
"server_url",
"links",
"group_sync",
"busy",
"cross_team_transfers",
"transfers"
],
"properties": {
"connected": {
"type": "boolean"
},
"local_connection": {
"type": "boolean"
},
"cloud_team_id": {
"type": [
"string",
"null"
]
},
"profile_sync": {
"type": "object",
"required": [
"running",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"key_sync": {
"type": "object",
"required": [
"running",
"checked",
"updated",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"checked": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"hosting": {
"type": "boolean"
},
"server_url": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"remote_id",
"version",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"warning": {
"type": [
"string",
"null"
]
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"dirty": {
"type": "boolean"
},
"auto_blocked": {
"type": "boolean"
},
"synced_seq": {
"type": "integer"
},
"synced_stamp": {
"type": "string"
}
}
}
},
"group_sync": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"remote_group_id",
"mode"
],
"properties": {
"group_id": {
"type": "string"
},
"remote_group_id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
},
"busy": {
"type": "array",
"items": {
"type": "string"
}
},
"cross_team_transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"target_team",
"mode",
"completed"
],
"properties": {
"profile_id": {
"type": "string"
},
"target_team": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"completed": {
"type": "boolean"
}
}
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase",
"started_at",
"updated_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing"
]
},
{
"type": "string",
"enum": [
"uploading"
]
},
{
"type": "string",
"enum": [
"downloading"
]
},
{
"type": "string",
"enum": [
"applying"
]
}
]
},
"started_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/host
Lokalen Teamdienst starten
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connected",
"local_connection",
"cloud_team_id",
"profile_sync",
"key_sync",
"hosting",
"server_url",
"links",
"group_sync",
"busy",
"cross_team_transfers",
"transfers"
],
"properties": {
"connected": {
"type": "boolean"
},
"local_connection": {
"type": "boolean"
},
"cloud_team_id": {
"type": [
"string",
"null"
]
},
"profile_sync": {
"type": "object",
"required": [
"running",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"key_sync": {
"type": "object",
"required": [
"running",
"checked",
"updated",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"checked": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"hosting": {
"type": "boolean"
},
"server_url": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"remote_id",
"version",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"warning": {
"type": [
"string",
"null"
]
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"dirty": {
"type": "boolean"
},
"auto_blocked": {
"type": "boolean"
},
"synced_seq": {
"type": "integer"
},
"synced_stamp": {
"type": "string"
}
}
}
},
"group_sync": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"remote_group_id",
"mode"
],
"properties": {
"group_id": {
"type": "string"
},
"remote_group_id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
},
"busy": {
"type": "array",
"items": {
"type": "string"
}
},
"cross_team_transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"target_team",
"mode",
"completed"
],
"properties": {
"profile_id": {
"type": "string"
},
"target_team": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"completed": {
"type": "boolean"
}
}
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase",
"started_at",
"updated_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing"
]
},
{
"type": "string",
"enum": [
"uploading"
]
},
{
"type": "string",
"enum": [
"downloading"
]
},
{
"type": "string",
"enum": [
"applying"
]
}
]
},
"started_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Lokalen Teamdienst starten",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connected",
"local_connection",
"cloud_team_id",
"profile_sync",
"key_sync",
"hosting",
"server_url",
"links",
"group_sync",
"busy",
"cross_team_transfers",
"transfers"
],
"properties": {
"connected": {
"type": "boolean"
},
"local_connection": {
"type": "boolean"
},
"cloud_team_id": {
"type": [
"string",
"null"
]
},
"profile_sync": {
"type": "object",
"required": [
"running",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"key_sync": {
"type": "object",
"required": [
"running",
"checked",
"updated",
"last_synced",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"checked": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"last_synced": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
"hosting": {
"type": "boolean"
},
"server_url": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"remote_id",
"version",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"warning": {
"type": [
"string",
"null"
]
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"profile"
]
},
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
},
"dirty": {
"type": "boolean"
},
"auto_blocked": {
"type": "boolean"
},
"synced_seq": {
"type": "integer"
},
"synced_stamp": {
"type": "string"
}
}
}
},
"group_sync": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"remote_group_id",
"mode"
],
"properties": {
"group_id": {
"type": "string"
},
"remote_group_id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"browser"
]
}
]
}
}
}
},
"busy": {
"type": "array",
"items": {
"type": "string"
}
},
"cross_team_transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"target_team",
"mode",
"completed"
],
"properties": {
"profile_id": {
"type": "string"
},
"target_team": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"completed": {
"type": "boolean"
}
}
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase",
"started_at",
"updated_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"preparing"
]
},
{
"type": "string",
"enum": [
"uploading"
]
},
{
"type": "string",
"enum": [
"downloading"
]
},
{
"type": "string",
"enum": [
"applying"
]
}
]
},
"started_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/host/stop
Lokalen Teamdienst stoppen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Lokalen Teamdienst stoppen",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/invitations
Einmalige Team-Einladung erstellen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"role"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"invitation_code",
"expires_at"
],
"properties": {
"invitation_code": {
"type": "string"
},
"expires_at": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Einmalige Team-Einladung erstellen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"role"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"invitation_code",
"expires_at"
],
"properties": {
"invitation_code": {
"type": "string"
},
"expires_at": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/join
Lokaler Team-Einladung beitreten
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"invitation_code"
],
"properties": {
"invitation_code": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Lokaler Team-Einladung beitreten",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"invitation_code"
],
"properties": {
"invitation_code": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/disconnect
Team-Zugang auf diesem Gerät trennen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Zugang auf diesem Gerät trennen",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/team/members/{id}
Team-Zugang widerrufen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Zugang widerrufen",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profiles/{id}/transfer/cancel
Noch nicht übernommene Teamübertragung abbrechen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Noch nicht übernommene Teamübertragung abbrechen",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profiles/{id}/transfer/keep-local
Bestätigte Teamübertragung abschließen und lokale Kopie behalten
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Bestätigte Teamübertragung abschließen und lokale Kopie behalten",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profiles/{id}/transfer
Profil in ein anderes Kontoteam übertragen oder teilen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"target_team_id",
"mode",
"password"
],
"properties": {
"target_team_id": {
"type": "string",
"pattern": "^team_[A-Za-z0-9_-]{1,128}$",
"example": "team_example"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"password": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"mode"
],
"properties": {
"id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Profil in ein anderes Kontoteam übertragen oder teilen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"target_team_id",
"mode",
"password"
],
"properties": {
"target_team_id": {
"type": "string",
"pattern": "^team_[A-Za-z0-9_-]{1,128}$",
"example": "team_example"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
},
"password": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"mode"
],
"properties": {
"id": {
"type": "string"
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"transfer"
]
},
{
"type": "string",
"enum": [
"share"
]
}
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profiles/{id}/publish
Geschlossenes Profil verschlüsselt im Team veröffentlichen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"member_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100,
"uniqueItems": true
}
]
},
"group_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"minLength": 1,
"maxLength": 64
}
]
}
}
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"version"
],
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Geschlossenes Profil verschlüsselt im Team veröffentlichen",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"member_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100,
"uniqueItems": true
}
]
},
"group_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"minLength": 1,
"maxLength": 64
}
]
}
}
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"version"
],
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profiles/{id}/download
Freigabe als neues lokales Profil laden
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"version"
],
"properties": {
"profile_id": {
"type": "string"
},
"version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Freigabe als neues lokales Profil laden",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"version"
],
"properties": {
"profile_id": {
"type": "string"
},
"version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/profiles/{id}/unlink
Lokales Profil von der Team-Freigabe lösen
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Lokales Profil von der Team-Freigabe lösen",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/group-vaults
Zugängliche verschlüsselte Team-Gruppentresore
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"version",
"size",
"updated_at",
"member_id"
],
"properties": {
"group_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"size": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"member_id": {
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Zugängliche verschlüsselte Team-Gruppentresore",
"tags": [
"Team"
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"version",
"size",
"updated_at",
"member_id"
],
"properties": {
"group_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"size": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"member_id": {
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/team/group-vaults/{id}/recipients
Aktuelle Version und Empfänger vor Veröffentlichung eines Gruppentresors
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"base_version",
"items"
],
"properties": {
"base_version": {
"type": "integer"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"role",
"public_key"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner"
]
},
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
},
"public_key": {
"type": "string"
},
"principal_id": {
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Aktuelle Version und Empfänger vor Veröffentlichung eines Gruppentresors",
"tags": [
"Team"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"base_version",
"items"
],
"properties": {
"base_version": {
"type": "integer"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"role",
"public_key"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner"
]
},
{
"type": "string",
"enum": [
"admin"
]
},
{
"type": "string",
"enum": [
"editor"
]
},
{
"type": "string",
"enum": [
"viewer"
]
}
]
},
"public_key": {
"type": "string"
},
"principal_id": {
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/group-vaults/{id}/publish
Lokalen Gruppentresor ausdrücklich für die ausgewählten Teamempfänger verschlüsseln
Authentication: bearer token
Required route scopes: admin, profiles:read, secrets:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"local_group_id",
"base_version",
"confirm",
"recipient_ids"
],
"properties": {
"local_group_id": {
"type": "string"
},
"base_version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740990
},
"confirm": {
"type": "boolean",
"enum": [
true
]
},
"recipient_ids": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 100,
"uniqueItems": true
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"group_id",
"version",
"size",
"updated_at",
"member_id"
],
"properties": {
"group_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"size": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"member_id": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Lokalen Gruppentresor ausdrücklich für die ausgewählten Teamempfänger verschlüsseln",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"local_group_id",
"base_version",
"confirm",
"recipient_ids"
],
"properties": {
"local_group_id": {
"type": "string"
},
"base_version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740990
},
"confirm": {
"type": "boolean",
"enum": [
true
]
},
"recipient_ids": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 100,
"uniqueItems": true
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin",
"profiles:read",
"secrets:read"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"group_id",
"version",
"size",
"updated_at",
"member_id"
],
"properties": {
"group_id": {
"type": "string"
},
"version": {
"type": "integer"
},
"size": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"member_id": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/group-vaults/{id}/import
Team-Gruppentresor in eine lokale Gruppe importieren
Authentication: bearer token
Required route scopes: admin, profiles:write, secrets:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"local_group_id",
"version",
"update_existing",
"confirm"
],
"properties": {
"local_group_id": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740990
},
"update_existing": {
"type": "boolean"
},
"confirm": {
"type": "boolean",
"enum": [
true
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"created",
"updated",
"skipped",
"version"
],
"properties": {
"created": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"skipped": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Team-Gruppentresor in eine lokale Gruppe importieren",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"local_group_id",
"version",
"update_existing",
"confirm"
],
"properties": {
"local_group_id": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740990
},
"update_existing": {
"type": "boolean"
},
"confirm": {
"type": "boolean",
"enum": [
true
]
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin",
"profiles:write",
"secrets:read"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"created",
"updated",
"skipped",
"version"
],
"properties": {
"created": {
"type": "integer"
},
"updated": {
"type": "integer"
},
"skipped": {
"type": "integer"
},
"version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/team/group-vaults/{id}/remove
Veröffentlichten Gruppentresor entfernen; lokale Kopien behalten
Authentication: bearer token
Required route scopes: admin
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"version",
"confirm"
],
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740990
},
"confirm": {
"type": "boolean",
"enum": [
true
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Veröffentlichten Gruppentresor entfernen; lokale Kopien behalten",
"tags": [
"Team"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"version",
"confirm"
],
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740990
},
"confirm": {
"type": "boolean",
"enum": [
true
]
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}