{
  "openapi": "3.1.0",
  "info": {
    "title": "Psono API · Enterprise Edition",
    "version": "0.2.0",
    "description": "**309 documented operations available in this edition.**\n\nA handwritten, specification-first reference for Psono's HTTP API.\nCovers the Community and Enterprise application, administration, file-server\ncoordination, SSO, SCIM, and gateway routes. Enterprise-only operations and\noptional deployment features are identified separately.\n\nStandard request and response schemas describe the actual HTTP wire format.\nThe logical payloads before encryption and after decryption are connected by\n`x-psono-encryption` and displayed in each operation's documentation.\n\nImporting this specification does not implement encryption, signing, or\nsession establishment. Follow the authentication and encryption guide.\n\n\n[Encryption & authentication guide](protocol.html)",
    "contact": {
      "name": "Psono",
      "url": "https://psono.com"
    },
    "license": {
      "name": "Apache-2.0",
      "identifier": "Apache-2.0"
    }
  },
  "servers": [
    {
      "url": "https://psono.example.com/server",
      "description": "Replace with your server URL, including its configured prefix."
    }
  ],
  "security": [],
  "tags": [
    {
      "name": "Discovery",
      "description": "Public, signed server information."
    },
    {
      "name": "Secrets",
      "description": "Session-authenticated operations with application-layer encryption."
    },
    {
      "name": "API key access",
      "description": "Sessionless access using API-key credentials in the request body."
    },
    {
      "name": "SCIM · Enterprise only",
      "description": "Enterprise provisioning endpoints; requires a configured SCIM provider."
    },
    {
      "name": "API key management",
      "description": "Create, inspect, update, and revoke API keys and secret assignments."
    },
    {
      "name": "Account and multifactor",
      "description": "Account settings, user discovery, security reports, policy, and multifactor enrollment."
    },
    {
      "name": "Authentication",
      "description": "Login, session activation, multifactor challenges, password recovery, and device approval."
    },
    {
      "name": "Avatars",
      "description": "Avatar metadata and binary avatar images."
    },
    {
      "name": "Datastores",
      "description": "Read and maintain the encrypted datastore structures."
    },
    {
      "name": "Files and repositories",
      "description": "File metadata, upload/download authorization, repository credentials, and sharing rights."
    },
    {
      "name": "Groups and memberships",
      "description": "Group encryption material, membership invitations, and administrator flags."
    },
    {
      "name": "Link sharing",
      "description": "Create and access link shares, including public passphrase-protected access."
    },
    {
      "name": "Management commands",
      "description": "Configured management-command interface using a dedicated access key."
    },
    {
      "name": "Metadata",
      "description": "Metadata associated with datastores and shares."
    },
    {
      "name": "Recovery and emergency access",
      "description": "Recovery-code and delayed emergency-access lifecycle."
    },
    {
      "name": "Shares and permissions",
      "description": "Encrypted shares, recipient rights, invitations, and share links."
    },
    {
      "name": "Admin · access and tenants",
      "description": "Administration: access and tenants."
    },
    {
      "name": "Admin · file servers",
      "description": "Administration: file servers."
    },
    {
      "name": "Admin · gateways",
      "description": "Administration: gateways."
    },
    {
      "name": "Admin · groups and sharing",
      "description": "Administration: groups and sharing."
    },
    {
      "name": "Admin · identity providers",
      "description": "Administration: identity providers."
    },
    {
      "name": "Admin · reporting",
      "description": "Administration: reporting."
    },
    {
      "name": "Admin · users",
      "description": "Administration: users."
    },
    {
      "name": "File-server coordination",
      "description": "Internal file-server registration, heartbeat, chunk authorization, and cleanup."
    },
    {
      "name": "Enterprise jobs and keys",
      "description": "Enterprise key provisioning and queued group/user administration jobs."
    },
    {
      "name": "SSO · Enterprise only",
      "description": "SAML and OpenID Connect browser exchanges and encrypted login completion."
    },
    {
      "name": "Gateway · Enterprise only",
      "description": "Gateway discovery, connection launch, service registration, and connection status."
    }
  ],
  "x-psono-encryption-profiles": {
    "none": {
      "name": "No session envelope",
      "guide": "protocol.html#wire-format-versus-logical-payload"
    },
    "session-secretbox": {
      "name": "Session SecretBox",
      "guide": "protocol.html#session-secretbox-profile"
    },
    "file-transfer-secretbox": {
      "name": "File-transfer SecretBox",
      "guide": "protocol.html#file-transfer-and-service-credentials"
    },
    "fileserver-secretbox": {
      "name": "File-server SecretBox",
      "guide": "protocol.html#file-transfer-and-service-credentials"
    },
    "gateway-secretbox": {
      "name": "Gateway SecretBox",
      "guide": "protocol.html#file-transfer-and-service-credentials"
    },
    "login-box": {
      "name": "Public-key login exchange",
      "guide": "protocol.html#password-login"
    },
    "api-key-login": {
      "name": "Signed API-key login exchange",
      "guide": "protocol.html#api-key-session-login"
    },
    "device-code-box": {
      "name": "Device-code Box",
      "guide": "protocol.html#device-approval"
    },
    "sso-login-box": {
      "name": "Double-boxed SSO login",
      "guide": "protocol.html#enterprise-saml-and-oidc"
    }
  },
  "paths": {
    "/info/": {
      "get": {
        "operationId": "getServerInfo",
        "summary": "Get signed server information",
        "tags": [
          "Discovery"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#signed-server-information"
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the signed server configuration as a JSON-encoded `info` string with its signature and verification key. Call without an Authorization header.\n\nThe signed information includes the server version, API version, public key, enabled authentication methods, and edition (`type`: `CE` or `EE`). Additional configuration fields differ by release and edition.\n\n**Encryption:** [No session envelope](protocol.html#signed-server-information)",
        "responses": {
          "200": {
            "description": "Signed server information, in plaintext JSON.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignedServerInfo"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "$ref": "#/components/responses/PlainRateLimit"
          }
        }
      }
    },
    "/secret/": {
      "put": {
        "operationId": "createSecret",
        "summary": "Create secret",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-ee-note": "Enterprise policies can reject creation when the user has not configured a required second factor (HTTP 400).",
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/CreateSecretPayload"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/CreateSecretResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "security": [
          {
            "SessionToken": []
          }
        ],
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a vault-encrypted secret and links it to a parent datastore or\nshare. Requires a writable session and write permission on the parent.\nSupply **exactly one** of `parent_datastore_id` and `parent_share_id`.\n\nPsono uses **PUT** for creation on this endpoint.\n\n### Enterprise behavior\n\nEnterprise policies can reject creation when the user has not configured a required second factor (HTTP 400).\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `CreateSecretPayload`.\n\nExactly one parent ID is required. This is the JSON before session encryption; data is already vault-encrypted.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `data` | string | Yes | Vault-encrypted secret content; not a plaintext password-entry object. |\n| `data_nonce` | string | Yes | Nonce for vault-encrypted data. The serializer accepts at most 64 characters. Maximum length: 64. |\n| `link_id` | string (uuid) | Yes | New client-generated, unique link ID. |\n| `parent_datastore_id` | string (uuid) | No | Parent datastore ID. Required if parent_share_id is absent. |\n| `parent_share_id` | string (uuid) | No | Parent share ID. Required if parent_datastore_id is absent. |\n| `callback_url` | string | No | Optional callback URL; empty disables the callback. Maximum length: 2048. Default: `\"\"`. |\n| `callback_user` | string | No | Optional callback authentication username. Maximum length: 128. Default: `\"\"`. |\n| `callback_pass` | string | No | Optional callback authentication password. Maximum length: 128. Default: `\"\"`. |\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"data\": \"aabbccdd\",\n  \"data_nonce\": \"000000000000000000000000000000000000000000000002\",\n  \"link_id\": \"22222222-2222-4222-8222-222222222222\",\n  \"parent_datastore_id\": \"33333333-3333-4333-8333-333333333333\"\n}\n```\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `CreateSecretResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `secret_id` | string (uuid) | Yes | ID of the newly created secret. |\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"secret_id\": \"11111111-1111-4111-8111-111111111111\"\n}\n```\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Session-encrypted result containing the new secret ID.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Session-encrypted validation error or duplicate nonce/link ID.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/SessionUnauthenticated"
          },
          "403": {
            "$ref": "#/components/responses/SessionForbidden"
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "$ref": "#/components/responses/SessionRateLimit"
          }
        }
      },
      "post": {
        "operationId": "postSecret",
        "summary": "Update secret",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateSecretRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiDatastorePostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a secret\n\nNecessary Rights:\n    - write on secret\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `WRITE_DATE_MISMATCH`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateSecretRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `secret_id` | string (uuid) | Yes | Secret id identifier. |\n| `data` | string | No | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | string | No | Hex-encoded nonce for the encrypted content, separate from the transport nonce. Maximum length: 64. |\n| `old_write_date` | string (date-time) | No | Expected previous write timestamp for optimistic concurrency control. |\n| `callback_url` | string | No | Callback URL; an empty value disables the callback. Maximum length: 2048. |\n| `callback_user` | string | No | Optional callback HTTP authentication username. Maximum length: 128. |\n| `callback_pass` | string | No | Optional callback HTTP authentication password. Maximum length: 128. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiDatastorePostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `success` | string | Yes | Success. |\n| `write_date` | string | Yes | Last write time in ISO 8601 format. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/secret.py",
          "view": "SecretView",
          "method": "post"
        }
      }
    },
    "/secret/{secret_id}/": {
      "get": {
        "operationId": "readSecret",
        "summary": "Get secret",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/ReadSecretResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "security": [
          {
            "SessionToken": []
          }
        ],
        "parameters": [
          {
            "name": "secret_id",
            "in": "path",
            "required": true,
            "description": "ID of the secret to read.",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "11111111-1111-4111-8111-111111111111"
          }
        ],
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nRequires a readable session and read permission on the secret. Send **no request body**; the ID is a path parameter. Reading increments the secret's read count.\n\nMissing secrets and missing access are reported as HTTP 400 validation\nerrors, rather than as HTTP 404.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `ReadSecretResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `create_date` | string (date-time) | Yes | Creation time (ISO 8601). |\n| `write_date` | string (date-time) | Yes | Last write time (ISO 8601). |\n| `data` | string | Yes | Vault ciphertext. Still encrypted after the session envelope is removed. |\n| `data_nonce` | string | Yes | Nonce for data; can be empty for secrets without one. |\n| `type` | string | Yes | Stored server-side secret type marker. |\n| `read_count` | integer | Yes | Read count including this read. |\n| `callback_url` | string | Yes | Configured callback URL, or empty. |\n| `callback_user` | string | Yes | Configured callback username, or empty. |\n| `callback_pass` | string | Yes | Callback password after database decryption, or empty. Protected by the session envelope. |\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"create_date\": \"2026-11-01T10:00:00Z\",\n  \"write_date\": \"2026-11-01T10:00:00Z\",\n  \"data\": \"aabbccdd\",\n  \"data_nonce\": \"000000000000000000000000000000000000000000000002\",\n  \"type\": \"password\",\n  \"read_count\": 3,\n  \"callback_url\": \"\",\n  \"callback_user\": \"\",\n  \"callback_pass\": \"\"\n}\n```\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "responses": {
          "200": {
            "description": "Session-encrypted secret metadata and vault ciphertext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Session-encrypted validation error, including NO_PERMISSION_OR_NOT_EXIST.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/SessionUnauthenticated"
          },
          "403": {
            "$ref": "#/components/responses/SessionForbidden"
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "$ref": "#/components/responses/SessionRateLimit"
          }
        }
      }
    },
    "/api-key-access/secret/": {
      "post": {
        "operationId": "readSecretWithApiKey",
        "summary": "Get secret using an API key",
        "tags": [
          "API key access"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#sessionless-api-key-access"
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nNo session or Token header is required. The API key must be active, permit\nreading, and be associated with the secret; its active owner must also\nretain read permission. Credentials are supplied in the JSON body.\n\n**Local decryption:** omit `api_key_secret_key` to receive vault ciphertext and a wrapped secret key.\n\n**Remote decryption:** supply `api_key_secret_key`, with `allow_insecure_access` enabled, to receive the stored JSON or the value selected by `json_filter`. Reading increments the read count in either mode.\n\n**Encryption:** [No session envelope](protocol.html#sessionless-api-key-access)",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiKeyReadRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Wrapped vault data in local mode; arbitrary secret JSON in remote mode.",
            "content": {
              "application/json": {
                "schema": {
                  "description": "The response shape depends on whether api_key_secret_key was supplied.",
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/ApiKeyEncryptedSecret"
                    },
                    {
                      "$ref": "#/components/schemas/RemoteDecryptedValue"
                    }
                  ]
                },
                "examples": {
                  "localDecryption": {
                    "summary": "Local-decryption response (illustrative ciphertext)",
                    "value": {
                      "data": "aabbccdd",
                      "data_nonce": "000000000000000000000000000000000000000000000001",
                      "secret_key": "eeff0011",
                      "secret_key_nonce": "000000000000000000000000000000000000000000000002",
                      "read_count": 3,
                      "write_date": "2026-11-01T10:00:00Z"
                    }
                  },
                  "remoteDecryption": {
                    "summary": "Example remote-decryption result (content varies)",
                    "value": {
                      "website_password_username": "example-user",
                      "website_password_password": "example-password"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Plaintext validation errors, e.g. NO_PERMISSION_OR_NOT_EXIST, INSECURE_ACCESS_NOT_ALLOWED, or API_KEY_SECRET_KEY_INVALID.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "$ref": "#/components/responses/PlainRateLimit"
          }
        }
      },
      "put": {
        "operationId": "putApiKeyAccessSecret",
        "summary": "Update secret using an API key",
        "tags": [
          "API key access"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#sessionless-api-key-access"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiUpdateSecretWithAPIKeyRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiAPIKeyAccessSecretPutResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a secret.\n\nValidation may return: `API_KEYS_DISABLED`, `API_KEY_SECRET_KEY_INVALID`, `API_KEY_SECRET_KEY_SPECIFIED_YET_INSECURE_DATA_NO_JSON`, `INSECURE_ACCESS_NOT_ALLOWED`, `IP_ADDRESS_NOT_ALLOWED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [No session envelope](protocol.html#sessionless-api-key-access)",
        "x-psono-source": {
          "file": "restapi/views/api_key_access_secret.py",
          "view": "APIKeyAccessSecretView",
          "method": "put"
        }
      }
    },
    "/scim/2.0/{scim_provider_id}/Schemas": {
      "get": {
        "operationId": "getScimSchemas",
        "summary": "List SCIM schemas",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "x-psono-encryption": {
          "profile": "none"
        },
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\n**Enterprise Edition only.** This route is registered only when SCIM\nprovisioning is configured. The provider ID must identify an entry in\n`SCIM_CONFIGURATIONS`. Use that provider's configured `TOKEN` as a Bearer\ncredential; a Psono session token is not interchangeable with it.\n\nReturns the supported User and Group schema definitions as a SCIM list\nresponse. There is no session encryption envelope. The path is\ncase-sensitive and has **no trailing slash**.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Positive integer key of the configured SCIM provider.",
            "schema": {
              "type": "integer",
              "minimum": 1
            },
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "SCIM User and Group schema definitions.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimSchemaList"
                }
              }
            }
          },
          "401": {
            "description": "Missing/invalid Bearer token or invalid provider ID. DRF authentication errors use a detail field.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "404": {
            "description": "Route not registered, for example because SCIM is not configured or the server is Community Edition."
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. No session envelope.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        }
      }
    },
    "/authentication/prelogin/": {
      "post": {
        "operationId": "postAuthenticationPrelogin",
        "summary": "Get login hashing parameters",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiPreLoginRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiPreLoginPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nWill return the hashing algorithm and configured paramters for a given user.\nWill return fake parameters if a user is not found to prevent username probing.\n\nValidation may return: `INVALID_USERNAME_FORMAT`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/prelogin.py",
          "view": "PreLoginView",
          "method": "post"
        }
      }
    },
    "/authentication/login/": {
      "post": {
        "operationId": "postAuthenticationLogin",
        "summary": "Sign in",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "login-box",
          "requestFieldPayloads": {
            "login_info": {
              "$ref": "#/components/schemas/LoginInfoPayload"
            }
          },
          "responseFieldPayloads": {
            "200": {
              "login_info": {
                "$ref": "#/components/schemas/PasswordLoginResultEnterprise"
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiLoginRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiLoginPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCheck the username and authkey and return the REST Token\nif the credentials are valid and authenticated.\n\nClients should later authenticate by passing the token key in the \"Authorization\"\nHTTP header, prepended with the string \"Token \". For example:\n\n    Authorization: Token 401f7ac837da42b97f613d789819ff93537bee6a\n\nValidation may return: `ACCOUNT_NOT_VERIFIED`, `AUTHKEY_REQUIRED`, `IP_ADDRESS_NOT_ALLOWED`, `LOGIN_INFO_CANNOT_BE_DECRYPTED`, `USERNAME_OR_PASSWORD_WRONG`, `USERNAME_REQUIRED`, `USER_DISABLED_ASK_ADMIN_TO_ENABLE`.\n\n**Encryption:** [Public-key login exchange](protocol.html#password-login)\n\n### JSON inside request field `login_info`\n\nSchema: `LoginInfoPayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `username` | string | Yes | Account username. |\n| `authkey` | string | Yes | Derived authentication key. |\n| `password` | string | No | Optional password for password-backed authentication such as LDAP. |\n| `client_type` | string | No | Client category used when bounding session duration. Default: `\"webclient\"`. |\n| `device_fingerprint` | string | No | Client device/session fingerprint. |\n| `device_description` | string | No | Client device description. |\n| `device_time` | string (date-time) | No | Client time used for replay protection. |\n\n### Decrypted response field `login_info` · HTTP 200\n\nSchema: `PasswordLoginResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `token` | string | Yes | Authentication token returned by the indicated exchange. |\n| `session_key` | string | Yes | Session identifier/key distinct from the symmetric session encryption key. |\n| `session_valid_till` | string | Yes | Session valid till. |\n| `required_multifactors` | array | Yes | Required multifactors. |\n| `session_public_key` | string | Yes | Session public key. |\n| `session_secret_key` | string | Yes | Session encryption key, encrypted/wrapped in login exchanges as described by the protocol. |\n| `session_secret_key_nonce` | string | Yes | Hex-encoded nonce for session secret key. |\n| `user_validator` | string | Yes | Encrypted user-validator challenge used for token activation. |\n| `user_validator_nonce` | string | Yes | Hex-encoded nonce for user validator. |\n| `user` | object | Yes | User. |",
        "x-psono-source": {
          "file": "restapi/views/login.py",
          "view": "LoginView",
          "method": "post"
        }
      }
    },
    "/authentication/logout/": {
      "post": {
        "operationId": "postAuthenticationLogout",
        "summary": "Sign out",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiLogoutRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiLogoutPostResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete the current used token object.\n\nAccepts/Returns nothing.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiLogoutRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `session_id` | string | No | Session id identifier. |\n| `post_logout_redirect_uri` | string,null | No | Post logout redirect uri. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiLogoutPostResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `success` | string | Yes | Success. |\n| `redirect_url` | string | No | Redirect url. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/logout.py",
          "view": "LogoutView",
          "method": "post"
        }
      }
    },
    "/authentication/ga-verify/": {
      "post": {
        "operationId": "postAuthenticationGaVerify",
        "summary": "Verify authenticator code",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiGAVerifyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a Google Authenticator based OATH-TOTP\n\nAccepts the inactive session token returned by login. Complete the required multifactor challenges before activating the token.\n\nValidation may return: `GA_TOKENS_ONLY_CONTAIN_DIGITS`, `GA_TOKEN_INCORRECT`, `NO_GOOGLE_AUTHENTICATOR_FOUND`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiGAVerifyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ga_token` | string | Yes | Current one-time code from the configured authenticator. Maximum length: 6. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/ga_verify.py",
          "view": "GAVerifyView",
          "method": "post"
        }
      }
    },
    "/authentication/duo-verify/": {
      "post": {
        "operationId": "postAuthenticationDuoVerify",
        "summary": "Verify Duo challenge",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDuoVerifyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a Duo Token (if provided) or returns once the push message on the phone has been confirmed\n\nAccepts the inactive session token returned by login. Complete the required multifactor challenges before activating the token.\n\nValidation may return: `DUO_HOST_NOT_ALLOWED`, `NO_DUO_FOUND`, `VALIDATION_FAILED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDuoVerifyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `duo_token` | string | No | Duo token. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/duo_verify.py",
          "view": "DuoVerifyView",
          "method": "post"
        }
      }
    },
    "/authentication/webauthn-verify/": {
      "post": {
        "operationId": "postAuthenticationWebauthnVerify",
        "summary": "Verify WebAuthn challenge",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiWebauthnVerifyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a Webauthn (if provided) or returns once the push message on the phone has been confirmed\n\nAccepts the inactive session token returned by login. Complete the required multifactor challenges before activating the token.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiWebauthnVerifyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `credential` | string | Yes | Credential. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/webauthn_verify.py",
          "view": "WebauthnVerifyView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAuthenticationWebauthnVerify",
        "summary": "Start WebAuthn challenge",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiWebauthnVerifyInitRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiWebauthnVerifyPutResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nStart WebAuthn challenge.\n\nAccepts the inactive session token returned by login. Complete the required multifactor challenges before activating the token.\n\nValidation may return: `INVALID_ORIGIN`, `NO_PERMISSION_OR_NOT_EXIST`, `PROTOCOL_NOT_SUPPORTED`, `RP_ID_NOT_ALLOWED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiWebauthnVerifyInitRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `origin` | string | Yes | Origin. Maximum length: 512. |\n| `rp_id` | string | No | Rp id identifier. Maximum length: 253. |\n| `legacy` | boolean | No | Legacy. Default: `false`. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiWebauthnVerifyPutResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `options` | object | Yes | Options. |\n| `legacy_available` | boolean | Yes | Legacy available. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/webauthn_verify.py",
          "view": "WebauthnVerifyView",
          "method": "put"
        }
      }
    },
    "/authentication/yubikey-otp-verify/": {
      "post": {
        "operationId": "postAuthenticationYubikeyOtpVerify",
        "summary": "Verify YubiKey OTP challenge",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiYubikeyOTPVerifyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a Yubikey OTP\n\nAccepts the inactive session token returned by login. Complete the required multifactor challenges before activating the token.\n\nValidation may return: `NO_YUBIKEY_FOUND`, `SERVER_NOT_SUPPORT_YUBIKEY`, `YUBICO_TOKEN_INVALID`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiYubikeyOTPVerifyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `yubikey_otp` | string | Yes | One-time password produced by the YubiKey. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/yubikey_otp_verify.py",
          "view": "YubikeyOTPVerifyView",
          "method": "post"
        }
      }
    },
    "/authentication/ivalt-verify/": {
      "post": {
        "operationId": "postAuthenticationIvaltVerify",
        "summary": "Verify iVALT challenge",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiIvaltVerifyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a Ivalt 2fa based on mobile auth validation\n\nAccepts the inactive session token returned by login. Complete the required multifactor challenges before activating the token.\n\nValidation may return: `AUTHENTICATION_FAILED`, `INVALID_VALUE_FOR_REQUEST_TYPE`, `NO_IVALT_2FA_FOUND`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiIvaltVerifyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `request_type` | string | Yes | Request type. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/ivalt_verify.py",
          "view": "IvaltVerifyView",
          "method": "post"
        }
      }
    },
    "/authentication/activate-token/": {
      "post": {
        "operationId": "postAuthenticationActivateToken",
        "summary": "Activate session token",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "guide": "protocol.html#password-login",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiActivateTokenRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiActivateTokenPostResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nActivates a token and advertises the default hashing profile for new\ncredentials, independently of the user's current credential profile.\n\nAccepts the inactive session token returned by login. Complete the required multifactor challenges before activating the token.\n\nValidation may return: `DUO_CHALLENGE_UNSOLVED`, `GA_CHALLENGE_UNSOLVED`, `IVALT_CHALLENGE_UNSOLVED`, `TOKEN_INCORRECT`, `VERIFICATION_CODE_INCORRECT`, `WEBAUTHN_CHALLENGE_UNSOLVED`, `YUBIKEY_CHALLENGE_UNSOLVED`.\n\n**Encryption:** [Session SecretBox](protocol.html#password-login)\n\n### Payload before transport encryption\n\nSchema: `RestapiActivateTokenRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `verification` | string | Yes | Encrypted proof of possession of the user validator. |\n| `verification_nonce` | string | Yes | Hex-encoded nonce for verification. Maximum length: 64. |\n| `zoneinfo` | string,null | No | Zoneinfo. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiActivateTokenPostResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `default_hashing_algorithm` | string | Yes | Default hashing algorithm. |\n| `default_hashing_parameters` | object | Yes | Default hashing parameters. |\n| `user` | object | Yes | User. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/activate_token.py",
          "view": "ActivateTokenView",
          "method": "post"
        }
      }
    },
    "/authentication/sessions/": {
      "get": {
        "operationId": "getAuthenticationSessions",
        "summary": "List active sessions",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiSessionGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nLists all active sessions\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiSessionGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `sessions` | array | Yes | Sessions. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/session.py",
          "view": "SessionView",
          "method": "get"
        }
      }
    },
    "/authentication/register/": {
      "post": {
        "operationId": "postAuthenticationRegister",
        "summary": "Register account",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiRegisterRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiRegisterPostResult201"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nAccepts the username, email and authkey and creates a new user\nif the username (and email address) do not already exist\n\nValidation may return: `EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER`, `INVALID_HASHING_PARAMETER`, `PROVIDED_DOMAIN_NOT_ALLOWED_FOR_REGISTRATION`, `USERNAME_ALREADY_EXISTS`, `USERNAME_VALIDATION_NAME_CONTAINS_INVALID_CHARS`, `USER_WITH_EMAIL_ALREADY_EXISTS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/register.py",
          "view": "RegisterView",
          "method": "post"
        }
      }
    },
    "/authentication/unregister/": {
      "post": {
        "operationId": "postAuthenticationUnregister",
        "summary": "Request account deletion",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiCreateUnregisterRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nAccepts the email address or username and sends an email with a link that allows a user to delete his account\n\nValidation may return: `ACCOUNT_DELETION_DISABLED`, `EITHER_USERNAME_OR_EMAIL_NEED_TO_BE_DEFINED`, `EITHER_USERNAME_OR_EMAIL_NEED_TO_BE_DEFINED_NOT_BOTH`, `UNREGISTRATION_HAS_BEEN_DISABLED`, `USER_HAS_NO_EMAIL_ADDRESS_ASSOCIATED`, `USER_WITH_EMAIL_DOESNT_EXIST`, `USER_WITH_USERNAME_DOESNT_EXIST`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/unregister.py",
          "view": "UnregisterView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAuthenticationUnregister",
        "summary": "Confirm account deletion",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiUpdateUnregisterRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nAccepts a user's unregistration link, validates it and then deletes the account\n\nValidation may return: `ACCOUNT_DELETION_DISABLED`, `UNREGISTRATION_CODE_INCORRECT`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/unregister.py",
          "view": "UnregisterView",
          "method": "put"
        }
      }
    },
    "/authentication/verify-email/": {
      "post": {
        "operationId": "postAuthenticationVerifyEmail",
        "summary": "Verify email address",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiVerifyEmailRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiVerifyEmailPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nVerifies the activation code sent via email and updates the user\n\nValidation may return: `ACTIVATION_CODE_INCORRECT`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/verify_email.py",
          "view": "VerifyEmailView",
          "method": "post"
        }
      }
    },
    "/user/update/": {
      "put": {
        "operationId": "putUserUpdate",
        "summary": "Update account",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUserUpdateRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserUpdatePutResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and updates the users email / authkey / secret and private key\n\nValidation may return: `AUTHKEY_REQUIRED`, `CANNOT_REUSE_OLD_PASSWORD`, `INVALID_HASHING_PARAMETER`, `NO_VALID_HEX`, `OLD_PASSWORD_INCORRECT`, `USER_WITH_EMAIL_ALREADY_EXISTS`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUserUpdateRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `email` | string,null (email) | No | Email address. |\n| `authkey` | string,null | No | Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key. |\n| `authkey_old` | string,null | No | Authkey old. |\n| `private_key` | string,null | No | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string,null | No | Hex-encoded nonce for private key. Maximum length: 64. |\n| `secret_key` | string,null | No | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string,null | No | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `user_sauce` | string,null | No | User sauce. Maximum length: 64. |\n| `hashing_algorithm` | string | No | Hashing algorithm. |\n| `hashing_parameters` | object | No | Hashing parameters. |\n| `language` | string,null | No | Language. Maximum length: 16. |\n| `zoneinfo` | string,null | No | Zoneinfo. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserUpdatePutResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `success` | string | Yes | Success. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_update.py",
          "view": "UserUpdate",
          "method": "put"
        }
      }
    },
    "/user/upgrade-hashing/": {
      "put": {
        "operationId": "putUserUpgradeHashing",
        "summary": "Upgrade account hashing",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUserUpgradeHashingRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserUpgradeHashingPutResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpgrade the account's hashing parameters.\n\nValidation may return: `INVALID_HASHING_PARAMETER`, `INVALID_HASHING_UPGRADE`, `NO_VALID_HEX`, `OLD_PASSWORD_INCORRECT`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUserUpgradeHashingRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `authkey` | string | Yes | Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key. |\n| `authkey_old` | string | Yes | Authkey old. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 64. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `hashing_algorithm` | string | Yes | Hashing algorithm. |\n| `hashing_parameters` | object | Yes | Hashing parameters. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserUpgradeHashingPutResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `success` | string | Yes | Success. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_upgrade_hashing.py",
          "view": "UserUpgradeHashingView",
          "method": "put"
        }
      }
    },
    "/user/ga/": {
      "delete": {
        "operationId": "deleteUserGa",
        "summary": "Delete authenticator",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteGARequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Google Authenticator\n\nValidation may return: `ADD_OTHER_SECOND_FACTOR_BEFORE_DELETING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteGARequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `google_authenticator_id` | string (uuid) | Yes | Google authenticator id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_ga.py",
          "view": "UserGA",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getUserGa",
        "summary": "List authenticators",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserGAGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and returns a list of all google authenticators\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserGAGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `google_authenticators` | array | Yes | Google authenticators. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_ga.py",
          "view": "UserGA",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postUserGa",
        "summary": "Activate authenticator",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiActivateGARequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a Google authenticator and activates it\n\nValidation may return: `GA_TOKENS_ONLY_CONTAIN_DIGITS`, `GA_TOKEN_INCORRECT`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiActivateGARequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `google_authenticator_id` | string (uuid) | Yes | Google authenticator id identifier. |\n| `google_authenticator_token` | string | Yes | Google authenticator token. Maximum length: 6. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_ga.py",
          "view": "UserGA",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putUserGa",
        "summary": "Create authenticator",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiNewGARequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserGAPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and sets a new google authenticator for multifactor authentication\n\nValidation may return: `SERVER_NOT_SUPPORT_GA`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiNewGARequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserGAPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `secret` | string | Yes | Secret. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_ga.py",
          "view": "UserGA",
          "method": "put"
        }
      }
    },
    "/user/duo/": {
      "delete": {
        "operationId": "deleteUserDuo",
        "summary": "Delete Duo integration",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteDuoRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a duo\n\nValidation may return: `ADD_OTHER_SECOND_FACTOR_BEFORE_DELETING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteDuoRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `duo_id` | string (uuid) | Yes | Duo id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_duo.py",
          "view": "UserDuo",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getUserDuo",
        "summary": "List Duo integrations",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserDuoGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and returns a list of all duo\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserDuoGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `duos` | array | Yes | Duos. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_duo.py",
          "view": "UserDuo",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postUserDuo",
        "summary": "Activate Duo integration",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiActivateDuoRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a duo and activates it\n\nValidation may return: `DUO_ENROLLMENT_EXPIRED`, `DUO_HOST_NOT_ALLOWED`, `NO_PERMISSION_OR_NOT_EXIST`, `SCAN_THE_BARCODE_FIRST`, `VALIDATION_FAILED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiActivateDuoRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `duo_id` | string (uuid) | Yes | Duo id identifier. |\n| `duo_token` | string | No | Duo token. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_duo.py",
          "view": "UserDuo",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putUserDuo",
        "summary": "Create Duo integration",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiNewDuoRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserDuoPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and sets a new duo for multifactor authentication\n\nValidation may return: `DUO_HOST_NOT_ALLOWED`, `ONLY_ONE_DUO_DEVICE_ALLOWED`, `SERVER_NOT_SUPPORT_DUO`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiNewDuoRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `use_system_wide_duo` | boolean | No | Use system wide duo. Default: `false`. |\n| `title` | string | No | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `integration_key` | string | No | Integration key. Maximum length: 32. |\n| `secret_key` | string | No | Symmetric key material, wrapped/encrypted as specified by this operation. Maximum length: 128. |\n| `host` | string | No | Host. Maximum length: 32. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserDuoPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `activation_code` | string | Yes | Activation code. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_duo.py",
          "view": "UserDuo",
          "method": "put"
        }
      }
    },
    "/user/webauthn/": {
      "delete": {
        "operationId": "deleteUserWebauthn",
        "summary": "Delete WebAuthn credential",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteWebauthnRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a webauthn\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteWebauthnRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `webauthn_id` | string (uuid) | Yes | Webauthn id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_webauthn.py",
          "view": "UserWebauthn",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getUserWebauthn",
        "summary": "List WebAuthn credentials",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserWebauthnGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and returns a list of all webauthns\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserWebauthnGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `webauthns` | array | Yes | Webauthns. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_webauthn.py",
          "view": "UserWebauthn",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postUserWebauthn",
        "summary": "Activate WebAuthn credential",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiActivateWebauthnRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a webauthn and activates it\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiActivateWebauthnRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `webauthn_id` | string (uuid) | Yes | Webauthn id identifier. |\n| `credential` | string | Yes | Credential. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_webauthn.py",
          "view": "UserWebauthn",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putUserWebauthn",
        "summary": "Create WebAuthn credential",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiNewWebauthnRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserWebauthnPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and sets a new webauthn for multifactor authentication\n\nValidation may return: `INVALID_ORIGIN`, `PROTOCOL_NOT_SUPPORTED`, `RP_ID_NOT_ALLOWED`, `SERVER_NOT_SUPPORT_WEBAUTHN`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiNewWebauthnRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `origin` | string | Yes | Origin. Maximum length: 512. |\n| `rp_id` | string | No | Rp id identifier. Maximum length: 253. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserWebauthnPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `options` | object | Yes | Options. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_webauthn.py",
          "view": "UserWebauthn",
          "method": "put"
        }
      }
    },
    "/user/yubikey-otp/": {
      "delete": {
        "operationId": "deleteUserYubikeyOtp",
        "summary": "Delete YubiKey",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteYubikeyRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes an Yubikey\n\nValidation may return: `ADD_OTHER_SECOND_FACTOR_BEFORE_DELETING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteYubikeyRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `yubikey_otp_id` | string (uuid) | Yes | Yubikey otp id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_yubikey_otp.py",
          "view": "UserYubikeyOTP",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getUserYubikeyOtp",
        "summary": "List YubiKeys",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and returns a list of all YubiKey OTPs\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserYubikeyOTPGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `yubikey_otps` | array | Yes | Yubikey otps. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_yubikey_otp.py",
          "view": "UserYubikeyOTP",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postUserYubikeyOtp",
        "summary": "Activate YubiKey",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiActivateYubikeyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nValidates a yubikey and activates it\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SERVER_DOES_NOT_SUPPORT_YUBIKEYS`, `YUBIKEY_OTP_INCORRECT`, `YUBIKEY_OTP_NOT_ATTACHED_TO_THIS_ACCOUNT`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiActivateYubikeyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `yubikey_id` | string (uuid) | Yes | Yubikey id identifier. |\n| `yubikey_otp` | string | Yes | One-time password produced by the YubiKey. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_yubikey_otp.py",
          "view": "UserYubikeyOTP",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putUserYubikeyOtp",
        "summary": "Create YubiKey",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiNewYubikeyOTPRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and sets a new YubiKey OTP for multifactor authentication\n\nValidation may return: `SERVER_NOT_SUPPORT_YUBIKEY`, `YUBICO_TOKEN_INVALID`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiNewYubikeyOTPRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `yubikey_otp` | string | Yes | One-time password produced by the YubiKey. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_yubikey_otp.py",
          "view": "UserYubikeyOTP",
          "method": "put"
        }
      }
    },
    "/user/ivalt/": {
      "delete": {
        "operationId": "deleteUserIvalt",
        "summary": "Delete iVALT integration",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteIvaltRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes an Ivalt 2FA\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteIvaltRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ivalt_id` | string (uuid) | Yes | Ivalt id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_ivalt.py",
          "view": "UserIvalt",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getUserIvalt",
        "summary": "List iVALT integrations",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserIvaltGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nLists all Ivalt mobile numbers\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserIvaltGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ivalt` | array | Yes | Ivalt. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_ivalt.py",
          "view": "UserIvalt",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postUserIvalt",
        "summary": "Activate iVALT integration",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserIvaltPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nsets a new ivalt 2FA\n\nValidation may return: `AUTHENTICATION_FAILED`, `IVALT_SECRET_KEY_NOT_EXIST`, `NO_PERMISSION_OR_NOT_EXIST`, `SERVER_NOT_SUPPORT_IVALT`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserIvaltPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `message` | string | Yes | Message. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_ivalt.py",
          "view": "UserIvalt",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putUserIvalt",
        "summary": "Create iVALT integration",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateIvaltRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserIvaltPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nsets a new ivalt 2FA\n\nValidation may return: `AUTHENTICATION_FAILED`, `IVALT_SECRET_KEY_NOT_EXIST`, `ONLY_ONE_IVALT_MOBILE_ALLOWED`, `SERVER_NOT_SUPPORT_IVALT`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateIvaltRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `mobile` | string | Yes | Mobile. Maximum length: 256. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserIvaltPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `message` | string | Yes | Message. |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_ivalt.py",
          "view": "UserIvalt",
          "method": "put"
        }
      }
    },
    "/user/search/": {
      "post": {
        "operationId": "postUserSearch",
        "summary": "Search users",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUserSearchRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserSearchPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCheck the REST Token and returns the user's public key. To identify the user either the email or the user_id needs\nto be provided\n\nReturn the user's public key\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUserSearchRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | No | User id identifier. |\n| `user_username` | string | No | User username. |\n| `user_email` | string | No | User email. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserSearchPostResult200`.\n\n\n\nArray items: see the schema model.\n\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_search.py",
          "view": "UserSearch",
          "method": "post"
        }
      }
    },
    "/user/policy/": {
      "get": {
        "operationId": "getUserPolicy",
        "summary": "Get effective account policies",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiUserPolicyGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns all the applied user policies\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiUserPolicyGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `policies` | object | Yes | Policies. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_policy.py",
          "view": "UserPolicyView",
          "method": "get"
        }
      }
    },
    "/user/delete/": {
      "delete": {
        "operationId": "deleteUserDelete",
        "summary": "Delete account",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUserDeleteRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nChecks the REST Token and deletes the current user\n\nValidation may return: `ACCOUNT_DELETION_DISABLED`, `PASSWORD_INCORRECT`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUserDeleteRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `authkey` | string | Yes | Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key. |\n| `password` | string | No | Password value for the operation; password and authkey are different credentials. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/user_delete.py",
          "view": "UserDelete",
          "method": "delete"
        }
      }
    },
    "/user/security-report/": {
      "post": {
        "operationId": "postUserSecurityReport",
        "summary": "Submit security report",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateSecurityReportRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a new security report\n\nValidation may return: `CENTRAL_SECURITY_REPORTS_DISABLED`, `PASSWORD_INCORRECT`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateSecurityReportRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `entries` | array | Yes | Entries. |\n| `check_haveibeenpwned` | boolean | Yes | Check haveibeenpwned. |\n| `authkey` | string | Yes | Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/security_report.py",
          "view": "SecurityReportView",
          "method": "post"
        }
      }
    },
    "/user/status/": {
      "get": {
        "operationId": "getUserStatus",
        "summary": "Get account status",
        "tags": [
          "Account and multifactor"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiStatusGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the user status, e.g. unapproved shares and so on\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiStatusGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `unaccepted_shares_count` | integer | Yes | Unaccepted shares count. |\n| `unaccepted_groups_count` | integer | Yes | Unaccepted groups count. |\n| `unaccepted_forced_groups_count` | integer | Yes | Unaccepted forced groups count. |\n| `last_security_report_created` | string | Yes | Last security report created. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/status.py",
          "view": "StatusView",
          "method": "get"
        }
      }
    },
    "/avatar-image/{user_id}/{avatar_id}/": {
      "get": {
        "operationId": "getAvatarImageByUserIdByAvatarId",
        "summary": "Get avatar image",
        "tags": [
          "Avatars"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "description": "User id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "avatar_id",
            "in": "path",
            "required": true,
            "description": "Avatar id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "image/*": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiAvatarImageGetResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nGet avatar image.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/avatar_image.py",
          "view": "AvatarImageView",
          "method": "get"
        }
      }
    },
    "/avatar/": {
      "delete": {
        "operationId": "deleteAvatar",
        "summary": "Delete avatar",
        "tags": [
          "Avatars"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteAvatarRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes an avatar\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteAvatarRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `avatar_id` | string (uuid) | Yes | Avatar id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/avatar.py",
          "view": "AvatarView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAvatar",
        "summary": "List avatars",
        "tags": [
          "Avatars"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiAvatarGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the avatar of a user\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiAvatarGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `avatars` | array | Yes | Avatars. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/avatar.py",
          "view": "AvatarView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAvatar",
        "summary": "Upload avatar",
        "tags": [
          "Avatars"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateAvatarRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiAvatarPostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a new avatar (and potentially deletes any existing ones)\n\nValidation may return: `DATA_NO_IMAGE`, `DIMENSIONS_EXCEEDED`, `INVALID_BASE64`, `SIZE_EXCEEDED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateAvatarRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `data_base64` | string | Yes | Data base64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiAvatarPostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/avatar.py",
          "view": "AvatarView",
          "method": "post"
        }
      }
    },
    "/session-key/": {
      "get": {
        "operationId": "getSessionKey",
        "summary": "Get session key",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiSessionKeyGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the session key for the current session\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiSessionKeyGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `session_key` | string | Yes | Session identifier/key distinct from the symmetric session encryption key. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/session_key.py",
          "view": "SessionKeyView",
          "method": "get"
        }
      }
    },
    "/password/": {
      "post": {
        "operationId": "postPassword",
        "summary": "Start password recovery",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#recovery-and-emergency-exchanges"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiEnableNewPasswordRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiPasswordPostResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nFirst step of the password reset with a recovery code\n\nValidation may return: `PASSWORD_RESET_HAS_BEEN_DISABLED`, `RECOVERY_CODES_DISABLED`, `USERNAME_OR_RECOVERY_CODE_INCORRECT`.\n\n**Encryption:** [No session envelope](protocol.html#recovery-and-emergency-exchanges)",
        "x-psono-source": {
          "file": "restapi/views/password.py",
          "view": "PasswordView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putPassword",
        "summary": "Complete password recovery",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#recovery-and-emergency-exchanges",
          "requestFieldPayloads": {
            "update_data": {
              "$ref": "#/components/schemas/RecoveryUpdatePayload"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiSetNewPasswordRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nSecond step of the recovery code password reset.\nValidates the code and sets the new password.\n\nValidation may return: `INVALID_HASHING_PARAMETER`, `NO_VALID_HEX`, `RECOVERY_CODES_DISABLED`, `USERNAME_OR_RECOVERY_CODE_INCORRECT`, `VALIDATOR_EXPIRED`.\n\nSubmit before the verifier expires. Success replaces the wrapped user keys, clears the password-change requirement, disables the stored authentication factors listed by the implementation, and invalidates existing sessions.\n\n**Encryption:** [No session envelope](protocol.html#recovery-and-emergency-exchanges)\n\n### JSON inside request field `update_data`\n\nSchema: `RecoveryUpdatePayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `authkey` | string | Yes | Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. |",
        "x-psono-source": {
          "file": "restapi/views/password.py",
          "view": "PasswordView",
          "method": "put"
        }
      }
    },
    "/recoverycode/": {
      "post": {
        "operationId": "postRecoverycode",
        "summary": "Create recovery code",
        "tags": [
          "Recovery and emergency access"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateRecoverycodeRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiRecoveryCodePostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreate recovery code.\n\nValidation may return: `NO_VALID_HEX`, `RECOVERY_CODES_DISABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateRecoverycodeRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `recovery_authkey` | string | Yes | Recovery authkey. |\n| `recovery_data` | string | Yes | Recovery data. |\n| `recovery_data_nonce` | string | Yes | Hex-encoded nonce for recovery data. Maximum length: 64. |\n| `recovery_sauce` | string | Yes | Recovery sauce. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiRecoveryCodePostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `recovery_code_id` | string | Yes | Recovery code id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/recoverycode.py",
          "view": "RecoveryCodeView",
          "method": "post"
        }
      }
    },
    "/emergencycode/": {
      "delete": {
        "operationId": "deleteEmergencycode",
        "summary": "Delete emergency code",
        "tags": [
          "Recovery and emergency access"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteEmergencycodeRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes an Emergency Code\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteEmergencycodeRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `emergency_code_id` | string (uuid) | Yes | Emergency code id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/emergencycode.py",
          "view": "EmergencyCodeView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getEmergencycode",
        "summary": "List emergency codes",
        "tags": [
          "Recovery and emergency access"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiEmergencyCodeGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the list of emergency codes of the user\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiEmergencyCodeGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `emegency_codes` | array | Yes | Emegency codes. |\n| `default_hashing_algorithm` | string | Yes | Default hashing algorithm. |\n| `default_hashing_parameters` | object | Yes | Default hashing parameters. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/emergencycode.py",
          "view": "EmergencyCodeView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postEmergencycode",
        "summary": "Create emergency code",
        "tags": [
          "Recovery and emergency access"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateEmergencycodeRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiEmergencyCodePostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nStores a new emergency code\n\nValidation may return: `ACTIVATION_DELAY_NEEDS_TO_BE_A_POSITIVE_INTEGER`, `EMERGENCY_CODES_DISABLED`, `NO_VALID_HEX`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateEmergencycodeRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `description` | string | Yes | Human-readable description. |\n| `activation_delay` | integer | Yes | Activation delay. |\n| `emergency_authkey` | string | Yes | Emergency authkey. |\n| `emergency_data` | string | Yes | Emergency data. |\n| `emergency_data_nonce` | string | Yes | Hex-encoded nonce for emergency data. Maximum length: 64. |\n| `emergency_sauce` | string | Yes | Emergency sauce. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiEmergencyCodePostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `emergency_code_id` | string | Yes | Emergency code id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/emergencycode.py",
          "view": "EmergencyCodeView",
          "method": "post"
        }
      }
    },
    "/emergency-login/": {
      "post": {
        "operationId": "postEmergencyLogin",
        "summary": "Start emergency login",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#recovery-and-emergency-exchanges"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiEmergencyLoginRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiEmergencyLoginPostResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nFirst step of the login with an emergency code\n\nValidation may return: `USERNAME_OR_EMERGENCY_CODE_INCORRECT`.\n\n**Encryption:** [No session envelope](protocol.html#recovery-and-emergency-exchanges)",
        "x-psono-source": {
          "file": "restapi/views/emergency_login.py",
          "view": "EmergencyLoginView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putEmergencyLogin",
        "summary": "Complete emergency login",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#recovery-and-emergency-exchanges",
          "requestFieldPayloads": {
            "update_data": {
              "$ref": "#/components/schemas/EmergencyUpdatePayload"
            }
          },
          "responseFieldPayloads": {
            "200": {
              "login_info": {
                "$ref": "#/components/schemas/EmergencyLoginResult"
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiActivateEmergencyLoginRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiLoginPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nSecond step of the login with emergency code.\nValidates the code and returns an active session.\n\nValidation may return: `EMAIL_NOT_YET_VERIFIED`, `NO_VALID_HEX`, `USERNAME_OR_EMERGENCY_CODE_INCORRECT`, `USERNAME_OR_RECOVERY_CODE_INCORRECT`, `USER_ACCOUNT_IS_DISABLED`, `VALIDATOR_EXPIRED`, `VALIDATOR_FAILED`.\n\nThe returned emergency session is active.\n\n**Encryption:** [No session envelope](protocol.html#recovery-and-emergency-exchanges)\n\n### JSON inside request field `update_data`\n\nSchema: `EmergencyUpdatePayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `session_public_key` | string | Yes | Temporary client public key in hex. |\n| `device_fingerprint` | string | No | Client device/session fingerprint. |\n| `device_description` | string | No | Client device description. |\n| `device_time` | string (date-time) | No | Client time used for replay protection. |\n\n### Decrypted response field `login_info` · HTTP 200\n\nSchema: `EmergencyLoginResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `token` | string | Yes | Authentication token returned by the indicated exchange. |\n| `session_valid_till` | string | Yes | Session valid till. |\n| `session_secret_key` | string | Yes | Session encryption key, encrypted/wrapped in login exchanges as described by the protocol. |\n| `user_public_key` | string | Yes | User public key. |\n| `user_email` | JSON | Yes | User email. |\n| `user_id` | string | Yes | User id identifier. |\n| `hashing_algorithm` | string | Yes | Hashing algorithm. |\n| `hashing_parameters` | object | Yes | Hashing parameters. |\n| `default_hashing_algorithm` | string | Yes | Default hashing algorithm. |\n| `default_hashing_parameters` | object | Yes | Default hashing parameters. |",
        "x-psono-source": {
          "file": "restapi/views/emergency_login.py",
          "view": "EmergencyLoginView",
          "method": "put"
        }
      }
    },
    "/api-key-access/inspect/": {
      "post": {
        "operationId": "postApiKeyAccessInspect",
        "summary": "Inspect API key access",
        "tags": [
          "API key access"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#sessionless-api-key-access"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiReadAPIKeyInspectRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "text/html": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiAPIKeyAccessInspectPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "text/html": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns all ids of available secrets\n\nValidation may return: `API_KEYS_DISABLED`, `IP_ADDRESS_NOT_ALLOWED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [No session envelope](protocol.html#sessionless-api-key-access)",
        "x-psono-source": {
          "file": "restapi/views/api_key_access_inspect.py",
          "view": "APIKeyAccessInspectView",
          "method": "post"
        }
      }
    },
    "/api-key/secret/{api_key_id}/": {
      "get": {
        "operationId": "getApiKeySecretByApiKeyId",
        "summary": "List secrets assigned to an API key",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiAPIKeySecretGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "api_key_id",
            "in": "path",
            "required": true,
            "description": "Api key id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all api key secrets of an API key\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiAPIKeySecretGetResult200`.\n\n\n\nArray items: see the schema model.\n\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/api_key_secret.py",
          "view": "APIKeySecretView",
          "method": "get"
        }
      }
    },
    "/api-key/secret/": {
      "delete": {
        "operationId": "deleteApiKeySecret",
        "summary": "Remove secret from an API key",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiRemoveSecretFromAPIKeyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nRemoves a secret from an api_key\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiRemoveSecretFromAPIKeyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `api_key_secret_id` | string (uuid) | Yes | Api key secret id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/api_key_secret.py",
          "view": "APIKeySecretView",
          "method": "delete"
        }
      },
      "put": {
        "operationId": "putApiKeySecret",
        "summary": "Add secret to an API key",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiAddSecretToAPIKeyRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiAPIKeySecretPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nAdds a secret to an api_key\n\nValidation may return: `API_KEYS_DISABLED`, `API_KEY_SECRET_ALREADY_EXIST`, `NO_PERMISSION_OR_NOT_EXIST`, `NO_VALID_HEX`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiAddSecretToAPIKeyRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `api_key_id` | string (uuid) | Yes | Api key id identifier. |\n| `secret_id` | string (uuid) | Yes | Secret id identifier. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. |\n| `title_nonce` | string | Yes | Hex-encoded nonce for title. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiAPIKeySecretPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `api_key_secret_id` | string | Yes | Api key secret id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/api_key_secret.py",
          "view": "APIKeySecretView",
          "method": "put"
        }
      }
    },
    "/api-key/login/": {
      "post": {
        "operationId": "postApiKeyLogin",
        "summary": "Sign in using an API key",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "api-key-login",
          "requestFieldPayloads": {
            "info": {
              "$ref": "#/components/schemas/ApiKeySignedInfo"
            }
          },
          "responseFieldPayloads": {
            "200": {
              "login_info": {
                "$ref": "#/components/schemas/ApiKeyLoginResultEnterprise"
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiAPIKeyLoginRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiAPIKeyLoginPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCheck the api key and return the REST Token if its valid.\n\nClients should later authenticate by passing the token key in the \"Authorization\"\nHTTP header, prepended with the string \"Token \". For example:\n\n    Authorization: Token 401f7ac837da42b97f613d789819ff93537bee6a\n\nValidation may return: `API_KEYS_DISABLED`, `API_KEY_RESTRICTED_TO_SECRETS`, `IP_ADDRESS_NOT_ALLOWED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\nRestricted-to-secrets API keys cannot establish a session. The returned session token is already active.\n\n**Encryption:** [Signed API-key login exchange](protocol.html#api-key-session-login)\n\n### JSON inside request field `info`\n\nSchema: `ApiKeySignedInfo`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `api_key_id` | string (uuid) | Yes | Api key id identifier. |\n| `session_public_key` | string | Yes | Temporary Curve25519 public key in hex. |\n| `session_duration` | integer | No | Requested session lifetime in seconds, bounded by server/client-type configuration. |\n| `device_fingerprint` | string | No | Client device/session fingerprint. |\n| `device_description` | string | No | Client device description. |\n| `device_time` | string (date-time) | No | Client time used for replay protection. |\n\n### Decrypted response field `login_info` · HTTP 200\n\nSchema: `ApiKeyLoginResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `token` | string | Yes | Authentication token returned by the indicated exchange. |\n| `session_valid_till` | string | Yes | Session valid till. |\n| `session_secret_key` | string | Yes | Session encryption key, encrypted/wrapped in login exchanges as described by the protocol. |\n| `api_key_restrict_to_secrets` | boolean | Yes | Api key restrict to secrets. |\n| `api_key_allow_insecure_access` | boolean | Yes | Api key allow insecure access. |\n| `api_key_allow_api_key_management` | boolean | Yes | Api key allow api key management. |\n| `api_key_allow_admin_access` | boolean | Yes | Api key allow admin access. |\n| `api_key_allow_recovery_access` | boolean | Yes | Api key allow recovery access. |\n| `api_key_allow_emergency_access` | boolean | Yes | Api key allow emergency access. |\n| `api_key_read` | boolean | Yes | Api key read. |\n| `api_key_write` | boolean | Yes | Api key write. |\n| `user` | object | Yes | User. |",
        "x-psono-source": {
          "file": "restapi/views/api_key_login.py",
          "view": "APIKeyLoginView",
          "method": "post"
        }
      }
    },
    "/api-key/{api_key_id}/": {
      "get": {
        "operationId": "getApiKeyByApiKeyId",
        "summary": "Get API key",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getApiKeyByApiKeyIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "api_key_id",
            "in": "path",
            "required": true,
            "description": "Api key id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns either a list of all api_keys with own access privileges or the members specified api_key\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getApiKeyByApiKeyIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. |\n| `read` | boolean | Yes | Whether read access is granted. |\n| `write` | boolean | Yes | Whether write access is granted. |\n| `restrict_to_secrets` | boolean | Yes | Restrict to secrets. |\n| `allow_insecure_access` | boolean | Yes | Allow insecure access. |\n| `allow_api_key_management` | boolean | Yes | Allow api key management. |\n| `allow_admin_access` | boolean | Yes | Allow admin access. |\n| `allow_recovery_access` | boolean | Yes | Allow recovery access. |\n| `allow_emergency_access` | boolean | Yes | Allow emergency access. |\n| `active` | boolean | Yes | Whether the resource or account is active. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/api_key.py",
          "view": "APIKeyView",
          "method": "get"
        }
      }
    },
    "/api-key/": {
      "delete": {
        "operationId": "deleteApiKey",
        "summary": "Delete API key",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteAPIKeyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes an api_key\n\nValidation may return: `API_KEY_DOES_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteAPIKeyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `api_key_id` | string (uuid) | Yes | Api key id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/api_key.py",
          "view": "APIKeyView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getApiKey",
        "summary": "List API keys",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getApiKeyResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns either a list of all api_keys with own access privileges or the members specified api_key\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getApiKeyResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `api_keys` | array | Yes | Api keys. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/api_key.py",
          "view": "APIKeyView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postApiKey",
        "summary": "Update API key",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateAPIKeyRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a api_key\n\nValidation may return: `API_KEYS_DISABLED`, `NOTHING_TO_UPDATE`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateAPIKeyRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `api_key_id` | string (uuid) | Yes | Api key id identifier. |\n| `title` | string | No | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `read` | boolean,null | No | Whether read access is granted. |\n| `write` | boolean,null | No | Whether write access is granted. |\n| `restrict_to_secrets` | boolean,null | No | Restrict to secrets. |\n| `allow_insecure_access` | boolean,null | No | Allow insecure access. |\n| `allow_api_key_management` | boolean,null | No | Allow api key management. |\n| `allow_admin_access` | boolean,null | No | Allow admin access. |\n| `allow_recovery_access` | boolean,null | No | Allow recovery access. |\n| `allow_emergency_access` | boolean,null | No | Allow emergency access. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/api_key.py",
          "view": "APIKeyView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putApiKey",
        "summary": "Create API key",
        "tags": [
          "API key management"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateAPIKeyRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiAPIKeyPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates an api_key\n\nValidation may return: `API_KEYS_DISABLED`, `NO_VALID_HEX`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateAPIKeyRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `read` | boolean | No | Whether read access is granted. Default: `true`. |\n| `write` | boolean | No | Whether write access is granted. Default: `false`. |\n| `restrict_to_secrets` | boolean | No | Restrict to secrets. Default: `false`. |\n| `allow_insecure_access` | boolean | No | Allow insecure access. Default: `false`. |\n| `allow_api_key_management` | boolean | No | Allow api key management. Default: `false`. |\n| `allow_admin_access` | boolean | No | Allow admin access. Default: `false`. |\n| `allow_recovery_access` | boolean | No | Allow recovery access. Default: `false`. |\n| `allow_emergency_access` | boolean | No | Allow emergency access. Default: `false`. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 64. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `user_private_key` | string | Yes | User private key. |\n| `user_private_key_nonce` | string | Yes | Hex-encoded nonce for user private key. Maximum length: 64. |\n| `user_secret_key` | string | Yes | User secret key. |\n| `user_secret_key_nonce` | string | Yes | Hex-encoded nonce for user secret key. Maximum length: 64. |\n| `verify_key` | string | Yes | Verify key. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiAPIKeyPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `api_key_id` | string | Yes | Api key id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/api_key.py",
          "view": "APIKeyView",
          "method": "put"
        }
      }
    },
    "/link-share-access/": {
      "post": {
        "operationId": "postLinkShareAccess",
        "summary": "Get link-shared content",
        "tags": [
          "Link sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiReadLinkShareAccessRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiLinkShareAccessPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUse a link share to access a secret.\n\nValidation may return: `EITHER_SECRET_OR_FILE_REQUIRED`, `INSUFFICIENT_FUNDS`, `LINK_SHARES_HAVE_BEEN_DISABLED`, `NO_FILESERVER_AVAILABLE`, `NO_PERMISSION_OR_NOT_EXIST`, `PASSPHRASE_REQUIRED`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/link_share_access.py",
          "view": "LinkShareAccessView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putLinkShareAccess",
        "summary": "Update link-shared content",
        "tags": [
          "Link sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiUpdateLinkShareAccessRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUse a link share to update a secret.\n\nValidation may return: `EITHER_SECRET_OR_FILE_REQUIRED`, `INSUFFICIENT_FUNDS`, `NO_FILESERVER_AVAILABLE`, `NO_PERMISSION_OR_NOT_EXIST`, `PASSPHRASE_REQUIRED`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/link_share_access.py",
          "view": "LinkShareAccessView",
          "method": "put"
        }
      }
    },
    "/link-share/{link_share_id}/": {
      "get": {
        "operationId": "getLinkShareByLinkShareId",
        "summary": "Get link share",
        "tags": [
          "Link sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getLinkShareByLinkShareIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "link_share_id",
            "in": "path",
            "required": true,
            "description": "Link share id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns either a list of all link_shares with own access privileges or the members specified link_share\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getLinkShareByLinkShareIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `secret_id` | string | Yes | Secret id identifier. |\n| `public_title` | string | Yes | Public title. |\n| `allowed_reads` | integer | Yes | Allowed reads. |\n| `valid_till` | string,null (date-time) | Yes | Expiration time in ISO 8601 format. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/link_share.py",
          "view": "LinkShareView",
          "method": "get"
        }
      }
    },
    "/link-share/": {
      "delete": {
        "operationId": "deleteLinkShare",
        "summary": "Delete link share",
        "tags": [
          "Link sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteLinkShareRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes an link_share\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteLinkShareRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_share_id` | string (uuid) | Yes | Link share id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/link_share.py",
          "view": "LinkShareView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getLinkShare",
        "summary": "List link shares",
        "tags": [
          "Link sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getLinkShareResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns either a list of all link_shares with own access privileges or the members specified link_share\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getLinkShareResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_shares` | array | Yes | Link shares. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/link_share.py",
          "view": "LinkShareView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postLinkShare",
        "summary": "Update link share",
        "tags": [
          "Link sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateLinkShareRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a link_share\n\nValidation may return: `LINK_SHARES_HAVE_BEEN_DISABLED`, `NO_PERMISSION_OR_NOT_EXIST`, `VALID_TILL_CANNOT_BE_IN_THE_PAST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateLinkShareRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_share_id` | string (uuid) | Yes | Link share id identifier. |\n| `public_title` | string | Yes | Public title. |\n| `allowed_reads` | integer,null | No | Allowed reads. |\n| `passphrase` | string,null | No | Passphrase. |\n| `valid_till` | string,null (date-time) | No | Expiration time in ISO 8601 format. |\n| `allow_write` | boolean,null | No | Allow write. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/link_share.py",
          "view": "LinkShareView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putLinkShare",
        "summary": "Create link share",
        "tags": [
          "Link sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateLinkShareRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiLinkSharePutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a link_share\n\nValidation may return: `EITHER_SECRET_OR_FILE_REQUIRED`, `EITHER_SECRET_OR_FILE_REQUIRED_NOT_BOTH`, `LINK_SHARES_HAVE_BEEN_DISABLED`, `NO_PERMISSION_OR_NOT_EXIST`, `VALID_TILL_CANNOT_BE_IN_THE_PAST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateLinkShareRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `secret_id` | string (uuid) | No | Secret id identifier. |\n| `file_id` | string (uuid) | No | File id identifier. |\n| `node` | string | Yes | Node. |\n| `node_nonce` | string | Yes | Hex-encoded nonce for node. Maximum length: 64. |\n| `public_title` | string | Yes | Public title. Maximum length: 256. |\n| `allowed_reads` | integer,null | No | Allowed reads. |\n| `passphrase` | string,null | No | Passphrase. |\n| `valid_till` | string,null (date-time) | No | Expiration time in ISO 8601 format. |\n| `allow_write` | boolean | No | Allow write. Default: `false`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiLinkSharePutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_share_id` | string | Yes | Link share id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/link_share.py",
          "view": "LinkShareView",
          "method": "put"
        }
      }
    },
    "/datastore/": {
      "delete": {
        "operationId": "deleteDatastore",
        "summary": "Delete datastore",
        "tags": [
          "Datastores"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteDatastoreRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes an Datastore\n\nValidation may return: `CANNOT_DELETE_DEFAULT_DATASTORE`, `DATASTORE_DOES_NOT_EXIST`, `PASSWORD_INCORRECT`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteDatastoreRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `datastore_id` | string (uuid) | Yes | Datastore id identifier. |\n| `authkey` | string | Yes | Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/datastore.py",
          "view": "DatastoreView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getDatastore",
        "summary": "List datastores",
        "tags": [
          "Datastores"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getDatastoreResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nLists all datastores of the user or returns a specific datastore with content\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getDatastoreResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `datastores` | array | Yes | Datastores. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/datastore.py",
          "view": "DatastoreView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postDatastore",
        "summary": "Update datastore",
        "tags": [
          "Datastores"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateDatastoreRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiDatastorePostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a specific datastore\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `WRITE_DATE_MISMATCH`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateDatastoreRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `datastore_id` | string (uuid) | Yes | Datastore id identifier. |\n| `name` | string | No | Display name. Maximum length: 64. |\n| `data` | string | No | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | string | No | Hex-encoded nonce for the encrypted content, separate from the transport nonce. Maximum length: 64. |\n| `secret_key` | string | No | Symmetric key material, wrapped/encrypted as specified by this operation. Maximum length: 256. |\n| `secret_key_nonce` | string | No | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `description` | string | No | Human-readable description. Maximum length: 64. |\n| `is_default` | boolean | No | Is default. |\n| `old_write_date` | string (date-time) | No | Expected previous write timestamp for optimistic concurrency control. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiDatastorePostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `success` | string | Yes | Success. |\n| `write_date` | string | Yes | Last write time in ISO 8601 format. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/datastore.py",
          "view": "DatastoreView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putDatastore",
        "summary": "Create datastore",
        "tags": [
          "Datastores"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateDatastoreRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiDatastorePutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a new datastore\n\nValidation may return: `MULTIPLE_PASSWORD_DATASTORES_DISABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateDatastoreRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `type` | string | Yes | Type. Maximum length: 64. |\n| `description` | string | Yes | Human-readable description. Maximum length: 64. |\n| `data` | string | No | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | string | No | Hex-encoded nonce for the encrypted content, separate from the transport nonce. Maximum length: 64. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. Maximum length: 256. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `is_default` | boolean | No | Is default. Default: `true`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiDatastorePutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `datastore_id` | string | Yes | Datastore id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/datastore.py",
          "view": "DatastoreView",
          "method": "put"
        }
      }
    },
    "/datastore/{datastore_id}/": {
      "get": {
        "operationId": "getDatastoreByDatastoreId",
        "summary": "Get datastore",
        "tags": [
          "Datastores"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getDatastoreByDatastoreIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "datastore_id",
            "in": "path",
            "required": true,
            "description": "Datastore id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nLists all datastores of the user or returns a specific datastore with content\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getDatastoreByDatastoreIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `data` | string | Yes | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | one of the documented alternatives | Yes | Hex-encoded nonce for the encrypted content, separate from the transport nonce. |\n| `type` | string | Yes | Type. |\n| `description` | string | Yes | Human-readable description. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. |\n| `is_default` | boolean | Yes | Is default. |\n| `write_date` | string | Yes | Last write time in ISO 8601 format. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/datastore.py",
          "view": "DatastoreView",
          "method": "get"
        }
      }
    },
    "/file/link/": {
      "delete": {
        "operationId": "deleteFileLink",
        "summary": "Delete file link",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteFileLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete File_Link obj\n\nNecessary Rights:\n    - write on parent_share\n    - write on parent_datastore\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteFileLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_link.py",
          "view": "FileLinkView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postFileLink",
        "summary": "Move file link",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiMoveFileLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nMove File_Link obj\n\nNecessary Rights:\n    - write on old_parent_share\n    - write on old_datastore\n    - write on new_parent_share\n    - write on new_datastore\n\nValidation may return: `NO_PARENT_PROVIDED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiMoveFileLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n| `new_parent_share_id` | string (uuid) | No | New parent share id identifier. |\n| `new_parent_datastore_id` | string (uuid) | No | New parent datastore id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_link.py",
          "view": "FileLinkView",
          "method": "post"
        }
      }
    },
    "/file/": {
      "delete": {
        "operationId": "deleteFile",
        "summary": "Delete file",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteFileRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiFileDeleteResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a file synchronously, including cloud storage cleanup.\nFor file repository files, deletes all chunks from cloud storage immediately.\nFor shard files, uses soft delete (sets delete_date).\nOnly works for files attached to secrets (not file_link files).\n\nValidation may return: `FILE_NOT_ATTACHED_TO_SECRET`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteFileRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_id` | string (uuid) | Yes | File id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiFileDeleteResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `success` | boolean | Yes | Success. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file.py",
          "view": "FileView",
          "method": "delete"
        }
      },
      "put": {
        "operationId": "putFile",
        "summary": "Create file",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateFileRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiFilePutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nIndirectly creates a file by providing a filetransfer id for upload\n\nCan create two types of files:\n1. Standalone file with File_Link (traditional)\n2. Secret attachment file without File_Link\n\nValidation may return: `EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED`, `EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED_NOT_BOTH`, `EITHER_PARENT_SECRET_OR_LINK_NEED_TO_BE_DEFINED`, `EITHER_PARENT_SECRET_OR_LINK_NOT_BOTH`, `INSUFFICIENT_FUNDS`, `NO_FILESERVER_AVAILABLE`, `NO_PERMISSION_OR_NOT_EXIST`, `SELECT_EITHER_SHARD_OR_REPOSITORY`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateFileRequest`.\n\nSupply exactly one parent: parent_datastore_id or parent_share_id.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shard_id` | string (uuid) | No | Shard id identifier. |\n| `file_repository_id` | string (uuid) | No | File repository id identifier. |\n| `chunk_count` | integer | Yes | Chunk count. |\n| `size` | integer | No | Size. |\n| `link_id` | string (uuid) | No | Client-generated unique link UUID. |\n| `parent_share_id` | string (uuid) | No | Parent share UUID. Where a parent datastore is also supported, supply exactly one parent. |\n| `parent_datastore_id` | string (uuid) | No | Parent datastore UUID. Where a parent share is also supported, supply exactly one parent. |\n| `parent_secret_id` | string (uuid) | No | Parent secret id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiFilePutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_id` | string | Yes | File id identifier. |\n| `file_transfer_id` | string | Yes | File transfer id identifier. |\n| `file_transfer_secret_key` | string | Yes | File transfer secret key. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file.py",
          "view": "FileView",
          "method": "put"
        }
      }
    },
    "/file/{file_id}/": {
      "get": {
        "operationId": "getFileByFileId",
        "summary": "Start file download",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiFileGetResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "file_id",
            "in": "path",
            "required": true,
            "description": "File id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nIndirectly reads a file by providing a filetransfer id for download\n\nValidation may return: `INSUFFICIENT_FUNDS`, `NO_FILESERVER_AVAILABLE`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiFileGetResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_transfer_id` | string | Yes | File transfer id identifier. |\n| `file_transfer_secret_key` | string | Yes | File transfer secret key. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file.py",
          "view": "FileView",
          "method": "get"
        }
      }
    },
    "/shard/": {
      "get": {
        "operationId": "getShard",
        "summary": "List available shards",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/ShardListResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nList available shards.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `ShardListResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shards` | array | Yes | Shards. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/shard.py",
          "view": "ShardView",
          "method": "get"
        }
      }
    },
    "/file-repository-right/accept/": {
      "post": {
        "operationId": "postFileRepositoryRightAccept",
        "summary": "Accept file-repository invitation",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiFileRepositoryRightAcceptRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nMarks a FileRepositoryRight as accepted.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiFileRepositoryRightAcceptRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repository_right_id` | string (uuid) | Yes | File repository right id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository_right_accept.py",
          "view": "FileRepositoryRightAcceptView",
          "method": "post"
        }
      }
    },
    "/file-repository-right/decline/": {
      "post": {
        "operationId": "postFileRepositoryRightDecline",
        "summary": "Decline file-repository invitation",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiFileRepositoryRightAcceptRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nIt deletes a users own FileRepositoryRight.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiFileRepositoryRightAcceptRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repository_right_id` | string (uuid) | Yes | File repository right id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository_right_decline.py",
          "view": "FileRepositoryRightDeclineView",
          "method": "post"
        }
      }
    },
    "/file-repository-right/": {
      "delete": {
        "operationId": "deleteFileRepositoryRight",
        "summary": "Delete file repository right",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiFileRepositoryRightAcceptRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a file repository right\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiFileRepositoryRightAcceptRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repository_right_id` | string (uuid) | Yes | File repository right id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository_right.py",
          "view": "FileRepositoryRightView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postFileRepositoryRight",
        "summary": "Update file repository right",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateFileRepositoryRightRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a file repository right\n\nValidation may return: `FILE_REPOSITORIES_HAVE_BEEN_DISABLED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateFileRepositoryRightRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repository_right_id` | string (uuid) | Yes | File repository right id identifier. |\n| `read` | boolean | No | Whether read access is granted. Default: `true`. |\n| `write` | boolean | No | Whether write access is granted. Default: `true`. |\n| `grant` | boolean | No | Whether the recipient may grant access to others. Default: `false`. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository_right.py",
          "view": "FileRepositoryRightView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putFileRepositoryRight",
        "summary": "Create file repository right",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateFileRepositoryRightRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiFileRepositoryRightPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a new file repository right\n\nValidation may return: `FILE_REPOSITORIES_HAVE_BEEN_DISABLED`, `NO_PERMISSION_OR_NOT_EXIST`, `USER_DOES_NOT_EXIST`, `USER_HAS_ALREADY_RIGHTS_FOR_FILE_REPOSITORY`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateFileRepositoryRightRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `file_repository_id` | string (uuid) | Yes | File repository id identifier. |\n| `read` | boolean | No | Whether read access is granted. Default: `true`. |\n| `write` | boolean | No | Whether write access is granted. Default: `true`. |\n| `grant` | boolean | No | Whether the recipient may grant access to others. Default: `false`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiFileRepositoryRightPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repository_right_id` | string | Yes | File repository right id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository_right.py",
          "view": "FileRepositoryRightView",
          "method": "put"
        }
      }
    },
    "/group-file-repository-right/": {
      "delete": {
        "operationId": "deleteGroupFileRepositoryRight",
        "summary": "Delete group file repository right",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteGroupFileRepositoryRightRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a group file repository right\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteGroupFileRepositoryRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_file_repository_right_id` | string (uuid) | Yes | Group file repository right id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group_file_repository_right.py",
          "view": "GroupFileRepositoryRightView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postGroupFileRepositoryRight",
        "summary": "Update group file repository right",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateGroupFileRepositoryRightRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a file repository right\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateGroupFileRepositoryRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_file_repository_right_id` | string (uuid) | Yes | Group file repository right id identifier. |\n| `read` | boolean | No | Whether read access is granted. Default: `true`. |\n| `write` | boolean | No | Whether write access is granted. Default: `true`. |\n| `grant` | boolean | No | Whether the recipient may grant access to others. Default: `false`. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group_file_repository_right.py",
          "view": "GroupFileRepositoryRightView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putGroupFileRepositoryRight",
        "summary": "Create group file repository right",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateGroupFileRepositoryRightRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGroupFileRepositoryRightPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a new group file repository right\n\nValidation may return: `GROUP_HAS_ALREADY_RIGHTS_FOR_FILE_REPOSITORY`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateGroupFileRepositoryRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `file_repository_id` | string (uuid) | Yes | File repository id identifier. |\n| `read` | boolean | No | Whether read access is granted. Default: `true`. |\n| `write` | boolean | No | Whether write access is granted. Default: `true`. |\n| `grant` | boolean | No | Whether the recipient may grant access to others. Default: `false`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGroupFileRepositoryRightPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_file_repository_right_id` | string | Yes | Group file repository right id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group_file_repository_right.py",
          "view": "GroupFileRepositoryRightView",
          "method": "put"
        }
      }
    },
    "/file-repository/download/": {
      "put": {
        "operationId": "putFileRepositoryDownload",
        "summary": "Get repository download URL",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "FileTransfer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "file-transfer-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiFileRepositoryDownloadRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiFileRepositoryDownloadPutResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a signed url for the download of a chunk\n\nValidation may return: `CHUNK_COUNT_EXCEEDED`, `CHUNK_SIZE_EXCEEDED`, `FILE_REPOSITORIES_HAVE_BEEN_DISABLED`, `FILE_TRANSFER_TYPE_INVALID`, `HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION`, `NO_PERMISSION_OR_NOT_EXIST`.\n\nProvider-specific credential fields are conditional on type. Supported types are gcp_cloud_storage, aws_s3, azure_blob, other_s3, backblaze, and do_spaces. Supply the matching bucket/container/space, region/endpoint, and credentials.\n\n**Encryption:** [File-transfer SecretBox](protocol.html#file-transfer-and-service-credentials)\n\n### Payload before transport encryption\n\nSchema: `RestapiFileRepositoryDownloadRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `hash_checksum` | string | Yes | Hash checksum. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiFileRepositoryDownloadPutResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `type` | string | Yes | Type. |\n| `url` | string | Yes | Url. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository_download.py",
          "view": "FileRepositoryDownloadView",
          "method": "put"
        }
      }
    },
    "/file-repository/upload/": {
      "put": {
        "operationId": "putFileRepositoryUpload",
        "summary": "Get repository upload URL",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "FileTransfer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "file-transfer-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiFileRepositoryUploadRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiFileRepositoryUploadPutResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nPrepares a chunk upload to a file repository\n\nValidation may return: `CHUNK_COUNT_EXCEEDED`, `CHUNK_SIZE_EXCEEDED`, `FILE_REPOSITORIES_HAVE_BEEN_DISABLED`, `FILE_TRANSFER_TYPE_INVALID`, `HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION`.\n\nProvider-specific credential fields are conditional on type. Supported types are gcp_cloud_storage, aws_s3, azure_blob, other_s3, backblaze, and do_spaces. Supply the matching bucket/container/space, region/endpoint, and credentials.\n\n**Encryption:** [File-transfer SecretBox](protocol.html#file-transfer-and-service-credentials)\n\n### Payload before transport encryption\n\nSchema: `RestapiFileRepositoryUploadRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `chunk_size` | integer | Yes | Chunk size. |\n| `chunk_position` | integer | Yes | Chunk position. |\n| `hash_checksum` | string | Yes | Hash checksum. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiFileRepositoryUploadPutResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `url` | string | Yes | Url. |\n| `fields` | object | Yes | Fields. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository_upload.py",
          "view": "FileRepositoryUploadView",
          "method": "put"
        }
      }
    },
    "/file-repository/{file_repository_id}/": {
      "get": {
        "operationId": "getFileRepositoryByFileRepositoryId",
        "summary": "Get file repository",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getFileRepositoryByFileRepositoryIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "file_repository_id",
            "in": "path",
            "required": true,
            "description": "File repository id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns either a list of all file_repositories with own access privileges or the members specified file_repository\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getFileRepositoryByFileRepositoryIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. |\n| `type` | string | Yes | Type. |\n| `active` | boolean | Yes | Whether the resource or account is active. |\n| `read` | boolean | Yes | Whether read access is granted. |\n| `write` | boolean | Yes | Whether write access is granted. |\n| `grant` | boolean | Yes | Whether the recipient may grant access to others. |\n| `file_repository_rights` | array | Yes | File repository rights. |\n| `group_file_repository_rights` | array | Yes | Group file repository rights. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository.py",
          "view": "FileRepositoryView",
          "method": "get"
        }
      }
    },
    "/file-repository/": {
      "delete": {
        "operationId": "deleteFileRepository",
        "summary": "Delete file repository",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteFileRepositoryRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes an file_repository\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteFileRepositoryRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repository_id` | string (uuid) | Yes | File repository id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository.py",
          "view": "FileRepositoryView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getFileRepository",
        "summary": "List file repositories",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getFileRepositoryResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns either a list of all file_repositories with own access privileges or the members specified file_repository\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getFileRepositoryResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repositories` | array | Yes | File repositories. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository.py",
          "view": "FileRepositoryView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postFileRepository",
        "summary": "Update file repository",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateFileRepositoryRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a file_repository\n\nValidation may return: `ACCESS_KEY_ID_IS_REQUIRED`, `ACCOUNT_NAME_IS_REQUIRED`, `BUCKET_IS_REQUIRED`, `CONTAINER_NAME_IS_REQUIRED`, `ENDPOINT_URL_NOT_ALLOWED`, `FILEREPOSITORY_TYPE_NOT_ALLOWED`, `FILE_REPOSITORIES_HAVE_BEEN_DISABLED`, `JSON_KEY_IS_INVALID`, `JSON_KEY_IS_REQUIRED`, `KEY_IS_REQUIRED`, `NO_PERMISSION_OR_NOT_EXIST`, `PRIMARY_KEY_IS_REQUIRED`, `REGION_IS_REQUIRED`, `SECRET_ACCESS_KEY_IS_REQUIRED`, `SECRET_IS_REQUIRED`, `SPACE_IS_REQUIRED`, `UNKNOWN_TYPE`, `URL_IS_REQUIRED`.\n\nProvider-specific credential fields are conditional on type. Supported types are gcp_cloud_storage, aws_s3, azure_blob, other_s3, backblaze, and do_spaces. Supply the matching bucket/container/space, region/endpoint, and credentials.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateFileRepositoryRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repository_id` | string (uuid) | Yes | File repository id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `type` | string | Yes | Type. Maximum length: 32. |\n| `gcp_cloud_storage_bucket` | string | No | Gcp cloud storage bucket. |\n| `gcp_cloud_storage_json_key` | string | No | Gcp cloud storage json key. |\n| `active` | boolean | Yes | Whether the resource or account is active. |\n| `aws_s3_bucket` | string | No | Aws s3 bucket. |\n| `aws_s3_region` | string | No | Aws s3 region. |\n| `aws_s3_access_key_id` | string | No | Aws s3 access key id identifier. |\n| `aws_s3_secret_access_key` | string | No | Aws s3 secret access key. |\n| `azure_blob_storage_account_name` | string | No | Azure blob storage account name. |\n| `azure_blob_storage_account_primary_key` | string | No | Azure blob storage account primary key. |\n| `azure_blob_storage_account_container_name` | string | No | Azure blob storage account container name. |\n| `other_s3_bucket` | string | No | Other s3 bucket. |\n| `other_s3_region` | string | No | Other s3 region. |\n| `other_s3_access_key_id` | string | No | Other s3 access key id identifier. |\n| `other_s3_secret_access_key` | string | No | Other s3 secret access key. |\n| `other_s3_endpoint_url` | string | No | Other s3 endpoint url. |\n| `backblaze_bucket` | string | No | Backblaze bucket. |\n| `backblaze_region` | string | No | Backblaze region. |\n| `backblaze_access_key_id` | string | No | Backblaze access key id identifier. |\n| `backblaze_secret_access_key` | string | No | Backblaze secret access key. |\n| `do_space` | string | No | Do space. |\n| `do_region` | string | No | Do region. |\n| `do_key` | string | No | Do key. |\n| `do_secret` | string | No | Do secret. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository.py",
          "view": "FileRepositoryView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putFileRepository",
        "summary": "Create file repository",
        "tags": [
          "Files and repositories"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateFileRepositoryRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiFileRepositoryPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates an file_repository\n\nValidation may return: `ACCESS_KEY_ID_IS_REQUIRED`, `ACCOUNT_NAME_IS_REQUIRED`, `BUCKET_IS_REQUIRED`, `CONTAINER_NAME_IS_REQUIRED`, `ENDPOINT_URL_NOT_ALLOWED`, `FILEREPOSITORY_TYPE_NOT_ALLOWED`, `FILE_REPOSITORIES_HAVE_BEEN_DISABLED`, `JSON_KEY_IS_INVALID`, `JSON_KEY_IS_REQUIRED`, `KEY_IS_REQUIRED`, `PRIMARY_KEY_IS_REQUIRED`, `REGION_IS_REQUIRED`, `SECRET_ACCESS_KEY_IS_REQUIRED`, `SECRET_IS_REQUIRED`, `SPACE_IS_REQUIRED`, `UNKNOWN_TYPE`, `URL_IS_REQUIRED`.\n\nProvider-specific credential fields are conditional on type. Supported types are gcp_cloud_storage, aws_s3, azure_blob, other_s3, backblaze, and do_spaces. Supply the matching bucket/container/space, region/endpoint, and credentials.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateFileRepositoryRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `type` | string | Yes | Type. Maximum length: 32. |\n| `gcp_cloud_storage_bucket` | string | No | Gcp cloud storage bucket. |\n| `gcp_cloud_storage_json_key` | string | No | Gcp cloud storage json key. |\n| `aws_s3_bucket` | string | No | Aws s3 bucket. |\n| `aws_s3_region` | string | No | Aws s3 region. |\n| `aws_s3_access_key_id` | string | No | Aws s3 access key id identifier. |\n| `aws_s3_secret_access_key` | string | No | Aws s3 secret access key. |\n| `azure_blob_storage_account_name` | string | No | Azure blob storage account name. |\n| `azure_blob_storage_account_primary_key` | string | No | Azure blob storage account primary key. |\n| `azure_blob_storage_account_container_name` | string | No | Azure blob storage account container name. |\n| `other_s3_bucket` | string | No | Other s3 bucket. |\n| `other_s3_region` | string | No | Other s3 region. |\n| `other_s3_access_key_id` | string | No | Other s3 access key id identifier. |\n| `other_s3_secret_access_key` | string | No | Other s3 secret access key. |\n| `other_s3_endpoint_url` | string | No | Other s3 endpoint url. |\n| `backblaze_bucket` | string | No | Backblaze bucket. |\n| `backblaze_region` | string | No | Backblaze region. |\n| `backblaze_access_key_id` | string | No | Backblaze access key id identifier. |\n| `backblaze_secret_access_key` | string | No | Backblaze secret access key. |\n| `do_space` | string | No | Do space. |\n| `do_region` | string | No | Do region. |\n| `do_key` | string | No | Do key. |\n| `do_secret` | string | No | Do secret. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiFileRepositoryPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_repository_id` | string | Yes | File repository id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/file_repository.py",
          "view": "FileRepositoryView",
          "method": "put"
        }
      }
    },
    "/bulk-secret/link/": {
      "delete": {
        "operationId": "deleteBulkSecretLink",
        "summary": "Delete multiple secret links",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiBulkDeleteSecretLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nBulk Delete Secret_Link obj\n\nNecessary Rights:\n    - write on parent_share\n    - write on parent_datastore\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiBulkDeleteSecretLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_ids` | array | Yes | Link ids. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/bulk_secret_link.py",
          "view": "BulkSecretLinkView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postBulkSecretLink",
        "summary": "Move multiple secret links",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiBulkMoveSecretLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nMove Secret_Link obj\n\nNecessary Rights:\n    - write on old_parent_share\n    - write on old_datastore\n    - write on new_parent_share\n    - write on new_datastore\n\nValidation may return: `NO_PARENT_PROVIDED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiBulkMoveSecretLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_ids` | array | Yes | Link ids. |\n| `new_parent_share_id` | string (uuid) | No | New parent share id identifier. |\n| `new_parent_datastore_id` | string (uuid) | No | New parent datastore id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/bulk_secret_link.py",
          "view": "BulkSecretLinkView",
          "method": "post"
        }
      }
    },
    "/secret/link/": {
      "delete": {
        "operationId": "deleteSecretLink",
        "summary": "Delete secret link",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteSecretLinkRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete Secret_Link obj\n\nNecessary Rights:\n    - write on parent_share\n    - write on parent_datastore\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteSecretLinkRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n| `log_audit_title` | string | No | Log audit title. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/secret_link.py",
          "view": "SecretLinkView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postSecretLink",
        "summary": "Move secret link",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiMoveFileLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nMove Secret_Link obj\n\nNecessary Rights:\n    - write on old_parent_share\n    - write on old_datastore\n    - write on new_parent_share\n    - write on new_datastore\n\nValidation may return: `NO_PARENT_PROVIDED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiMoveFileLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n| `new_parent_share_id` | string (uuid) | No | New parent share id identifier. |\n| `new_parent_datastore_id` | string (uuid) | No | New parent datastore id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/secret_link.py",
          "view": "SecretLinkView",
          "method": "post"
        }
      }
    },
    "/bulk-secret/": {
      "put": {
        "operationId": "putBulkSecret",
        "summary": "Create multiple secrets",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiBulkCreateSecretRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiBulkSecretPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates multiple secrets and the corresponding links in the datastore or share\n\nNecessary Rights:\n    - write on parent_share\n    - write on parent_datastore\n\nValidation may return: `EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED`, `EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED_NOT_BOTH`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiBulkCreateSecretRequest`.\n\nSupply exactly one parent: parent_datastore_id or parent_share_id.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `secrets` | array | Yes | Secrets. |\n| `parent_share_id` | string (uuid) | No | Parent share UUID. Where a parent datastore is also supported, supply exactly one parent. |\n| `parent_datastore_id` | string (uuid) | No | Parent datastore UUID. Where a parent share is also supported, supply exactly one parent. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiBulkSecretPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `secrets` | array | Yes | Secrets. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/bulk_secret.py",
          "view": "BulkSecretView",
          "method": "put"
        }
      }
    },
    "/bulk-secret-read/": {
      "post": {
        "operationId": "postBulkSecretRead",
        "summary": "Get multiple secrets",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiBulkReadSecretRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiBulkSecretReadPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nLists multiple secrets\n\nNecessary Rights:\n    - read on secret\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiBulkReadSecretRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `secret_ids` | array | Yes | Secret ids. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiBulkSecretReadPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `secrets` | array | Yes | Secrets. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/bulk_secret_read.py",
          "view": "BulkSecretReadView",
          "method": "post"
        }
      }
    },
    "/secret/history/{secret_id}/": {
      "get": {
        "operationId": "getSecretHistoryBySecretId",
        "summary": "List secret history",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiSecretHistoryGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "secret_id",
            "in": "path",
            "required": true,
            "description": "Secret id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nLists the history of a specific secret\n\nNecessary Rights:\n    - read on secret\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SECRET_ID_BADLY_FORMED`, `SECRET_ID_NOT_PROVIDED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiSecretHistoryGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `history` | array | Yes | History. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/secret_history.py",
          "view": "SecretHistoryView",
          "method": "get"
        }
      }
    },
    "/history/{secret_history_id}/": {
      "get": {
        "operationId": "getHistoryBySecretHistoryId",
        "summary": "Get secret history entry",
        "tags": [
          "Secrets"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiHistoryGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "secret_history_id",
            "in": "path",
            "required": true,
            "description": "Secret history id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a specific history item\n\nNecessary Rights:\n    - read on secret\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SECRET_HISTORY_ID_BADLY_FORMED`, `SECRET_HISTORY_ID_NOT_PROVIDED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiHistoryGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `create_date` | string | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string | Yes | Last write time in ISO 8601 format. |\n| `data` | string | Yes | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | one of the documented alternatives | Yes | Hex-encoded nonce for the encrypted content, separate from the transport nonce. |\n| `type` | string | Yes | Type. |\n| `callback_url` | string | Yes | Callback URL; an empty value disables the callback. |\n| `callback_user` | string | Yes | Optional callback HTTP authentication username. |\n| `callback_pass` | string | Yes | Optional callback HTTP authentication password. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/history.py",
          "view": "HistoryView",
          "method": "get"
        }
      }
    },
    "/share/rights/{share_id}/": {
      "get": {
        "operationId": "getShareRightsByShareId",
        "summary": "Get access rights for a share",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiShareRightsGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "share_id",
            "in": "path",
            "required": true,
            "description": "Share id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns all share rights of a specified share. Including the share rights of other people as long as the user\nwho requests it has the \"grant\" right, and is allowed to see them.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SHARE_ID_MALFORMED`, `SHARE_ID_NOT_PROVIDED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiShareRightsGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `own_share_rights` | object | Yes | Own share rights. |\n| `user_share_rights` | array | Yes | User share rights. |\n| `group_share_rights` | array | Yes | Group share rights. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_rights.py",
          "view": "ShareRightsView",
          "method": "get"
        }
      }
    },
    "/share/right/accept/": {
      "post": {
        "operationId": "postShareRightAccept",
        "summary": "Accept share invitation",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiShareRightAcceptRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiShareRightAcceptPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nMark a Share_right as accepted. In addition update the share right with the new encryption key\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiShareRightAcceptRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `share_right_id` | string (uuid) | Yes | Share right id identifier. |\n| `key` | string | No | Wrapped encryption key for the recipient, as indicated by key_type. Maximum length: 256. |\n| `key_type` | string | No | Key-wrapping method used for the key value. Maximum length: 256. Default: `\"symmetric\"`. |\n| `key_nonce` | string | No | Hex-encoded nonce for key. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiShareRightAcceptPostResult200`.\n\n\n\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_right_accept.py",
          "view": "ShareRightAcceptView",
          "method": "post"
        }
      }
    },
    "/share/right/decline/": {
      "post": {
        "operationId": "postShareRightDecline",
        "summary": "Decline share invitation",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiShareRightDeclineRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nMark a Share_right as declined. In addition deletes now unnecessary information like title and encryption key.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiShareRightDeclineRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `share_right_id` | string (uuid) | Yes | Share right id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_right_decline.py",
          "view": "ShareRightDeclineView",
          "method": "post"
        }
      }
    },
    "/share/right/": {
      "delete": {
        "operationId": "deleteShareRight",
        "summary": "Delete share right",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteShareRightRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete a Share_Right obj\n\nNecessary Rights:\n    - grant on share\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteShareRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_share_right_id` | string (uuid) | No | User share right id identifier. |\n| `group_share_right_id` | string (uuid) | No | Group share right id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_right.py",
          "view": "ShareRightView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getShareRight",
        "summary": "List share rights",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/ShareRightOverview"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a specific Share_Right or a list of all the Share_Rights of the user who requested it\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `USER_SHARE_RIGHT_ID_MALFORMED`, `USER_SHARE_RIGHT_ID_NOT_PROVIDED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `ShareRightOverview`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `share_rights` | array | Yes | Share rights. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_right.py",
          "view": "ShareRightView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postShareRight",
        "summary": "Update share right",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateShareRightRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiShareRightPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdate Share_Right\n\nNecessary Rights:\n    - grant on share\n\nValidation may return: `EXPIRATION_DATE_NEEDS_TO_BE_IN_THE_FUTURE`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateShareRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `share_id` | string (uuid) | Yes | Share id identifier. |\n| `user_id` | string (uuid) | No | User id identifier. |\n| `group_id` | string (uuid) | No | Group id identifier. |\n| `read` | boolean | Yes | Whether read access is granted. |\n| `write` | boolean | Yes | Whether write access is granted. |\n| `grant` | boolean | Yes | Whether the recipient may grant access to others. |\n| `expiration_date` | string,null (date-time) | No | Expiration date. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiShareRightPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `share_right_id` | string | Yes | Share right id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_right.py",
          "view": "ShareRightView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putShareRight",
        "summary": "Create share right",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateShareRightRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiShareRightPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreate Share_Right\n\nNecessary Rights:\n    - grant on share\n\nValidation may return: `EXPIRATION_DATE_NEEDS_TO_BE_IN_THE_FUTURE`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateShareRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `key` | string | Yes | Wrapped encryption key for the recipient, as indicated by key_type. Maximum length: 256. |\n| `key_nonce` | string | Yes | Hex-encoded nonce for key. Maximum length: 64. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 512. |\n| `title_nonce` | string | Yes | Hex-encoded nonce for title. Maximum length: 64. |\n| `type` | string | Yes | Type. Maximum length: 512. |\n| `type_nonce` | string | Yes | Hex-encoded nonce for type. Maximum length: 64. |\n| `share_id` | string (uuid) | Yes | Share id identifier. |\n| `user_id` | string (uuid) | No | User id identifier. |\n| `group_id` | string (uuid) | No | Group id identifier. |\n| `read` | boolean | Yes | Whether read access is granted. |\n| `write` | boolean | Yes | Whether write access is granted. |\n| `grant` | boolean | Yes | Whether the recipient may grant access to others. |\n| `expiration_date` | string,null (date-time) | No | Expiration date. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiShareRightPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `share_right_id` | string | Yes | Share right id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_right.py",
          "view": "ShareRightView",
          "method": "put"
        }
      }
    },
    "/share/right/{user_share_right_id}/": {
      "get": {
        "operationId": "getShareRightByUserShareRightId",
        "summary": "Get share right",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiShareRightGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "user_share_right_id",
            "in": "path",
            "required": true,
            "description": "User share right id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a specific Share_Right or a list of all the Share_Rights of the user who requested it\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `USER_SHARE_RIGHT_ID_MALFORMED`, `USER_SHARE_RIGHT_ID_NOT_PROVIDED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiShareRightGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. |\n| `title_nonce` | string | Yes | Hex-encoded nonce for title. |\n| `key` | string | Yes | Wrapped encryption key for the recipient, as indicated by key_type. |\n| `key_nonce` | string | Yes | Hex-encoded nonce for key. |\n| `read` | boolean | Yes | Whether read access is granted. |\n| `write` | boolean | Yes | Whether write access is granted. |\n| `grant` | boolean | Yes | Whether the recipient may grant access to others. |\n| `share_id` | string | Yes | Share id identifier. |\n| `expiration_date` | one of the documented alternatives | Yes | Expiration date. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_right.py",
          "view": "ShareRightView",
          "method": "get"
        }
      }
    },
    "/share/link/": {
      "delete": {
        "operationId": "deleteShareLink",
        "summary": "Delete share link",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteFileLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete share link in share tree\n\nNecessary Rights:\n    - write on parent_share\n    - write on datastore\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteFileLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_link.py",
          "view": "ShareLinkView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postShareLink",
        "summary": "Move share link",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateShareLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdate share link in share tree\n\nNecessary Rights:\n    - grant on share\n    - write on old_parent_share\n    - write on old_datastore\n    - write on new_parent_share\n    - write on new_datastore\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateShareLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n| `new_parent_share_id` | string (uuid) | No | New parent share id identifier. |\n| `new_parent_datastore_id` | string (uuid) | No | New parent datastore id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_link.py",
          "view": "ShareLinkView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putShareLink",
        "summary": "Create share link",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateShareLinkRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nInsert share link in share tree\n\nNecessary Rights:\n    - grant on share\n    - write on parent_share\n\nValidation may return: `EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED`, `EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED_NOT_BOTH`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateShareLinkRequest`.\n\nSupply exactly one parent: parent_datastore_id or parent_share_id.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n| `share_id` | string (uuid) | Yes | Share id identifier. |\n| `parent_share_id` | string (uuid) | No | Parent share UUID. Where a parent datastore is also supported, supply exactly one parent. |\n| `parent_datastore_id` | string (uuid) | No | Parent datastore UUID. Where a parent share is also supported, supply exactly one parent. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share_link.py",
          "view": "ShareLinkView",
          "method": "put"
        }
      }
    },
    "/share/": {
      "get": {
        "operationId": "getShare",
        "summary": "List shares",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getShareResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all shares with all own share rights on that share or\nreturns a share with all rights existing on the share\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SHARE_ID_MALFORMED`, `SHARE_ID_NOT_PROVIDED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getShareResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shares` | array | Yes | Shares. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share.py",
          "view": "ShareView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postShare",
        "summary": "Create share",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateShareRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiSharePostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a new share\n\nNecessary Rights:\n    - write on new_parent_share\n    - write on new_parent_datastore\n\nValidation may return: `EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED`, `NO_PERMISSION_OR_NOT_EXIST`, `SHARING_HAS_BEEN_DISABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateShareRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n| `data` | string | Yes | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | string | Yes | Hex-encoded nonce for the encrypted content, separate from the transport nonce. Maximum length: 64. |\n| `parent_share_id` | string (uuid) | No | Parent share UUID. Where a parent datastore is also supported, supply exactly one parent. |\n| `parent_datastore_id` | string (uuid) | No | Parent datastore UUID. Where a parent share is also supported, supply exactly one parent. |\n| `key` | string | Yes | Wrapped encryption key for the recipient, as indicated by key_type. |\n| `key_nonce` | string | Yes | Hex-encoded nonce for key. Maximum length: 64. |\n| `key_type` | string | No | Key-wrapping method used for the key value. Default: `\"asymmetric\"`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiSharePostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `share_id` | string | Yes | Share id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share.py",
          "view": "ShareView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putShare",
        "summary": "Update share",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateShareRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiDatastorePostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a share\n\nNecessary Rights:\n    - write on share\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `WRITE_DATE_MISMATCH`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateShareRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `share_id` | string (uuid) | Yes | Share id identifier. |\n| `data` | string | No | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | string | No | Hex-encoded nonce for the encrypted content, separate from the transport nonce. Maximum length: 64. |\n| `old_write_date` | string (date-time) | No | Expected previous write timestamp for optimistic concurrency control. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiDatastorePostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `success` | string | Yes | Success. |\n| `write_date` | string | Yes | Last write time in ISO 8601 format. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share.py",
          "view": "ShareView",
          "method": "put"
        }
      }
    },
    "/share/{share_id}/": {
      "get": {
        "operationId": "getShareByShareId",
        "summary": "Get share",
        "tags": [
          "Shares and permissions"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getShareByShareIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "share_id",
            "in": "path",
            "required": true,
            "description": "Share id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all shares with all own share rights on that share or\nreturns a share with all rights existing on the share\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SHARE_ID_MALFORMED`, `SHARE_ID_NOT_PROVIDED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getShareByShareIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `data` | string | Yes | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | one of the documented alternatives | Yes | Hex-encoded nonce for the encrypted content, separate from the transport nonce. |\n| `user_id` | string | Yes | User id identifier. |\n| `rights` | object | Yes | Own share rights. |\n| `write_date` | string | Yes | Last write time in ISO 8601 format. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/share.py",
          "view": "ShareView",
          "method": "get"
        }
      }
    },
    "/group/": {
      "delete": {
        "operationId": "deleteGroup",
        "summary": "Delete group",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteGroupRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a group\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteGroupRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group.py",
          "view": "GroupView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getGroup",
        "summary": "List groups",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getGroupResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns either a list of all groups with own access privileges or the members specified group\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getGroupResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `groups` | object | Yes | Groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group.py",
          "view": "GroupView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postGroup",
        "summary": "Update group",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateGroupRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a group\n\nValidation may return: `NAME_CONTAINS_FORBIDDEN_CHARACTERS`, `NAME_TOO_SHORT`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateGroupRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `name` | string | Yes | Display name. Maximum length: 128. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group.py",
          "view": "GroupView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putGroup",
        "summary": "Create group",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateGroupRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGroupPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a group\n\nValidation may return: `NAME_MAY_NOT_BE_SHORTER_THAN_3_CHARS`, `NAME_MAY_NOT_CONTAIN_AT`, `NO_VALID_HEX`, `UNANAGED_GROUPS_ARE_DISABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateGroupRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | string | Yes | Display name. Maximum length: 128. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 64. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGroupPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string | Yes | Group id identifier. |\n| `name` | string | Yes | Display name. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. |\n| `secret_key_type` | string | Yes | Secret key type. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. |\n| `private_key_type` | string | Yes | Private key type. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `group_admin` | boolean | Yes | Group admin. |\n| `share_admin` | boolean | Yes | Share admin. |\n| `accepted` | boolean | Yes | Whether the invitation/right has been accepted. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group.py",
          "view": "GroupView",
          "method": "put"
        }
      }
    },
    "/group/rights/": {
      "get": {
        "operationId": "getGroupRights",
        "summary": "List group share rights",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGroupRightsGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all group rights accessible by the user or\na list of all groups accessible by the user filtered for a specific group\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGroupRightsGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_rights` | array | Yes | Group rights. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group_rights.py",
          "view": "GroupRightsView",
          "method": "get"
        }
      }
    },
    "/group/rights/{group_id}/": {
      "get": {
        "operationId": "getGroupRightsByGroupId",
        "summary": "List share rights for a group",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGroupRightsGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "group_id",
            "in": "path",
            "required": true,
            "description": "Group id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all group rights accessible by the user or\na list of all groups accessible by the user filtered for a specific group\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGroupRightsGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_rights` | array | Yes | Group rights. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group_rights.py",
          "view": "GroupRightsView",
          "method": "get"
        }
      }
    },
    "/group/{group_id}/": {
      "get": {
        "operationId": "getGroupByGroupId",
        "summary": "Get group",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getGroupByGroupIdResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "group_id",
            "in": "path",
            "required": true,
            "description": "Group id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns either a list of all groups with own access privileges or the members specified group\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getGroupByGroupIdResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string | Yes | Group id identifier. |\n| `name` | string | Yes | Display name. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `group_admin` | boolean | Yes | Group admin. |\n| `share_admin` | boolean | Yes | Share admin. |\n| `accepted` | boolean,null | Yes | Whether the invitation/right has been accepted. |\n| `forced_membership` | boolean | Yes | Forced membership. |\n| `secret_key` | string | No | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | No | Hex-encoded nonce for secret key. |\n| `secret_key_type` | string | No | Secret key type. |\n| `private_key` | string | No | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | No | Hex-encoded nonce for private key. |\n| `private_key_type` | string | No | Private key type. |\n| `members` | array | No | Members. |\n| `group_share_rights` | array | No | Group share rights. |\n| `user_id` | one of the documented alternatives | No | User id identifier. |\n| `user_username` | one of the documented alternatives | No | User username. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/group.py",
          "view": "GroupView",
          "method": "get"
        }
      }
    },
    "/membership/accept/": {
      "post": {
        "operationId": "postMembershipAccept",
        "summary": "Accept group invitation",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiMembershipAcceptRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiMembershipAcceptPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nMarks a Membership as accepted. In addition update the membership with the new encryption key.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST_OR_ALREADY_PROCESSED_MEMBERSHIP`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiMembershipAcceptRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `membership_id` | string (uuid) | Yes | Membership id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiMembershipAcceptPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shares` | array | Yes | Shares. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. |\n| `secret_key_type` | string | Yes | Secret key type. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. |\n| `private_key_type` | string | Yes | Private key type. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/membership_accept.py",
          "view": "MembershipAcceptView",
          "method": "post"
        }
      }
    },
    "/membership/decline/": {
      "post": {
        "operationId": "postMembershipDecline",
        "summary": "Decline group invitation",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiMembershipDeclineRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nMarks a membership as declined. In addition deletes now unnecessary information.\n\nValidation may return: `FORCED_MEMBERSHIP_CANNOT_BE_DECLINED`, `NO_PERMISSION_OR_NOT_EXIST_OR_ALREADY_PROCESSED_MEMBERSHIP`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiMembershipDeclineRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `membership_id` | string (uuid) | Yes | Membership id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/membership_decline.py",
          "view": "MembershipDeclineView",
          "method": "post"
        }
      }
    },
    "/membership/": {
      "delete": {
        "operationId": "deleteMembership",
        "summary": "Delete group membership",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteMembershipRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a group membership\n\nValidation may return: `FORCED_MEMBERSHIP_CANNOT_BE_DELETED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteMembershipRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `membership_id` | string (uuid) | Yes | Membership id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/membership.py",
          "view": "MembershipView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postMembership",
        "summary": "Update group membership",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiUpdateMembershipRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a group membership\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiUpdateMembershipRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `membership_id` | string (uuid) | Yes | Membership id identifier. |\n| `group_admin` | boolean | No | Group admin. Default: `false`. |\n| `share_admin` | boolean | No | Share admin. Default: `true`. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/membership.py",
          "view": "MembershipView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putMembership",
        "summary": "Create group membership",
        "tags": [
          "Groups and memberships"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiCreateMembershipRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiMembershipPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a new group membership\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `NO_VALID_HEX`, `UNKNOWN_PRIVATE_KEY_TYPE`, `UNKNOWN_SECRET_KEY_TYPE`, `USER_ALREADY_PART_OF_GROUP`, `USER_DOES_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiCreateMembershipRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `secret_key_type` | string | No | Secret key type. Default: `\"asymmetric\"`. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 64. |\n| `private_key_type` | string | No | Private key type. Default: `\"asymmetric\"`. |\n| `group_admin` | boolean | No | Group admin. Default: `false`. |\n| `share_admin` | boolean | No | Share admin. Default: `false`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiMembershipPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `membership_id` | string | Yes | Membership id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/membership.py",
          "view": "MembershipView",
          "method": "put"
        }
      }
    },
    "/metadata-datastore/{datastore_id}/": {
      "get": {
        "operationId": "getMetadataDatastoreByDatastoreId",
        "summary": "Get datastore metadata",
        "tags": [
          "Metadata"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiMetadataDatastoreGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "datastore_id",
            "in": "path",
            "required": true,
            "description": "Datastore id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the metadata info for a specific datastore\n\nValidation may return: `DATASTORE_ID_MALFORMED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiMetadataDatastoreGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `write_date` | string | Yes | Last write time in ISO 8601 format. |\n| `shares` | array | Yes | Shares. |\n| `secrets` | array | Yes | Secrets. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/metadata_datastore.py",
          "view": "MetadataDatastoreView",
          "method": "get"
        }
      }
    },
    "/metadata-share/{share_id}/": {
      "get": {
        "operationId": "getMetadataShareByShareId",
        "summary": "Get share metadata",
        "tags": [
          "Metadata"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiMetadataDatastoreGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "share_id",
            "in": "path",
            "required": true,
            "description": "Share id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the metadata info for a specific share\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SHARE_ID_MALFORMED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiMetadataDatastoreGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `write_date` | string | Yes | Last write time in ISO 8601 format. |\n| `shares` | array | Yes | Shares. |\n| `secrets` | array | Yes | Secrets. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/metadata_share.py",
          "view": "MetadataShareView",
          "method": "get"
        }
      }
    },
    "/management-command/": {
      "post": {
        "operationId": "postManagementCommand",
        "summary": "Run management command",
        "tags": [
          "Management commands"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "ManagementCommandToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiManagementCommandRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ManagementCommandResult"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Missing/invalid management access key or permission failure. Plaintext JSON; this authenticator does not issue a WWW-Authenticate challenge.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nRun management command.\n\nValidation may return: `MANAGEMENT_COMMAND_NOT_ALLOWED`.\n\nOnly commands enabled by the server management-command configuration are accepted. This endpoint uses a dedicated access key and ordinary JSON rather than a user session.\n\n**Configuration required:** `MANAGEMENT_COMMAND_ACCESS_KEY; ALLOWED_MANAGEMENT_COMMANDS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/management_command.py",
          "view": "ManagementCommandView",
          "method": "post"
        },
        "x-psono-requires-configuration": "MANAGEMENT_COMMAND_ACCESS_KEY; ALLOWED_MANAGEMENT_COMMANDS"
      }
    },
    "/device-code/": {
      "post": {
        "operationId": "postDeviceCode",
        "summary": "Create device approval code",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none",
          "guide": "protocol.html#device-approval"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestapiCreateDeviceCodeRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiDeviceCodePostResult201"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a new DeviceCode record. Anonymous access allowed.\n\nValidation may return: `INVALID_USER_PUBLIC_KEY`.\n\nA device code is valid for five minutes. Display its independent user_code for comparison in the approving client; the UUID in id is used in the claim and token URLs.\n\n**Encryption:** [No session envelope](protocol.html#device-approval)",
        "x-psono-source": {
          "file": "restapi/views/device_code.py",
          "view": "DeviceCodeView",
          "method": "post"
        }
      }
    },
    "/device-code/{device_code}/token/": {
      "post": {
        "operationId": "postDeviceCodeByDeviceCodeToken",
        "summary": "Retrieve approved device session",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "device-code-box",
          "guide": "protocol.html#device-approval",
          "responseFieldPayloads": {
            "200": {
              "boxed_payload": {
                "$ref": "#/components/schemas/DeviceCodePollPayload"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "device_code",
            "in": "path",
            "required": true,
            "description": "Device code.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiDeviceCodeTokenPostResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nRetrieves the session and credentials for an approved device code.\n\nValidation may return: `DEVICE_CODE_EXPIRED`, `DEVICE_CODE_INVALID_STATE`, `DEVICE_CODE_MISSING`, `DEVICE_CODE_NOT_CLAIMED`, `DEVICE_CODE_NOT_FOUND`.\n\nPoll after the approving client has claimed the code. A successful exchange consumes the code and returns a new active session plus device credentials. Polling failures such as not-yet-claimed or expired codes are validation/access errors; retrieval is one-time.\n\n**Encryption:** [Device-code Box](protocol.html#device-approval)\n\n### Decrypted response field `boxed_payload` · HTTP 200\n\nSchema: `DeviceCodePollPayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `state` | string | Yes | State. |\n| `token` | string | Yes | Authentication token returned by the indicated exchange. |\n| `session_secret_key` | string | Yes | Session encryption key, encrypted/wrapped in login exchanges as described by the protocol. |\n| `token_valid_till` | string,null (date-time) | Yes | Token valid till. |\n| `encrypted_credentials` | one of the documented alternatives | Yes | Encrypted credentials. |\n| `encrypted_credentials_nonce` | one of the documented alternatives | Yes | Hex-encoded nonce for encrypted credentials. |",
        "x-psono-source": {
          "file": "restapi/views/device_code_token.py",
          "view": "DeviceCodeTokenView",
          "method": "post"
        }
      }
    },
    "/device-code/{device_code}/claim/": {
      "get": {
        "operationId": "getDeviceCodeByDeviceCodeClaim",
        "summary": "Get device approval details",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "guide": "protocol.html#device-approval",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiDeviceCodeClaimGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "device_code",
            "in": "path",
            "required": true,
            "description": "Device code.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nRead the optional comparison code without exposing encryption material.\n\nValidation may return: `API_KEY_SESSION_NOT_ALLOWED`, `DEVICE_CODE_ALREADY_CLAIMED`, `DEVICE_CODE_INSTANCE_REQUIRED`, `DEVICE_CODE_USER_MISMATCH`, `NO_VALID_HEX`, `USER_AUTHENTICATION_REQUIRED`.\n\nOnly a normal user session may approve a device; API-key sessions are rejected. Compare the displayed user_code before PUT. GET exposes comparison metadata but not encryption keys or credentials.\n\n**Encryption:** [Session SecretBox](protocol.html#device-approval)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiDeviceCodeClaimGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_code` | string | Yes | User code. |\n| `device_description` | string | Yes | Human-readable description of the client device. |\n| `device_fingerprint` | string | Yes | Client device/session fingerprint used by device protection. |\n| `device_date` | string,null (date-time) | Yes | Device date. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `valid_till` | string,null (date-time) | Yes | Expiration time in ISO 8601 format. |\n| `state` | string | Yes | State. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/device_code_claim.py",
          "view": "DeviceCodeClaimView",
          "method": "get"
        }
      },
      "put": {
        "operationId": "putDeviceCodeByDeviceCodeClaim",
        "summary": "Approve device code",
        "tags": [
          "Authentication"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "guide": "protocol.html#device-approval",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiClaimDeviceCodeRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiDeviceCodeClaimPutResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "device_code",
            "in": "path",
            "required": true,
            "description": "Device code.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nClaims a pending DeviceCode by associating the authenticated user\nand storing encrypted credentials. Requires authentication.\nExpects 'device_code' in the URL.\n\nValidation may return: `API_KEY_SESSION_NOT_ALLOWED`, `DEVICE_CODE_ALREADY_CLAIMED`, `DEVICE_CODE_INSTANCE_REQUIRED`, `DEVICE_CODE_USER_MISMATCH`, `NO_VALID_HEX`, `USER_AUTHENTICATION_REQUIRED`.\n\nOnly a normal user session may approve a device; API-key sessions are rejected. Compare the displayed user_code before PUT. GET exposes comparison metadata but not encryption keys or credentials.\n\n**Encryption:** [Session SecretBox](protocol.html#device-approval)\n\n### Payload before transport encryption\n\nSchema: `RestapiClaimDeviceCodeRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `encrypted_credentials_input` | string | Yes | Hex-encoded encrypted credentials (keys and token). |\n| `encrypted_credentials_nonce` | string | Yes | Hex-encoded nonce used for encryption. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiDeviceCodeClaimPutResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `state` | string | Yes | State. |\n| `user` | string | Yes | Id identifier. |\n| `server_public_key` | string | Yes | Server public key. |\n| `user_public_key` | string | Yes | User public key. |\n| `encrypted_credentials` | string,null | Yes | Encrypted credentials. |\n| `encrypted_credentials_nonce` | string | Yes | Hex-encoded nonce for encrypted credentials. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "restapi/views/device_code_claim.py",
          "view": "DeviceCodeClaimView",
          "method": "put"
        }
      }
    },
    "/healthcheck/": {
      "get": {
        "operationId": "getHealthcheck",
        "summary": "Check server health",
        "tags": [
          "Discovery"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiHealthCheckGetResult200"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCheck the health of the application\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "restapi/views/health_check.py",
          "view": "HealthCheckView",
          "method": "get"
        }
      }
    },
    "/admin/authorization/": {
      "get": {
        "operationId": "getAdminAuthorization",
        "summary": "Get administrative access",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrativeAuthorizationResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nGet administrative access.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrativeAuthorizationResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `is_superuser` | boolean | Yes | Is superuser. |\n| `roles` | array | Yes | Roles. |\n| `capabilities` | object | Yes | Capabilities. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/authorization.py",
          "view": "AuthorizationView",
          "method": "get"
        }
      }
    },
    "/admin/capability/": {
      "get": {
        "operationId": "getAdminCapability",
        "summary": "List administrative capabilities",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrativeCapabilitiesResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nList administrative capabilities.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrativeCapabilitiesResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `capabilities` | array | Yes | Capabilities. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/capability.py",
          "view": "CapabilityView",
          "method": "get"
        }
      }
    },
    "/admin/identity-provider/tenant/": {
      "get": {
        "operationId": "getAdminIdentityProviderTenant",
        "summary": "List identity-provider tenants",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationIdentityProviderTenantGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Zero-based page number. Used with page_size.",
              "type": "integer",
              "minimum": 0,
              "default": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "type": "integer",
              "minimum": 1,
              "default": 5
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "description": "Search text used to filter the returned records.",
              "type": "string",
              "default": ""
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nList identity-provider tenants.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationIdentityProviderTenantGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `tenants` | array | Yes | Tenants. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/identity_provider_tenant.py",
          "view": "IdentityProviderTenantView",
          "method": "get"
        }
      }
    },
    "/admin/identity-provider/group-tenant/": {
      "put": {
        "operationId": "putAdminIdentityProviderGroupTenant",
        "summary": "Update identity-provider group tenants",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateIdentityProviderGroupTenantRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdate identity-provider group tenants.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `DUPLICATE_TENANT`, `NO_PERMISSION_OR_NOT_EXIST`, `TENANT_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateIdentityProviderGroupTenantRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `provider` | string | Yes | Provider. |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `tenant_ids` | array | Yes | Tenant ids. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/identity_provider_group_tenant.py",
          "view": "IdentityProviderGroupTenantView",
          "method": "put"
        }
      }
    },
    "/admin/tenant/{tenant_id}/": {
      "get": {
        "operationId": "getAdminTenantByTenantId",
        "summary": "Get tenant",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminTenantByTenantIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "tenant_id",
            "in": "path",
            "required": true,
            "description": "Tenant id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nGet tenant.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `FIELD_REQUIRED`, `NO_PERMISSION_OR_NOT_EXIST`, `TENANT_NAME_ALREADY_EXISTS`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminTenantByTenantIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `name` | string | Yes | Display name. |\n| `description` | string | Yes | Human-readable description. |\n| `is_active` | boolean | Yes | Is active. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string,null (date-time) | Yes | Last write time in ISO 8601 format. |\n| `user_count` | integer | Yes | User count. |\n| `group_count` | integer | Yes | Group count. |\n| `users` | array | No | Users. |\n| `groups` | array | No | Groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/tenant.py",
          "view": "TenantView",
          "method": "get"
        },
        "x-psono-superuser-required": true
      }
    },
    "/admin/tenant/": {
      "delete": {
        "operationId": "deleteAdminTenant",
        "summary": "Delete tenant",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/deleteAdminTenantPayload"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete tenant.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `FIELD_REQUIRED`, `NO_PERMISSION_OR_NOT_EXIST`, `TENANT_NAME_ALREADY_EXISTS`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `deleteAdminTenantPayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `tenant_id` | string (uuid) | Yes | Tenant id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/tenant.py",
          "view": "TenantView",
          "method": "delete"
        },
        "x-psono-superuser-required": true
      },
      "get": {
        "operationId": "getAdminTenant",
        "summary": "List tenants",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminTenantResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Zero-based page number. Used with page_size.",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "description": "Search text used to filter the returned records.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "description": "Sort field; a leading minus sign requests descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nList tenants.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `FIELD_REQUIRED`, `NO_PERMISSION_OR_NOT_EXIST`, `TENANT_NAME_ALREADY_EXISTS`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminTenantResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `tenants` | array | Yes | Tenants. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/tenant.py",
          "view": "TenantView",
          "method": "get"
        },
        "x-psono-superuser-required": true
      },
      "post": {
        "operationId": "postAdminTenant",
        "summary": "Create tenant",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/postAdminTenantPayload"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/AdministrationTenantPostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreate tenant.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `FIELD_REQUIRED`, `NO_PERMISSION_OR_NOT_EXIST`, `TENANT_NAME_ALREADY_EXISTS`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `postAdminTenantPayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | string | Yes | Display name. Maximum length: 128. |\n| `description` | string | No | Human-readable description. |\n| `is_active` | boolean | No | Is active. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `AdministrationTenantPostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `name` | string | Yes | Display name. |\n| `description` | string | Yes | Human-readable description. |\n| `is_active` | boolean | Yes | Is active. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string,null (date-time) | Yes | Last write time in ISO 8601 format. |\n| `user_count` | integer | Yes | User count. |\n| `group_count` | integer | Yes | Group count. |\n| `users` | array | No | Users. |\n| `groups` | array | No | Groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/tenant.py",
          "view": "TenantView",
          "method": "post"
        },
        "x-psono-superuser-required": true
      },
      "put": {
        "operationId": "putAdminTenant",
        "summary": "Update tenant",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/putAdminTenantPayload"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationTenantPostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdate tenant.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `FIELD_REQUIRED`, `NO_PERMISSION_OR_NOT_EXIST`, `TENANT_NAME_ALREADY_EXISTS`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `putAdminTenantPayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `tenant_id` | string (uuid) | Yes | Tenant id identifier. |\n| `name` | string | No | Display name. Maximum length: 128. |\n| `description` | string | No | Human-readable description. |\n| `is_active` | boolean | No | Is active. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationTenantPostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `name` | string | Yes | Display name. |\n| `description` | string | Yes | Human-readable description. |\n| `is_active` | boolean | Yes | Is active. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string,null (date-time) | Yes | Last write time in ISO 8601 format. |\n| `user_count` | integer | Yes | User count. |\n| `group_count` | integer | Yes | Group count. |\n| `users` | array | No | Users. |\n| `groups` | array | No | Groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/tenant.py",
          "view": "TenantView",
          "method": "put"
        },
        "x-psono-superuser-required": true
      }
    },
    "/admin/tenant-membership/": {
      "delete": {
        "operationId": "deleteAdminTenantMembership",
        "summary": "Remove tenant member",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationTenantMembershipRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nRemove tenant member.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `USER_OR_GROUP_REQUIRED`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationTenantMembershipRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `tenant_id` | string (uuid) | Yes | Tenant id identifier. |\n| `user_id` | string (uuid) | No | User id identifier. |\n| `group_id` | string (uuid) | No | Group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/tenant_membership.py",
          "view": "TenantMembershipView",
          "method": "delete"
        },
        "x-psono-superuser-required": true
      },
      "post": {
        "operationId": "postAdminTenantMembership",
        "summary": "Add tenant member",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationTenantMembershipRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nAdd tenant member.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `USER_OR_GROUP_REQUIRED`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationTenantMembershipRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `tenant_id` | string (uuid) | Yes | Tenant id identifier. |\n| `user_id` | string (uuid) | No | User id identifier. |\n| `group_id` | string (uuid) | No | Group id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/tenant_membership.py",
          "view": "TenantMembershipView",
          "method": "post"
        },
        "x-psono-superuser-required": true
      }
    },
    "/admin/administrative-role/{role_id}/": {
      "get": {
        "operationId": "getAdminAdministrativeRoleByRoleId",
        "summary": "Get role",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminAdministrativeRoleByRoleIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "role_id",
            "in": "path",
            "required": true,
            "description": "Role id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nGet role.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_NAME_ALREADY_EXISTS`, `FIELD_REQUIRED`, `INVALID_CAPABILITY`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_REQUIRES_GLOBAL_SCOPE`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminAdministrativeRoleByRoleIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `name` | string | Yes | Display name. |\n| `description` | string | Yes | Human-readable description. |\n| `is_active` | boolean | Yes | Is active. |\n| `is_system` | boolean | Yes | Is system. |\n| `is_full_access` | boolean | Yes | Is full access. |\n| `capabilities` | array | Yes | Capabilities. |\n| `assignments` | array | No | Assignments. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role.py",
          "view": "AdministrativeRoleView",
          "method": "get"
        },
        "x-psono-superuser-required": true
      }
    },
    "/admin/administrative-role/": {
      "delete": {
        "operationId": "deleteAdminAdministrativeRole",
        "summary": "Delete role",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationAdministrativeRoleRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete role.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_NAME_ALREADY_EXISTS`, `FIELD_REQUIRED`, `INVALID_CAPABILITY`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_REQUIRES_GLOBAL_SCOPE`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationAdministrativeRoleRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `role_id` | string (uuid) | Yes | Role id identifier. |\n| `name` | string | No | Display name. Maximum length: 128. |\n| `description` | string | No | Human-readable description. |\n| `is_active` | boolean | No | Is active. |\n| `capabilities` | array | No | Capabilities. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role.py",
          "view": "AdministrativeRoleView",
          "method": "delete"
        },
        "x-psono-superuser-required": true
      },
      "get": {
        "operationId": "getAdminAdministrativeRole",
        "summary": "List roles",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminAdministrativeRoleResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nList roles.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_NAME_ALREADY_EXISTS`, `FIELD_REQUIRED`, `INVALID_CAPABILITY`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_REQUIRES_GLOBAL_SCOPE`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminAdministrativeRoleResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `roles` | array | Yes | Roles. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role.py",
          "view": "AdministrativeRoleView",
          "method": "get"
        },
        "x-psono-superuser-required": true
      },
      "post": {
        "operationId": "postAdminAdministrativeRole",
        "summary": "Create role",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/postAdminAdministrativeRolePayload"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/AdministrationAdministrativeRolePostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreate role.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_NAME_ALREADY_EXISTS`, `FIELD_REQUIRED`, `INVALID_CAPABILITY`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_REQUIRES_GLOBAL_SCOPE`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `postAdminAdministrativeRolePayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | string | Yes | Display name. Maximum length: 128. |\n| `description` | string | No | Human-readable description. |\n| `is_active` | boolean | No | Is active. |\n| `capabilities` | array | No | Capabilities. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `AdministrationAdministrativeRolePostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `name` | string | Yes | Display name. |\n| `description` | string | Yes | Human-readable description. |\n| `is_active` | boolean | Yes | Is active. |\n| `is_system` | boolean | Yes | Is system. |\n| `is_full_access` | boolean | Yes | Is full access. |\n| `capabilities` | array | Yes | Capabilities. |\n| `assignments` | array | No | Assignments. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role.py",
          "view": "AdministrativeRoleView",
          "method": "post"
        },
        "x-psono-superuser-required": true
      },
      "put": {
        "operationId": "putAdminAdministrativeRole",
        "summary": "Update role",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationAdministrativeRoleRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationAdministrativeRolePostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdate role.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_NAME_ALREADY_EXISTS`, `FIELD_REQUIRED`, `INVALID_CAPABILITY`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_REQUIRES_GLOBAL_SCOPE`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationAdministrativeRoleRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `role_id` | string (uuid) | Yes | Role id identifier. |\n| `name` | string | No | Display name. Maximum length: 128. |\n| `description` | string | No | Human-readable description. |\n| `is_active` | boolean | No | Is active. |\n| `capabilities` | array | No | Capabilities. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationAdministrativeRolePostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `name` | string | Yes | Display name. |\n| `description` | string | Yes | Human-readable description. |\n| `is_active` | boolean | Yes | Is active. |\n| `is_system` | boolean | Yes | Is system. |\n| `is_full_access` | boolean | Yes | Is full access. |\n| `capabilities` | array | Yes | Capabilities. |\n| `assignments` | array | No | Assignments. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role.py",
          "view": "AdministrativeRoleView",
          "method": "put"
        },
        "x-psono-superuser-required": true
      }
    },
    "/admin/administrative-role-assignment/{assignment_id}/": {
      "get": {
        "operationId": "getAdminAdministrativeRoleAssignmentByAssignmentId",
        "summary": "Get role assignment",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminAdministrativeRoleAssignmentByAssignmentIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "assignment_id",
            "in": "path",
            "required": true,
            "description": "Assignment id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nGet role assignment.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_ASSIGNMENT_ALREADY_EXISTS`, `DUPLICATE_TENANT`, `GLOBAL_ASSIGNMENT_HAS_TENANTS`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_AND_USER_REQUIRED`, `ROLE_REQUIRES_GLOBAL_SCOPE`, `TENANT_NOT_EXIST`, `TENANT_REQUIRED`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminAdministrativeRoleAssignmentByAssignmentIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `role_id` | string | Yes | Role id identifier. |\n| `role_name` | string | Yes | Role name. |\n| `user_id` | string | Yes | User id identifier. |\n| `username` | string | Yes | Account username, normally including the configured domain. |\n| `is_global` | boolean | Yes | Is global. |\n| `tenant_ids` | array | Yes | Tenant ids. |\n| `tenants` | array | Yes | Tenants. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role_assignment.py",
          "view": "AdministrativeRoleAssignmentView",
          "method": "get"
        },
        "x-psono-superuser-required": true
      }
    },
    "/admin/administrative-role-assignment/": {
      "delete": {
        "operationId": "deleteAdminAdministrativeRoleAssignment",
        "summary": "Delete role assignment",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationAdministrativeRoleAssignmentRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete role assignment.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_ASSIGNMENT_ALREADY_EXISTS`, `DUPLICATE_TENANT`, `GLOBAL_ASSIGNMENT_HAS_TENANTS`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_AND_USER_REQUIRED`, `ROLE_REQUIRES_GLOBAL_SCOPE`, `TENANT_NOT_EXIST`, `TENANT_REQUIRED`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationAdministrativeRoleAssignmentRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `assignment_id` | string (uuid) | Yes | Assignment id identifier. |\n| `role_id` | string (uuid) | No | Role id identifier. |\n| `user_id` | string (uuid) | No | User id identifier. |\n| `is_global` | boolean | No | Is global. |\n| `tenant_ids` | array | No | Tenant ids. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role_assignment.py",
          "view": "AdministrativeRoleAssignmentView",
          "method": "delete"
        },
        "x-psono-superuser-required": true
      },
      "get": {
        "operationId": "getAdminAdministrativeRoleAssignment",
        "summary": "List role assignments",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminAdministrativeRoleAssignmentResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nList role assignments.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_ASSIGNMENT_ALREADY_EXISTS`, `DUPLICATE_TENANT`, `GLOBAL_ASSIGNMENT_HAS_TENANTS`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_AND_USER_REQUIRED`, `ROLE_REQUIRES_GLOBAL_SCOPE`, `TENANT_NOT_EXIST`, `TENANT_REQUIRED`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminAdministrativeRoleAssignmentResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `assignments` | array | Yes | Assignments. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role_assignment.py",
          "view": "AdministrativeRoleAssignmentView",
          "method": "get"
        },
        "x-psono-superuser-required": true
      },
      "post": {
        "operationId": "postAdminAdministrativeRoleAssignment",
        "summary": "Create role assignment",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/CreateAdministrativeRoleAssignment"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/AdministrationAdministrativeRoleAssignmentPostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreate role assignment.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_ASSIGNMENT_ALREADY_EXISTS`, `DUPLICATE_TENANT`, `GLOBAL_ASSIGNMENT_HAS_TENANTS`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_AND_USER_REQUIRED`, `ROLE_REQUIRES_GLOBAL_SCOPE`, `TENANT_NOT_EXIST`, `TENANT_REQUIRED`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `CreateAdministrativeRoleAssignment`.\n\nSet is_global=true without tenant_ids, or provide a nonempty tenant_ids list for a tenant-scoped role. Global-only capabilities require global scope.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `assignment_id` | string (uuid) | No | Assignment id identifier. |\n| `role_id` | string (uuid) | Yes | Role id identifier. |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `is_global` | boolean | No | Is global. |\n| `tenant_ids` | array | No | Tenant ids. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `AdministrationAdministrativeRoleAssignmentPostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `role_id` | string | Yes | Role id identifier. |\n| `role_name` | string | Yes | Role name. |\n| `user_id` | string | Yes | User id identifier. |\n| `username` | string | Yes | Account username, normally including the configured domain. |\n| `is_global` | boolean | Yes | Is global. |\n| `tenant_ids` | array | Yes | Tenant ids. |\n| `tenants` | array | Yes | Tenants. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role_assignment.py",
          "view": "AdministrativeRoleAssignmentView",
          "method": "post"
        },
        "x-psono-superuser-required": true
      },
      "put": {
        "operationId": "putAdminAdministrativeRoleAssignment",
        "summary": "Update role assignment",
        "tags": [
          "Admin · access and tenants"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationAdministrativeRoleAssignmentRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationAdministrativeRoleAssignmentPostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdate role assignment.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMINISTRATIVE_ROLE_ASSIGNMENT_ALREADY_EXISTS`, `DUPLICATE_TENANT`, `GLOBAL_ASSIGNMENT_HAS_TENANTS`, `NO_PERMISSION_OR_NOT_EXIST`, `ROLE_AND_USER_REQUIRED`, `ROLE_REQUIRES_GLOBAL_SCOPE`, `TENANT_NOT_EXIST`, `TENANT_REQUIRED`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationAdministrativeRoleAssignmentRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `assignment_id` | string (uuid) | Yes | Assignment id identifier. |\n| `role_id` | string (uuid) | No | Role id identifier. |\n| `user_id` | string (uuid) | No | User id identifier. |\n| `is_global` | boolean | No | Is global. |\n| `tenant_ids` | array | No | Tenant ids. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationAdministrativeRoleAssignmentPostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `role_id` | string | Yes | Role id identifier. |\n| `role_name` | string | Yes | Role name. |\n| `user_id` | string | Yes | User id identifier. |\n| `username` | string | Yes | Account username, normally including the configured domain. |\n| `is_global` | boolean | Yes | Is global. |\n| `tenant_ids` | array | Yes | Tenant ids. |\n| `tenants` | array | Yes | Tenants. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/administrative_role_assignment.py",
          "view": "AdministrativeRoleAssignmentView",
          "method": "put"
        },
        "x-psono-superuser-required": true
      }
    },
    "/admin/info/": {
      "get": {
        "operationId": "getAdminInfo",
        "summary": "Get administration dashboard",
        "tags": [
          "Admin · reporting"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationInfoGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the Server's signed information and some additional data for a nice dashboard\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationInfoGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `info` | string | Yes | JSON-encoded string. Preserve its exact bytes when signing or verifying it. |\n| `signature` | string | Yes | Hex-encoded detached signature over the exact serialized signed payload. |\n| `verify_key` | string | Yes | Verify key. |\n| `token_count_total` | integer | No | Token count total. |\n| `token_count_device` | integer | No | Token count device. |\n| `token_count_user` | integer | No | Token count user. |\n| `user_count_active` | integer | No | User count active. |\n| `user_count_total` | integer | No | User count total. |\n| `registrations_over_month` | array | No | Registrations over month. |\n| `registrations_over_day` | array | No | Registrations over day. |\n| `fileserver` | array | No | Fileserver. |\n| `registrations` | array | No | Registrations. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/info.py",
          "view": "InfoView",
          "method": "get"
        }
      }
    },
    "/admin/user/{user_id}/": {
      "get": {
        "operationId": "getAdminUserByUserId",
        "summary": "Get user",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminUserByUserIdResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "description": "User id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all users or a the infos of a single user\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminUserByUserIdResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `username` | string | Yes | Account username, normally including the configured domain. |\n| `server_secret_exists` | boolean | Yes | Server secret exists. |\n| `is_managed` | boolean | Yes | Is managed. |\n| `admin_recovery_exists` | boolean | Yes | Admin recovery exists. |\n| `db_secret_exists` | boolean | Yes | Db secret exists. |\n| `email` | one of the documented alternatives | Yes | Email address. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `last_login` | string,null (date-time) | Yes | Last login. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `is_active` | boolean | Yes | Is active. |\n| `is_email_active` | boolean | Yes | Is email active. |\n| `is_superuser` | boolean | Yes | Is superuser. |\n| `is_staff` | boolean | Yes | Is staff. |\n| `require_password_change` | boolean | Yes | Require password change. |\n| `language` | string | Yes | Language. |\n| `authentication` | string | Yes | Authentication. |\n| `duos` | array | Yes | Duos. |\n| `google_authenticators` | array | Yes | Google authenticators. |\n| `yubikey_otps` | array | Yes | Yubikey otps. |\n| `webauthns` | array | Yes | Webauthns. |\n| `ivalts` | array | Yes | Ivalts. |\n| `link_shares` | array | Yes | Link shares. |\n| `share_rights` | array | Yes | Share rights. |\n| `tenant_ids` | array | Yes | Tenant ids. |\n| `memberships` | array | No | Memberships. |\n| `recovery_codes` | array | No | Recovery codes. |\n| `emergency_codes` | array | No | Emergency codes. |\n| `sessions` | array | No | Sessions. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user.py",
          "view": "UserView",
          "method": "get"
        }
      }
    },
    "/admin/user/": {
      "delete": {
        "operationId": "deleteAdminUser",
        "summary": "Delete user",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteUserRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a user\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SHARED_OWNERSHIP_CONFIRMATION_REQUIRED`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteUserRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `confirm_shared_ownership` | boolean | No | Confirm shared ownership. Default: `false`. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user.py",
          "view": "UserView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminUser",
        "summary": "List users",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminUserResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all users or a the infos of a single user\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminUserResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `users` | array | Yes | Users. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user.py",
          "view": "UserView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAdminUser",
        "summary": "Create user",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateUserRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/AdministrationUserPostResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a user\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `DUPLICATE_TENANT`, `TENANT_NOT_EXIST`, `TENANT_REQUIRED`, `USER_WITH_EMAIL_ALREADY_EXISTS`, `USER_WITH_USERNAME_ALREADY_EXISTS`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateUserRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `username` | string (email) | Yes | Account username, normally including the configured domain. |\n| `email` | string (email) | Yes | Email address. |\n| `password` | string | No | Password value for the operation; password and authkey are different credentials. |\n| `language` | string,null | No | Language. Maximum length: 16. |\n| `require_password_change` | boolean | No | Require password change. |\n| `tenant_ids` | array | No | Tenant ids. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `AdministrationUserPostResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `password` | string,null | Yes | Password value for the operation; password and authkey are different credentials. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user.py",
          "view": "UserView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminUser",
        "summary": "Update user",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateUserRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a user\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `USERNAME_CHANGE_REQUIRES_PASSWORD_RESET`, `USER_KEYS_NOT_AVAILABLE`, `USER_WITH_EMAIL_ALREADY_EXISTS`, `USER_WITH_USERNAME_ALREADY_EXISTS`.\n\nThis operation requires a superuser; delegated administrative roles are insufficient.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateUserRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `username` | string (email) | No | Account username, normally including the configured domain. Maximum length: 254. |\n| `is_active` | boolean | No | Is active. |\n| `is_email_active` | boolean | No | Is email active. |\n| `is_staff` | boolean | No | Is staff. |\n| `is_superuser` | boolean | No | Is superuser. |\n| `require_password_change` | boolean | No | Require password change. |\n| `email` | string (email) | No | Email address. |\n| `language` | string,null | No | Language. Maximum length: 16. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user.py",
          "view": "UserView",
          "method": "put"
        },
        "x-psono-superuser-required": true
      }
    },
    "/admin/user-share-right/": {
      "delete": {
        "operationId": "deleteAdminUserShareRight",
        "summary": "Delete user share right",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteUserShareRightRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDelete a direct user share right without deleting the share itself.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteUserShareRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_share_right_id` | string (uuid) | Yes | User share right id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user_share_right.py",
          "view": "UserShareRightView",
          "method": "delete"
        }
      },
      "put": {
        "operationId": "putAdminUserShareRight",
        "summary": "Update user share right",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateUserShareRightRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdate the permissions of an existing direct user share right.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateUserShareRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_share_right_id` | string (uuid) | Yes | User share right id identifier. |\n| `read` | boolean | No | Whether read access is granted. |\n| `write` | boolean | No | Whether write access is granted. |\n| `grant` | boolean | No | Whether the recipient may grant access to others. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user_share_right.py",
          "view": "UserShareRightView",
          "method": "put"
        }
      }
    },
    "/admin/yubikey-otp/": {
      "delete": {
        "operationId": "deleteAdminYubikeyOtp",
        "summary": "Delete YubiKey",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteYubikeyRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Yubikey token\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteYubikeyRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `yubikey_otp_id` | string (uuid) | Yes | Yubikey otp id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/yubikey.py",
          "view": "YubikeyOTPView",
          "method": "delete"
        }
      }
    },
    "/admin/webautn/": {
      "delete": {
        "operationId": "deleteAdminWebautn",
        "summary": "Delete WebAuthn",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteWebauthnRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Yubikey token\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteWebauthnRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `webauthn_id` | string (uuid) | Yes | Webauthn id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/webauthn.py",
          "view": "WebAuthnView",
          "method": "delete"
        }
      }
    },
    "/admin/google-authenticator/": {
      "delete": {
        "operationId": "deleteAdminGoogleAuthenticator",
        "summary": "Delete ga",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteGARequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Google authenticator\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteGARequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `google_authenticator_id` | string (uuid) | Yes | Google authenticator id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ga.py",
          "view": "GaView",
          "method": "delete"
        }
      }
    },
    "/admin/recovery-code/": {
      "delete": {
        "operationId": "deleteAdminRecoveryCode",
        "summary": "Delete recovery code",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteRecoveryCodeRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Recovery Code\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteRecoveryCodeRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `recovery_code_id` | string (uuid) | Yes | Recovery code id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/recovery_code.py",
          "view": "RecoveryCodeView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminRecoveryCode",
        "summary": "List recovery codes",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationRecoveryCodeGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all recovery codes\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationRecoveryCodeGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `recovery_codes` | array | Yes | Recovery codes. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/recovery_code.py",
          "view": "RecoveryCodeView",
          "method": "get"
        }
      }
    },
    "/admin/emergency-code/": {
      "delete": {
        "operationId": "deleteAdminEmergencyCode",
        "summary": "Delete emergency code",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteEmergencycodeRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Emergency Code\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteEmergencycodeRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `emergency_code_id` | string (uuid) | Yes | Emergency code id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/emergency_code.py",
          "view": "EmergencyCodeView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminEmergencyCode",
        "summary": "List emergency codes",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationEmergencyCodeGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all emergency codes\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationEmergencyCodeGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `emergency_codes` | array | Yes | Emergency codes. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/emergency_code.py",
          "view": "EmergencyCodeView",
          "method": "get"
        }
      }
    },
    "/admin/duo/": {
      "delete": {
        "operationId": "deleteAdminDuo",
        "summary": "Delete duo",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteDuoRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Duo authenticator\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteDuoRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `duo_id` | string (uuid) | Yes | Duo id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/duo.py",
          "view": "DuoView",
          "method": "delete"
        }
      }
    },
    "/admin/ivalt/": {
      "delete": {
        "operationId": "deleteAdminIvalt",
        "summary": "Delete iVALT",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteIvaltRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Ivalt authenticator\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteIvaltRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ivalt_id` | string (uuid) | Yes | Ivalt id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ivalt.py",
          "view": "IvaltView",
          "method": "delete"
        }
      }
    },
    "/admin/session/": {
      "delete": {
        "operationId": "deleteAdminSession",
        "summary": "Delete session",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteSessionRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a session\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteSessionRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `session_id` | string (uuid) | Yes | Session id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/session.py",
          "view": "SessionView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminSession",
        "summary": "List sessions",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationSessionGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all sessions\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationSessionGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `sessions` | array | Yes | Sessions. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/session.py",
          "view": "SessionView",
          "method": "get"
        }
      }
    },
    "/admin/security-report/{security_report_id}/": {
      "get": {
        "operationId": "getAdminSecurityReportBySecurityReportId",
        "summary": "Get security report",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminSecurityReportBySecurityReportIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "security_report_id",
            "in": "path",
            "required": true,
            "description": "Security report id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all security reports\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminSecurityReportBySecurityReportIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `username` | string | Yes | Account username, normally including the configured domain. |\n| `recovery_code_exists` | boolean | Yes | Recovery code exists. |\n| `two_factor_exists` | boolean | Yes | Two factor exists. |\n| `website_password_count` | integer | Yes | Website password count. |\n| `breached_password_count` | integer | Yes | Breached password count. |\n| `duplicate_password_count` | integer | Yes | Duplicate password count. |\n| `check_haveibeenpwned` | boolean | Yes | Check haveibeenpwned. |\n| `master_password_breached` | boolean | Yes | Master password breached. |\n| `master_password_duplicate` | boolean | Yes | Master password duplicate. |\n| `master_password_length` | integer | Yes | Master password length. |\n| `master_password_variation_count` | integer | Yes | Master password variation count. |\n| `entries` | array | Yes | Entries. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/security_report.py",
          "view": "SecurityReportView",
          "method": "get"
        }
      }
    },
    "/admin/security-report/": {
      "get": {
        "operationId": "getAdminSecurityReport",
        "summary": "List security reports",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminSecurityReportResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all security reports\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminSecurityReportResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `security_reports` | array | Yes | Security reports. |\n| `user_count` | integer | Yes | User count. |\n| `users_missing_reports` | array | Yes | Users missing reports. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/security_report.py",
          "view": "SecurityReportView",
          "method": "get"
        }
      }
    },
    "/admin/group/{group_id}/": {
      "get": {
        "operationId": "getAdminGroupByGroupId",
        "summary": "Get group",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminGroupByGroupIdResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "group_id",
            "in": "path",
            "required": true,
            "description": "Group id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all groups\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminGroupByGroupIdResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `name` | string | Yes | Display name. |\n| `is_managed` | boolean | Yes | Is managed. |\n| `admin_recovery_exists` | boolean | Yes | Admin recovery exists. |\n| `db_secret_exists` | boolean | Yes | Db secret exists. |\n| `forced_membership` | boolean | Yes | Forced membership. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `group_user_secrets` | array | Yes | Group user secrets. |\n| `own_group_user_secret` | object | Yes | Own group user secret. |\n| `share_rights` | array | Yes | Share rights. |\n| `ldap_groups` | array | Yes | Ldap groups. |\n| `saml_groups` | array | Yes | Saml groups. |\n| `oidc_groups` | array | Yes | Oidc groups. |\n| `scim_groups` | array | Yes | Scim groups. |\n| `tenant_ids` | array | Yes | Tenant ids. |\n| `memberships` | array | No | Memberships. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/group.py",
          "view": "GroupView",
          "method": "get"
        }
      }
    },
    "/admin/group/": {
      "delete": {
        "operationId": "deleteAdminGroup",
        "summary": "Delete group",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteGroupRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a group\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `SHARED_OWNERSHIP_CONFIRMATION_REQUIRED`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteGroupRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `confirm_shared_ownership` | boolean | No | Confirm shared ownership. Default: `false`. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/group.py",
          "view": "GroupView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminGroup",
        "summary": "List groups",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminGroupResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all groups\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminGroupResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `groups` | array | Yes | Groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/group.py",
          "view": "GroupView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAdminGroup",
        "summary": "Create group",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateGroupRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates a group\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `DUPLICATE_TENANT`, `TENANT_NOT_EXIST`, `TENANT_REQUIRED`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateGroupRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | string | Yes | Display name. |\n| `auto_create_folder` | boolean | No | Auto create folder. Default: `false`. |\n| `tenant_ids` | array | No | Tenant ids. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/group.py",
          "view": "GroupView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminGroup",
        "summary": "Update group",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateGroupRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a group\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NAME_CONTAINS_FORBIDDEN_CHARACTERS`, `NAME_TOO_SHORT`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateGroupRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `name` | string | Yes | Display name. Maximum length: 128. |\n| `forced_membership` | boolean | No | Forced membership. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/group.py",
          "view": "GroupView",
          "method": "put"
        }
      }
    },
    "/admin/group-share-right/": {
      "delete": {
        "operationId": "deleteAdminGroupShareRight",
        "summary": "Delete group share right",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteGroupShareRightRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a group share right\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteGroupShareRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_share_right_id` | string (uuid) | Yes | Group share right id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/group_share_right.py",
          "view": "GroupShareRightView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminGroupShareRight",
        "summary": "Create group share right",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateGroupShareRightRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates a group share right of a new share containing a folder\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NAME_REQUIRED`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateGroupShareRightRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `read` | boolean | Yes | Whether read access is granted. |\n| `write` | boolean | Yes | Whether write access is granted. |\n| `grant` | boolean | Yes | Whether the recipient may grant access to others. |\n| `name` | string | No | Display name. Maximum length: 256. |\n| `share_data` | string | No | Share data. |\n| `share_data_nonce` | string | No | Hex-encoded nonce for share data. Maximum length: 64. |\n| `group_share_right_key` | string | No | Group share right key. |\n| `group_share_right_key_nonce` | string | No | Hex-encoded nonce for group share right key. Maximum length: 64. |\n| `group_share_right_title` | string | No | Group share right title. |\n| `group_share_right_title_nonce` | string | No | Hex-encoded nonce for group share right title. Maximum length: 64. |\n| `group_share_right_type` | string | No | Group share right type. |\n| `group_share_right_type_nonce` | string | No | Hex-encoded nonce for group share right type. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/group_share_right.py",
          "view": "GroupShareRightView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminGroupShareRight",
        "summary": "Update group share right",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateGroupShareRightRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a group share right\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateGroupShareRightRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_share_right_id` | string (uuid) | Yes | Group share right id identifier. |\n| `read` | boolean | No | Whether read access is granted. |\n| `write` | boolean | No | Whether write access is granted. |\n| `grant` | boolean | No | Whether the recipient may grant access to others. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/group_share_right.py",
          "view": "GroupShareRightView",
          "method": "put"
        }
      }
    },
    "/admin/link-share/": {
      "delete": {
        "operationId": "deleteAdminLinkShare",
        "summary": "Delete link share",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteLinkShareRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a Link Share\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteLinkShareRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_share_id` | string (uuid) | Yes | Link share id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/link_share.py",
          "view": "LinkShareView",
          "method": "delete"
        }
      }
    },
    "/admin/membership/": {
      "delete": {
        "operationId": "deleteAdminMembership",
        "summary": "Delete membership",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteMembershipRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a membership\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteMembershipRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `membership_id` | string (uuid) | Yes | Membership id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/membership.py",
          "view": "MembershipView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminMembership",
        "summary": "List memberships",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationMembershipGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all memberships\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationMembershipGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `memberships` | array | Yes | Memberships. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/membership.py",
          "view": "MembershipView",
          "method": "get"
        }
      },
      "put": {
        "operationId": "putAdminMembership",
        "summary": "Update membership",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateMembershipRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdate membership.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateMembershipRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `membership_id` | string (uuid) | Yes | Membership id identifier. |\n| `group_admin` | boolean,null | No | Group admin. |\n| `share_admin` | boolean,null | No | Share admin. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/membership.py",
          "view": "MembershipView",
          "method": "put"
        }
      }
    },
    "/admin/stats/browser/": {
      "get": {
        "operationId": "getAdminStatsBrowser",
        "summary": "Get browser statistics",
        "tags": [
          "Admin · reporting"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationStatsBrowserGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the statistics of used devices\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationStatsBrowserGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `other` | integer | Yes | Other. |\n| `firefox` | integer | Yes | Firefox. |\n| `chrome` | integer | Yes | Chrome. |\n| `safari` | integer | Yes | Safari. |\n| `vivaldi` | integer | Yes | Vivaldi. |\n| `edge` | integer | Yes | Edge. |\n| `brave` | integer | Yes | Brave. |\n| `opera` | integer | Yes | Opera. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/stats_browser.py",
          "view": "StatsBrowserView",
          "method": "get"
        }
      }
    },
    "/admin/stats/device/": {
      "get": {
        "operationId": "getAdminStatsDevice",
        "summary": "Get device statistics",
        "tags": [
          "Admin · reporting"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationStatsDeviceGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the statistics of used devices\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationStatsDeviceGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `other` | integer | Yes | Other. |\n| `linux` | integer | Yes | Linux. |\n| `windows` | integer | Yes | Windows. |\n| `mac` | integer | Yes | Mac. |\n| `android` | integer | Yes | Android. |\n| `iphone` | integer | Yes | Iphone. |\n| `ipad` | integer | Yes | Ipad. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/stats_device.py",
          "view": "StatsDeviceView",
          "method": "get"
        }
      }
    },
    "/admin/stats/os/": {
      "get": {
        "operationId": "getAdminStatsOs",
        "summary": "Get operating-system statistics",
        "tags": [
          "Admin · reporting"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationStatsOsGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the statistics of used operations_systems\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationStatsOsGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `other` | integer | Yes | Other. |\n| `linux` | integer | Yes | Linux. |\n| `windows` | integer | Yes | Windows. |\n| `mac_os` | integer | Yes | Mac os. |\n| `android` | integer | Yes | Android. |\n| `ios` | integer | Yes | Ios. |\n| `ipados` | integer | Yes | Ipados. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/stats_os.py",
          "view": "StatsOsView",
          "method": "get"
        }
      }
    },
    "/admin/fileserver-cluster/configuration/": {
      "post": {
        "operationId": "postAdminFileserverClusterConfiguration",
        "summary": "Generate file-server cluster configuration",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationGenerateFileserverClusterConfigRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationFileserverClusterConfigPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nGenerates a configuration for a member of a fileserver cluster\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `NO_SHARDS_LINKED`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationGenerateFileserverClusterConfigRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationFileserverClusterConfigPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `configuration` | object | Yes | Configuration. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster_config.py",
          "view": "FileserverClusterConfigView",
          "method": "post"
        }
      }
    },
    "/admin/fileserver-cluster/{cluster_id}/": {
      "get": {
        "operationId": "getAdminFileserverClusterByClusterId",
        "summary": "Get file-server cluster",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminFileserverClusterByClusterIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "cluster_id",
            "in": "path",
            "required": true,
            "description": "Cluster id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all fileserver clusters or the details of a single cluster\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminFileserverClusterByClusterIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string,null (date-time) | Yes | Last write time in ISO 8601 format. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. |\n| `file_size_limit` | integer | Yes | File size limit. |\n| `links` | array | Yes | Links. |\n| `fileservers` | array | Yes | Fileservers. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster.py",
          "view": "FileserverClusterView",
          "method": "get"
        }
      }
    },
    "/admin/fileserver-cluster/": {
      "delete": {
        "operationId": "deleteAdminFileserverCluster",
        "summary": "Delete file-server cluster",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteFileserverClusterRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a fileserver cluster\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteFileserverClusterRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster.py",
          "view": "FileserverClusterView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminFileserverCluster",
        "summary": "List file-server clusters",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminFileserverClusterResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all fileserver clusters or the details of a single cluster\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminFileserverClusterResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `clusters` | array | Yes | Clusters. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster.py",
          "view": "FileserverClusterView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAdminFileserverCluster",
        "summary": "Create file-server cluster",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateFileserverClusterRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a fileserver cluster\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateFileserverClusterRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `file_size_limit` | integer | No | File size limit. Default: `0`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster.py",
          "view": "FileserverClusterView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminFileserverCluster",
        "summary": "Update file-server cluster",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateFileserverClusterRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a fileserver cluster\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateFileserverClusterRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `file_size_limit` | integer | Yes | File size limit. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster.py",
          "view": "FileserverClusterView",
          "method": "put"
        }
      }
    },
    "/admin/fileserver-shard/{shard_id}/": {
      "get": {
        "operationId": "getAdminFileserverShardByShardId",
        "summary": "Get file-server shard",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminFileserverShardByShardIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "shard_id",
            "in": "path",
            "required": true,
            "description": "Shard id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all fileserver shards or the details of a single shard\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminFileserverShardByShardIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string,null (date-time) | Yes | Last write time in ISO 8601 format. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. |\n| `description` | string | Yes | Human-readable description. |\n| `active` | boolean | Yes | Whether the resource or account is active. |\n| `links` | array | Yes | Links. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_shard.py",
          "view": "FileserverShardView",
          "method": "get"
        }
      }
    },
    "/admin/fileserver-shard/": {
      "delete": {
        "operationId": "deleteAdminFileserverShard",
        "summary": "Delete file-server shard",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteFileserverShardRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nDeletes a fileserver shard\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteFileserverShardRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shard_id` | string (uuid) | Yes | Shard id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_shard.py",
          "view": "FileserverShardView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminFileserverShard",
        "summary": "List file-server shards",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminFileserverShardResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all fileserver shards or the details of a single shard\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminFileserverShardResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `shards` | array | Yes | Shards. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_shard.py",
          "view": "FileserverShardView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAdminFileserverShard",
        "summary": "Create file-server shard",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateFileserverShardRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nCreates a fileserver shard\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateFileserverShardRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `description` | string | Yes | Human-readable description. |\n| `active` | boolean | No | Whether the resource or account is active. Default: `true`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_shard.py",
          "view": "FileserverShardView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminFileserverShard",
        "summary": "Update file-server shard",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateFileserverShardRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a fileserver shard\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateFileserverShardRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shard_id` | string (uuid) | Yes | Shard id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `description` | string | Yes | Human-readable description. |\n| `active` | boolean | Yes | Whether the resource or account is active. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_shard.py",
          "view": "FileserverShardView",
          "method": "put"
        }
      }
    },
    "/admin/fileserver-cluster-shard-link/": {
      "delete": {
        "operationId": "deleteAdminFileserverClusterShardLink",
        "summary": "Delete fileserver cluster shard link",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/RestapiDeleteFileLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUnlinks a fileserver shard from a cluster\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `RestapiDeleteFileLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster_shard_link.py",
          "view": "FileserverClusterShardLinkView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminFileserverClusterShardLink",
        "summary": "Create fileserver cluster shard link",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateFileserverClusterShardLinkRequest"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nLinks a fileserver shard to a cluster\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `LINK_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateFileserverClusterShardLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n| `shard_id` | string (uuid) | Yes | Shard id identifier. |\n| `read` | boolean | No | Whether read access is granted. Default: `true`. |\n| `write` | boolean | No | Whether write access is granted. Default: `true`. |\n| `delete_capability` | boolean | No | Delete capability. Default: `true`. |\n| `allow_link_shares` | boolean | No | Allow link shares. Default: `true`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster_shard_link.py",
          "view": "FileserverClusterShardLinkView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminFileserverClusterShardLink",
        "summary": "Update fileserver cluster shard link",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateFileserverClusterShardLinkRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates a fileserver cluster shard link\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateFileserverClusterShardLinkRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `link_id` | string (uuid) | Yes | Client-generated unique link UUID. |\n| `read` | boolean | Yes | Whether read access is granted. |\n| `write` | boolean | Yes | Whether write access is granted. |\n| `delete_capability` | boolean | Yes | Delete capability. |\n| `allow_link_shares` | boolean | Yes | Allow link shares. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver_cluster_shard_link.py",
          "view": "FileserverClusterShardLinkView",
          "method": "put"
        }
      }
    },
    "/admin/fileserver/{fileserver_id}/": {
      "get": {
        "operationId": "getAdminFileserverByFileserverId",
        "summary": "Get file server",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminFileserverByFileserverIdResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "fileserver_id",
            "in": "path",
            "required": true,
            "description": "Fileserver id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all fileservers or the details of a single fileserver\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminFileserverByFileserverIdResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string,null (date-time) | Yes | Last write time in ISO 8601 format. |\n| `create_ip` | string | Yes | Create ip. |\n| `cluster_id` | string | Yes | Cluster id identifier. |\n| `cluster_title` | string | Yes | Cluster title. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `url` | string | Yes | Url. |\n| `version` | string | Yes | Version. |\n| `hostname` | string | Yes | Hostname. |\n| `read` | boolean | Yes | Whether read access is granted. |\n| `write` | boolean | Yes | Whether write access is granted. |\n| `delete_capability` | boolean | Yes | Delete capability. |\n| `allow_link_shares` | boolean | Yes | Allow link shares. |\n| `valid_till` | string,null (date-time) | Yes | Expiration time in ISO 8601 format. |\n| `alive` | boolean | Yes | Alive. |\n| `shards` | array | No | Shards. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver.py",
          "view": "FileserverView",
          "method": "get"
        }
      }
    },
    "/admin/fileserver/": {
      "get": {
        "operationId": "getAdminFileserver",
        "summary": "List file servers",
        "tags": [
          "Admin · file servers"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminFileserverResult"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns a list of all fileservers or the details of a single fileserver\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminFileserverResult`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `fileservers` | array | Yes | Fileservers. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/fileserver.py",
          "view": "FileserverView",
          "method": "get"
        }
      }
    },
    "/admin/stats/two-factor/": {
      "get": {
        "operationId": "getAdminStatsTwoFactor",
        "summary": "Get multifactor statistics",
        "tags": [
          "Admin · reporting"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationStatsTwoFactorGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the statistics of used two factors\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationStatsTwoFactorGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `users` | integer | Yes | Users. |\n| `user_google_authenticator_enabled_count` | integer | Yes | User google authenticator enabled count. |\n| `user_duo_enabled_count` | integer | Yes | User duo enabled count. |\n| `user_webauthn_enabled_count` | integer | Yes | User webauthn enabled count. |\n| `user_yubikey_otp_enabled_count` | integer | Yes | User yubikey otp enabled count. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/stats_two_factor.py",
          "view": "StatsTwoFactorView",
          "method": "get"
        }
      }
    },
    "/admin/ldap/user/": {
      "get": {
        "operationId": "getAdminLdapUser",
        "summary": "List LDAP users",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationLDAPUserGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReturns a list of all LDAP users\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationLDAPUserGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ldap_users` | array | Yes | Ldap users. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ldap_user.py",
          "view": "LDAPUserView",
          "method": "get"
        }
      }
    },
    "/admin/ldap/group/map/": {
      "delete": {
        "operationId": "deleteAdminLdapGroupMap",
        "summary": "Delete LDAP group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteLDAPGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a ldap group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteLDAPGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `ldap_group_id` | string (uuid) | Yes | Ldap group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ldap_group_map.py",
          "view": "LDAPGroupMapView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminLdapGroupMap",
        "summary": "Create LDAP group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateLDAPGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates an LDAP group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `MAPPING_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateLDAPGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `ldap_group_id` | string (uuid) | Yes | Ldap group id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ldap_group_map.py",
          "view": "LDAPGroupMapView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminLdapGroupMap",
        "summary": "Update LDAP group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateLDAPGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdates an LDAP group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateLDAPGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ldap_group_map_id` | string (uuid) | Yes | Ldap group map id identifier. |\n| `group_admin` | boolean | Yes | Group admin. |\n| `share_admin` | boolean | Yes | Share admin. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ldap_group_map.py",
          "view": "LDAPGroupMapView",
          "method": "put"
        }
      }
    },
    "/admin/ldap/group/": {
      "delete": {
        "operationId": "deleteAdminLdapGroup",
        "summary": "Delete LDAP group",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteLDAPGroupRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a LDAP Group\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteLDAPGroupRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ldap_group_id` | string (uuid) | Yes | Ldap group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ldap_group.py",
          "view": "LDAPGroupView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminLdapGroup",
        "summary": "List LDAP groups",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationLDAPGroupGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReturns a list of all LDAP groups\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationLDAPGroupGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ldap_groups` | array | Yes | Ldap groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ldap_group.py",
          "view": "LDAPGroupView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAdminLdapGroup",
        "summary": "Sync LDAP groups",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationLDAPGroupPostResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nSyncs groups from LDAP with local LDAP groups\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `LDAP_GATEWAY_CONNECTION_ISSUE`, `LDAP_SERVER_CONNECTION_ISSUE`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationLDAPGroupPostResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ldap_groups` | array | Yes | Ldap groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/ldap_group.py",
          "view": "LDAPGroupView",
          "method": "post"
        }
      }
    },
    "/admin/scim/group/map/": {
      "delete": {
        "operationId": "deleteAdminScimGroupMap",
        "summary": "Delete SCIM group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteSCIMGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a scim group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteSCIMGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `scim_group_id` | string (uuid) | Yes | Scim group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/scim_group_map.py",
          "view": "SCIMGroupMapView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminScimGroupMap",
        "summary": "Create SCIM group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateSCIMGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates an SCIM group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `MAPPING_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateSCIMGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `scim_group_id` | string (uuid) | Yes | Scim group id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/scim_group_map.py",
          "view": "SCIMGroupMapView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminScimGroupMap",
        "summary": "Update SCIM group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateSCIMGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdates an SCIM group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateSCIMGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `scim_group_map_id` | string (uuid) | Yes | Scim group map id identifier. |\n| `group_admin` | boolean | Yes | Group admin. |\n| `share_admin` | boolean | Yes | Share admin. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/scim_group_map.py",
          "view": "SCIMGroupMapView",
          "method": "put"
        }
      }
    },
    "/admin/scim/group/": {
      "delete": {
        "operationId": "deleteAdminScimGroup",
        "summary": "Delete SCIM group",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteSCIMGroupRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a SCIM Group\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteSCIMGroupRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `scim_group_id` | string (uuid) | Yes | Scim group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/scim_group.py",
          "view": "SCIMGroupView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminScimGroup",
        "summary": "List SCIM groups",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationSCIMGroupGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReturns a list of all SCIM groups\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationSCIMGroupGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `scim_groups` | array | Yes | Scim groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/scim_group.py",
          "view": "SCIMGroupView",
          "method": "get"
        }
      }
    },
    "/admin/saml/group/map/": {
      "delete": {
        "operationId": "deleteAdminSamlGroupMap",
        "summary": "Delete SAML group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteSAMLGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a saml group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteSAMLGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `saml_group_id` | string (uuid) | Yes | Saml group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/saml_group_map.py",
          "view": "SAMLGroupMapView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminSamlGroupMap",
        "summary": "Create SAML group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateSAMLGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates an SAML group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `MAPPING_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateSAMLGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `saml_group_id` | string (uuid) | Yes | Saml group id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/saml_group_map.py",
          "view": "SAMLGroupMapView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminSamlGroupMap",
        "summary": "Update SAML group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateSAMLGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdates an SAML group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateSAMLGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `saml_group_map_id` | string (uuid) | Yes | Saml group map id identifier. |\n| `group_admin` | boolean | Yes | Group admin. |\n| `share_admin` | boolean | Yes | Share admin. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/saml_group_map.py",
          "view": "SAMLGroupMapView",
          "method": "put"
        }
      }
    },
    "/admin/saml/group/": {
      "delete": {
        "operationId": "deleteAdminSamlGroup",
        "summary": "Delete SAML group",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteSAMLGroupRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a SAML Group\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteSAMLGroupRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `saml_group_id` | string (uuid) | Yes | Saml group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/saml_group.py",
          "view": "SAMLGroupView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminSamlGroup",
        "summary": "List SAML groups",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationSAMLGroupGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReturns a list of all SAML groups\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationSAMLGroupGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `saml_groups` | array | Yes | Saml groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/saml_group.py",
          "view": "SAMLGroupView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAdminSamlGroup",
        "summary": "Sync SAML groups",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nSync SAML groups.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/saml_group.py",
          "view": "SAMLGroupView",
          "method": "post"
        }
      }
    },
    "/admin/oidc/group/map/": {
      "delete": {
        "operationId": "deleteAdminOidcGroupMap",
        "summary": "Delete OIDC group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteOIDCGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a oidc group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteOIDCGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `oidc_group_id` | string (uuid) | Yes | Oidc group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/oidc_group_map.py",
          "view": "OIDCGroupMapView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminOidcGroupMap",
        "summary": "Create OIDC group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateOIDCGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates an OIDC group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `MAPPING_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateOIDCGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `oidc_group_id` | string (uuid) | Yes | Oidc group id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/oidc_group_map.py",
          "view": "OIDCGroupMapView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminOidcGroupMap",
        "summary": "Update OIDC group mapping",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateOIDCGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdates an OIDC group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateOIDCGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `oidc_group_map_id` | string (uuid) | Yes | Oidc group map id identifier. |\n| `group_admin` | boolean | Yes | Group admin. |\n| `share_admin` | boolean | Yes | Share admin. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/oidc_group_map.py",
          "view": "OIDCGroupMapView",
          "method": "put"
        }
      }
    },
    "/admin/oidc/group/": {
      "delete": {
        "operationId": "deleteAdminOidcGroup",
        "summary": "Delete OIDC group",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteOIDCGroupRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a OIDC Group\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteOIDCGroupRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `oidc_group_id` | string (uuid) | Yes | Oidc group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/oidc_group.py",
          "view": "OIDCGroupView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminOidcGroup",
        "summary": "List OIDC groups",
        "tags": [
          "Admin · identity providers"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationOIDCGroupGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReturns a list of all OIDC groups\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationOIDCGroupGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `oidc_groups` | array | Yes | Oidc groups. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/oidc_group.py",
          "view": "OIDCGroupView",
          "method": "get"
        }
      }
    },
    "/admin/policy/{policy_id}/": {
      "get": {
        "operationId": "getAdminPolicyByPolicyId",
        "summary": "Get policy",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminPolicyByPolicyIdResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "policy_id",
            "in": "path",
            "required": true,
            "description": "Policy id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReturns a list of all policies or the details of a specific policy\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminPolicyByPolicyIdResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. |\n| `priority` | integer | Yes | Priority. |\n| `config` | object | Yes | Config. |\n| `policy_group_mappings` | array | Yes | Policy group mappings. |\n| `policy_user_mappings` | array | Yes | Policy user mappings. |\n| `default_values` | object | Yes | Effective server defaults keyed by setting name. Value types follow the configuration setting (booleans, durations, strings, or lists). |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy.py",
          "view": "PolicyView",
          "method": "get"
        }
      }
    },
    "/admin/policy/user/map/": {
      "delete": {
        "operationId": "deleteAdminPolicyUserMap",
        "summary": "Delete policy user map",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeletePolicyUserMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a policy user map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeletePolicyUserMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `policy_id` | string (uuid) | Yes | Policy id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy_user_map.py",
          "view": "PolicyUserMapView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminPolicyUserMap",
        "summary": "Create policy user map",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreatePolicyUserMapRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates a policy user map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `MAPPING_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreatePolicyUserMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `policy_id` | string (uuid) | Yes | Policy id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy_user_map.py",
          "view": "PolicyUserMapView",
          "method": "post"
        }
      }
    },
    "/admin/policy/group/map/": {
      "delete": {
        "operationId": "deleteAdminPolicyGroupMap",
        "summary": "Delete policy group map",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeletePolicyGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a policy group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeletePolicyGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `policy_id` | string (uuid) | Yes | Policy id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy_group_map.py",
          "view": "PolicyGroupMapView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminPolicyGroupMap",
        "summary": "Create policy group map",
        "tags": [
          "Admin · groups and sharing"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreatePolicyGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates an Policy group map\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `MAPPING_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreatePolicyGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `policy_id` | string (uuid) | Yes | Policy id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy_group_map.py",
          "view": "PolicyGroupMapView",
          "method": "post"
        }
      }
    },
    "/admin/policy/": {
      "delete": {
        "operationId": "deleteAdminPolicy",
        "summary": "Delete policy",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeletePolicyRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a policy\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeletePolicyRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `policy_id` | string (uuid) | Yes | Policy id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy.py",
          "view": "PolicyView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminPolicy",
        "summary": "List policies",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminPolicyResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReturns a list of all policies or the details of a specific policy\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminPolicyResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `policies` | array | Yes | Policies. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy.py",
          "view": "PolicyView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAdminPolicy",
        "summary": "Create policy",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreatePolicyRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/AdministrationPolicyPostResult201Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates a policy\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreatePolicyRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `priority` | number | Yes | Priority. |\n| `config` | object | Yes | Config. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `AdministrationPolicyPostResult201Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `policy_id` | string | Yes | Policy id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy.py",
          "view": "PolicyView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminPolicy",
        "summary": "Update policy",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdatePolicyRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdates a policy\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdatePolicyRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `policy_id` | string (uuid) | Yes | Policy id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `priority` | number | Yes | Priority. |\n| `config` | object | Yes | Config. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/policy.py",
          "view": "PolicyView",
          "method": "put"
        }
      }
    },
    "/admin/user-wipe/": {
      "post": {
        "operationId": "postAdminUserWipe",
        "summary": "Wipe user account",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationWipeUserRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationUserWipePostResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nWipes a user\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationWipeUserRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `password` | string | No | Password value for the operation; password and authkey are different credentials. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationUserWipePostResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `password` | string | Yes | Password value for the operation; password and authkey are different credentials. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user_wipe.py",
          "view": "UserWipeView",
          "method": "post"
        }
      }
    },
    "/admin/user-password-reset/{user_id}/": {
      "get": {
        "operationId": "getAdminUserPasswordResetByUserId",
        "summary": "Get user password-reset material",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationUserPasswordResetGetResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "description": "User id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nGet user password-reset material.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `PASSWORD_RESET_NOT_AVAILABLE`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationUserPasswordResetGetResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `username` | string | Yes | Account username, normally including the configured domain. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. |\n| `hashing_algorithm` | string | Yes | Hashing algorithm. |\n| `hashing_parameters` | object | Yes | Hashing parameters. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user_password_reset.py",
          "view": "UserPasswordResetView",
          "method": "get"
        }
      },
      "put": {
        "operationId": "putAdminUserPasswordResetByUserId",
        "summary": "Reset user password",
        "tags": [
          "Admin · users"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUserPasswordResetRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "description": "User id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReset user password.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ADMIN_PERMISSION_DENIED`, `ADMIN_RECOVERY_DOES_NOT_EXIST`, `INVALID_HASHING_PARAMETER`, `NO_PERMISSION_OR_NOT_EXIST`, `PASSWORD_RESET_NOT_AVAILABLE`, `USER_WITH_USERNAME_ALREADY_EXISTS`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUserPasswordResetRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `username` | string (email) | No | Account username, normally including the configured domain. Maximum length: 254. |\n| `authkey` | string | Yes | Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key. Maximum length: 128. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. Maximum length: 160. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 48. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. Maximum length: 160. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 48. |\n| `user_sauce` | string | Yes | User sauce. Maximum length: 64. |\n| `require_password_change` | boolean | No | Require password change. Default: `true`. |\n| `hashing_algorithm` | string | No | Hashing algorithm. |\n| `hashing_parameters` | object | No | Hashing parameters. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/user_password_reset.py",
          "view": "UserPasswordResetView",
          "method": "put"
        }
      }
    },
    "/admin/gateway-cluster/configuration/": {
      "post": {
        "operationId": "postAdminGatewayClusterConfiguration",
        "summary": "Generate gateway cluster configuration",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteFileserverClusterRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AdministrationFileserverClusterConfigPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nGenerate gateway cluster configuration.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteFileserverClusterRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AdministrationFileserverClusterConfigPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `configuration` | object | Yes | Configuration. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster_config.py",
          "view": "GatewayClusterConfigView",
          "method": "post"
        }
      }
    },
    "/admin/gateway-cluster/user/map/": {
      "delete": {
        "operationId": "deleteAdminGatewayClusterUserMap",
        "summary": "Delete gateway cluster user map",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteGatewayClusterUserMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDelete gateway cluster user map.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteGatewayClusterUserMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster_user_map.py",
          "view": "GatewayClusterUserMapView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminGatewayClusterUserMap",
        "summary": "Create gateway cluster user map",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateGatewayClusterUserMapRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreate gateway cluster user map.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `MAPPING_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateGatewayClusterUserMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster_user_map.py",
          "view": "GatewayClusterUserMapView",
          "method": "post"
        }
      }
    },
    "/admin/gateway-cluster/group/map/": {
      "delete": {
        "operationId": "deleteAdminGatewayClusterGroupMap",
        "summary": "Delete gateway cluster group map",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteGatewayClusterGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDelete gateway cluster group map.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteGatewayClusterGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster_group_map.py",
          "view": "GatewayClusterGroupMapView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postAdminGatewayClusterGroupMap",
        "summary": "Create gateway cluster group map",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateGatewayClusterGroupMapRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreate gateway cluster group map.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `MAPPING_ALREADY_EXISTS`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateGatewayClusterGroupMapRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster_group_map.py",
          "view": "GatewayClusterGroupMapView",
          "method": "post"
        }
      }
    },
    "/admin/gateway-cluster/{cluster_id}/": {
      "get": {
        "operationId": "getAdminGatewayClusterByClusterId",
        "summary": "Get gateway cluster",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminGatewayClusterByClusterIdResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "cluster_id",
            "in": "path",
            "required": true,
            "description": "Cluster id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nGet gateway cluster.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminGatewayClusterByClusterIdResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string,null (date-time) | Yes | Last write time in ISO 8601 format. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. |\n| `allow_all` | boolean | Yes | Allow all. |\n| `gateway_cluster_user_mappings` | array | Yes | Gateway cluster user mappings. |\n| `gateway_cluster_group_mappings` | array | Yes | Gateway cluster group mappings. |\n| `gateways` | array | Yes | Gateways. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster.py",
          "view": "GatewayClusterView",
          "method": "get"
        }
      }
    },
    "/admin/gateway-cluster/": {
      "delete": {
        "operationId": "deleteAdminGatewayCluster",
        "summary": "Delete gateway cluster",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationDeleteFileserverClusterRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDelete gateway cluster.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationDeleteFileserverClusterRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster.py",
          "view": "GatewayClusterView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getAdminGatewayCluster",
        "summary": "List gateway clusters",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminGatewayClusterResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nList gateway clusters.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminGatewayClusterResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `clusters` | array | Yes | Clusters. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster.py",
          "view": "GatewayClusterView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postAdminGatewayCluster",
        "summary": "Create gateway cluster",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationCreateGatewayClusterRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiUserYubikeyOTPPutResult201"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreate gateway cluster.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationCreateGatewayClusterRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `allow_all` | boolean | No | Allow all. Default: `true`. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiUserYubikeyOTPPutResult201`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster.py",
          "view": "GatewayClusterView",
          "method": "post"
        }
      },
      "put": {
        "operationId": "putAdminGatewayCluster",
        "summary": "Update gateway cluster",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/AdministrationUpdateGatewayClusterRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdate gateway cluster.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `AdministrationUpdateGatewayClusterRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n| `title` | string | Yes | Title or display label. For vault/share titles, provide the encrypted value with title_nonce. Maximum length: 256. |\n| `allow_all` | boolean | Yes | Allow all. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway_cluster.py",
          "view": "GatewayClusterView",
          "method": "put"
        }
      }
    },
    "/admin/gateway/{gateway_id}/": {
      "get": {
        "operationId": "getAdminGatewayByGatewayId",
        "summary": "Get gateway",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminGatewayByGatewayIdResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "gateway_id",
            "in": "path",
            "required": true,
            "description": "Gateway id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nGet gateway.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminGatewayByGatewayIdResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | string | Yes | Id identifier. |\n| `create_date` | string,null (date-time) | Yes | Creation time in ISO 8601 format. |\n| `write_date` | string,null (date-time) | Yes | Last write time in ISO 8601 format. |\n| `create_ip` | string | Yes | Create ip. |\n| `cluster_id` | string | Yes | Cluster id identifier. |\n| `cluster_title` | string | Yes | Cluster title. |\n| `public_key` | string | Yes | Hex-encoded public key. |\n| `url` | string | Yes | Url. |\n| `version` | string | Yes | Version. |\n| `hostname` | string | Yes | Hostname. |\n| `valid_till` | string,null (date-time) | Yes | Expiration time in ISO 8601 format. |\n| `alive` | boolean | Yes | Alive. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway.py",
          "view": "GatewayView",
          "method": "get"
        }
      }
    },
    "/admin/gateway/": {
      "get": {
        "operationId": "getAdminGateway",
        "summary": "List gateways",
        "tags": [
          "Admin · gateways"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "MANAGEMENT_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/getAdminGatewayResultEnterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Zero-based page number. Used with page_size.",
              "minimum": 0
            },
            "description": "Zero-based page number. Used with page_size."
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records per page. When omitted, pagination may be disabled by this operation.",
              "minimum": 1
            },
            "description": "Number of records per page. When omitted, pagination may be disabled by this operation."
          },
          {
            "name": "ordering",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort field; a leading minus sign requests descending order."
            },
            "description": "Sort field; a leading minus sign requests descending order."
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Search text used to filter the returned records."
            },
            "description": "Search text used to filter the returned records."
          }
        ],
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nList gateways.\n\nRequires the corresponding administrative capability and tenant scope. Superusers have global access; delegated administrators are limited to the users/groups in their authorized tenants. Management must be enabled.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`, `INVALID_ORDERING`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Configuration required:** `MANAGEMENT_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `getAdminGatewayResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `count` | integer,null | Yes | Number of records requested/returned; see the operation pagination rules. |\n| `gateways` | array | Yes | Gateways. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "administration/views/gateway.py",
          "view": "GatewayView",
          "method": "get"
        }
      }
    },
    "/fileserver/alive/": {
      "put": {
        "operationId": "putFileserverAlive",
        "summary": "Send file-server heartbeat",
        "tags": [
          "File-server coordination"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "FILESERVER_HANDLER_ENABLED",
        "security": [
          {
            "FileserverToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "fileserver-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUpdates the \"alive\" value in the database\n\n**Configuration required:** `FILESERVER_HANDLER_ENABLED`.\n\n**Encryption:** [File-server SecretBox](protocol.html#file-transfer-and-service-credentials)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "fileserver/views/alive.py",
          "view": "AliveView",
          "method": "put"
        }
      }
    },
    "/fileserver/upload/authorize/": {
      "put": {
        "operationId": "putFileserverUploadAuthorize",
        "summary": "Authorize chunk upload",
        "tags": [
          "File-server coordination"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "FILESERVER_HANDLER_ENABLED",
        "security": [
          {
            "FileserverToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "fileserver-secretbox",
          "guide": "protocol.html#file-server-tickets",
          "requestPayload": {
            "$ref": "#/components/schemas/FileserverFileserverAuthorizeUploadRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/FileserverAuthorizeUploadPutResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          },
          "requestFieldPayloads": {
            "ticket": {
              "$ref": "#/components/schemas/UploadTransferTicket"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUnpacks the authorization information. Checks the user permission (e.g. quota).\n\nValidation may return: `HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION`.\n\nThe authenticated file server must have permission on the transfer shard.\n\n**Configuration required:** `FILESERVER_HANDLER_ENABLED`.\n\n**Encryption:** [File-server SecretBox](protocol.html#file-server-tickets)\n\n### Payload before transport encryption\n\nSchema: `FileserverFileserverAuthorizeUploadRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_transfer_id` | string (uuid) | Yes | File transfer id identifier. |\n| `ticket` | string | Yes | Ticket. |\n| `ticket_nonce` | string | Yes | Hex-encoded nonce for ticket. |\n| `chunk_size` | integer | Yes | Chunk size. |\n| `hash_checksum` | string | Yes | Hash checksum. |\n| `ip_address` | string | Yes | Ip address. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `FileserverAuthorizeUploadPutResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shard_id` | string | Yes | Shard id identifier. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```\n\n### JSON inside request field `ticket`\n\nSchema: `UploadTransferTicket`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `hash_checksum` | string | Yes | Blake2b chunk checksum in hex. |\n| `chunk_position` | integer | Yes | Chunk position. |",
        "x-psono-source": {
          "file": "fileserver/views/authorize_upload.py",
          "view": "AuthorizeUploadView",
          "method": "put"
        }
      }
    },
    "/fileserver/download/authorize/": {
      "put": {
        "operationId": "putFileserverDownloadAuthorize",
        "summary": "Authorize chunk download",
        "tags": [
          "File-server coordination"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "FILESERVER_HANDLER_ENABLED",
        "security": [
          {
            "FileserverToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "fileserver-secretbox",
          "guide": "protocol.html#file-server-tickets",
          "requestPayload": {
            "$ref": "#/components/schemas/FileserverFileserverAuthorizeDownloadRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/FileserverAuthorizeDownloadPutResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          },
          "requestFieldPayloads": {
            "ticket": {
              "$ref": "#/components/schemas/DownloadTransferTicket"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUnpacks the authorization information. Checks the user permission (e.g. quota).\n\nValidation may return: `HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION`, `NO_PERMISSION_OR_NOT_EXIST`.\n\nThe authenticated file server must have permission on the transfer shard.\n\n**Configuration required:** `FILESERVER_HANDLER_ENABLED`.\n\n**Encryption:** [File-server SecretBox](protocol.html#file-server-tickets)\n\n### Payload before transport encryption\n\nSchema: `FileserverFileserverAuthorizeDownloadRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_transfer_id` | string (uuid) | Yes | File transfer id identifier. |\n| `ticket` | string | Yes | Ticket. |\n| `ticket_nonce` | string | Yes | Hex-encoded nonce for ticket. |\n| `ip_address` | string | Yes | Ip address. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `FileserverAuthorizeDownloadPutResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shard_id` | string | Yes | Shard id identifier. |\n| `hash_checksum` | string | Yes | Hash checksum. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```\n\n### JSON inside request field `ticket`\n\nSchema: `DownloadTransferTicket`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `hash_checksum` | string | Yes | Blake2b chunk checksum in hex. |",
        "x-psono-source": {
          "file": "fileserver/views/authorize_download.py",
          "view": "AuthorizeDownloadView",
          "method": "put"
        }
      }
    },
    "/fileserver/download/revoke/": {
      "put": {
        "operationId": "putFileserverDownloadRevoke",
        "summary": "Revoke chunk download",
        "tags": [
          "File-server coordination"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "FILESERVER_HANDLER_ENABLED",
        "security": [
          {
            "FileserverToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "fileserver-secretbox",
          "guide": "protocol.html#file-server-tickets",
          "requestPayload": {
            "$ref": "#/components/schemas/FileserverFileserverAuthorizeDownloadRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          },
          "requestFieldPayloads": {
            "ticket": {
              "$ref": "#/components/schemas/DownloadTransferTicket"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nUnpacks the authorization information. Checks the user permission (e.g. quota).\n\nValidation may return: `HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION`, `NO_PERMISSION_OR_NOT_EXIST`.\n\nThe authenticated file server must have permission on the transfer shard.\n\n**Configuration required:** `FILESERVER_HANDLER_ENABLED`.\n\n**Encryption:** [File-server SecretBox](protocol.html#file-server-tickets)\n\n### Payload before transport encryption\n\nSchema: `FileserverFileserverAuthorizeDownloadRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `file_transfer_id` | string (uuid) | Yes | File transfer id identifier. |\n| `ticket` | string | Yes | Ticket. |\n| `ticket_nonce` | string | Yes | Hex-encoded nonce for ticket. |\n| `ip_address` | string | Yes | Ip address. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```\n\n### JSON inside request field `ticket`\n\nSchema: `DownloadTransferTicket`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `hash_checksum` | string | Yes | Blake2b chunk checksum in hex. |",
        "x-psono-source": {
          "file": "fileserver/views/revoke_download.py",
          "view": "RevokeDownloadView",
          "method": "put"
        }
      }
    },
    "/fileserver/chunks/cleanup/": {
      "get": {
        "operationId": "getFileserverChunksCleanup",
        "summary": "List chunks pending deletion",
        "tags": [
          "File-server coordination"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "FILESERVER_HANDLER_ENABLED",
        "security": [
          {
            "FileserverToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "fileserver-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/FileserverCleanupChunksGetResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nReturns the chunks that should be cleaned up by this fileserver\n\n**Configuration required:** `FILESERVER_HANDLER_ENABLED`.\n\n**Encryption:** [File-server SecretBox](protocol.html#file-transfer-and-service-credentials)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `FileserverCleanupChunksGetResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `shards` | object | Yes | Shards. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "fileserver/views/cleanup_chunks.py",
          "view": "CleanupChunksView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postFileserverChunksCleanup",
        "summary": "Confirm chunk deletion",
        "tags": [
          "File-server coordination"
        ],
        "x-psono-editions": [
          "CE",
          "EE"
        ],
        "x-psono-requires-configuration": "FILESERVER_HANDLER_ENABLED",
        "security": [
          {
            "FileserverToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "fileserver-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/FileserverFileserverConfirmChunkDeletionRequest"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Community + Enterprise**\n\n\n\nConfirm chunk deletion.\n\n**Configuration required:** `FILESERVER_HANDLER_ENABLED`.\n\n**Encryption:** [File-server SecretBox](protocol.html#file-transfer-and-service-credentials)\n\n### Payload before transport encryption\n\nSchema: `FileserverFileserverConfirmChunkDeletionRequest`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `deleted_chunks` | array | Yes | Deleted chunks. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "fileserver/views/cleanup_chunks.py",
          "view": "CleanupChunksView",
          "method": "post"
        }
      }
    },
    "/server-secret/": {
      "delete": {
        "operationId": "deleteServerSecret",
        "summary": "Remove server-held user keys",
        "tags": [
          "Enterprise jobs and keys"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/EnterpriseDeleteServerSecretRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nChecks the REST Token and deletes a users server secret and private key while setting the provided private keys and so on\n\nValidation may return: `CANNOT_REUSE_OLD_PASSWORD`, `INVALID_HASHING_PARAMETER`, `NO_VALID_HEX`, `OPERATION_NOT_ALLOWED`, `SERVER_SECRET_DOES_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `EnterpriseDeleteServerSecretRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `authkey` | string | Yes | Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 64. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `user_sauce` | string | Yes | User sauce. Maximum length: 64. |\n| `hashing_algorithm` | string | No | Hashing algorithm. |\n| `hashing_parameters` | object | No | Hashing parameters. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "enterprise/views/server_secret.py",
          "view": "ServerSecretView",
          "method": "delete"
        }
      },
      "post": {
        "operationId": "postServerSecret",
        "summary": "Store server-held user keys",
        "tags": [
          "Enterprise jobs and keys"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/EnterpriseCreateServerSecretRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nChecks the REST Token and creates the users server secret and private key\n\nValidation may return: `INCORRECT_SECRET_KEY`, `NO_VALID_HEX`, `OPERATION_NOT_ALLOWED`, `SERVER_SECRET_ALREADY_EXISTS`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `EnterpriseCreateServerSecretRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `private_key` | string | Yes | User private key in hex for Enterprise server-held key provisioning. Protected by the session transport envelope. Maximum length: 64. |\n| `secret_key` | string | Yes | User symmetric secret key in hex for Enterprise server-held key provisioning. Protected by the session transport envelope. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "enterprise/views/server_secret.py",
          "view": "ServerSecretView",
          "method": "post"
        }
      }
    },
    "/job/staff-missing-group-secret/": {
      "post": {
        "operationId": "postJobStaffMissingGroupSecret",
        "summary": "Provide group keys for staff",
        "tags": [
          "Enterprise jobs and keys"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/EnterpriseCreateJobStaffMissingGroupSecretRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nChecks the REST Token and creates group user secret for a staff member\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `PRIVATE_KEY_NO_VALID_HEX`, `SECRET_KEY_NO_VALID_HEX`, `USER_DOES_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `EnterpriseCreateJobStaffMissingGroupSecretRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_id` | string (uuid) | Yes | User id identifier. |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "enterprise/views/job_staff_missing_group_secret.py",
          "view": "JobStaffMissingGroupSecretView",
          "method": "post"
        }
      }
    },
    "/job/membership-missing-group-secret/": {
      "post": {
        "operationId": "postJobMembershipMissingGroupSecret",
        "summary": "Provide group keys for a membership",
        "tags": [
          "Enterprise jobs and keys"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/EnterpriseCreateJobMembershipMissingGroupSecretRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nChecks the REST Token and updates the group secrets of a membership\n\nValidation may return: `NO_PERMISSION_OR_NOT_EXIST`, `PRIVATE_KEY_NO_VALID_HEX`, `SECRET_KEY_NO_VALID_HEX`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `EnterpriseCreateJobMembershipMissingGroupSecretRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `membership_id` | string (uuid) | Yes | Membership id identifier. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 64. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "enterprise/views/job_membership_missing_group_secret.py",
          "view": "JobMembershipMissingGroupSecret",
          "method": "post"
        }
      }
    },
    "/job/user-missing-admin-secret/": {
      "post": {
        "operationId": "postJobUserMissingAdminSecret",
        "summary": "Provide user recovery keys",
        "tags": [
          "Enterprise jobs and keys"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/EnterpriseCreateJobUserMissingAdminSecretRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nProvide user recovery keys.\n\nValidation may return: `ADMIN_RECOVERY_PUBLIC_KEY_INVALID`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `EnterpriseCreateJobUserMissingAdminSecretRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. Maximum length: 160. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 48. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. Maximum length: 160. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 48. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "enterprise/views/job_user_missing_admin_secret.py",
          "view": "JobUserMissingAdminSecretView",
          "method": "post"
        }
      }
    },
    "/job/group-missing-admin-secret/": {
      "post": {
        "operationId": "postJobGroupMissingAdminSecret",
        "summary": "Provide group recovery keys",
        "tags": [
          "Enterprise jobs and keys"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/EnterpriseCreateJobGroupMissingAdminSecretRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nProvide group recovery keys.\n\nValidation may return: `ADMIN_RECOVERY_PUBLIC_KEY_INVALID`, `NO_PERMISSION_OR_NOT_EXIST`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `EnterpriseCreateJobGroupMissingAdminSecretRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `group_id` | string (uuid) | Yes | Group id identifier. |\n| `private_key` | string | Yes | Encrypted private key; never send an unencrypted vault private key here. Maximum length: 160. |\n| `private_key_nonce` | string | Yes | Hex-encoded nonce for private key. Maximum length: 48. |\n| `secret_key` | string | Yes | Symmetric key material, wrapped/encrypted as specified by this operation. Maximum length: 160. |\n| `secret_key_nonce` | string | Yes | Hex-encoded nonce for secret key. Maximum length: 48. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "enterprise/views/job_group_missing_admin_secret.py",
          "view": "JobGroupMissingAdminSecretView",
          "method": "post"
        }
      }
    },
    "/job/": {
      "get": {
        "operationId": "getJob",
        "summary": "List pending key-provisioning jobs",
        "tags": [
          "Enterprise jobs and keys"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/EnterprisePendingJobs"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nList pending key-provisioning jobs.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `EnterprisePendingJobs`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `memberships_missing_group_secrets` | array | No | Memberships missing group secrets. |\n| `staff_missing_group_secrets` | array | No | Staff missing group secrets. |\n| `users_missing_admin_secrets` | array | No | Users missing admin secrets. |\n| `groups_missing_admin_secrets` | array | No | Groups missing admin secrets. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "enterprise/views/job.py",
          "view": "JobView",
          "method": "get"
        }
      }
    },
    "/saml/login/": {
      "post": {
        "operationId": "postSamlLogin",
        "summary": "Complete SAML login",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "sso-login-box",
          "requestFieldPayloads": {
            "login_info": {
              "$ref": "#/components/schemas/SamlLoginInfoPayload"
            }
          },
          "responseFieldPayloads": {
            "200": {
              "login_info": {
                "$ref": "#/components/schemas/SamlLoginResultEnterprise"
              },
              "login_info.data": {
                "$ref": "#/components/schemas/SamlSessionDetails"
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EnterpriseSamlLoginRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseSamlLoginPostResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCompletes SAML login using the one-time provider token and returns the session details.\n\nThe whole exchange runs in a single transaction: it begins with the row lock on the\nSAML_Token (select_for_update in the serializer) and ends with the assignment of the\nsession Token to the SAML_Token, which marks it as consumed (token IS NOT NULL).\nThis closes the race where two concurrent exchanges could both observe the token\nas unused and mint two sessions, and keeps the token assignment consistent with\nthe created session even on errors in between.\n\nValidation may return: `IP_ADDRESS_NOT_ALLOWED`, `LOGIN_INFO_CANNOT_BE_DECRYPTED`, `NO_SAML_TOKEN_ID_PROVIDED`, `SAML_TOKEN_NOT_FOUND_ALREADY_USED_OR_EXPIRED`, `USER_NOT_PART_OF_REQUIRED_GROUP`.\n\n**Configuration required:** `AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS`.\n\n**Encryption:** [Double-boxed SSO login](protocol.html#enterprise-saml-and-oidc)\n\n### JSON inside request field `login_info`\n\nSchema: `SamlLoginInfoPayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `saml_token_id` | string (uuid) | Yes | One-time token returned by the identity-provider browser exchange. |\n| `device_fingerprint` | string | No | Client device/session fingerprint. |\n| `device_description` | string | No | Client device description. |\n| `device_time` | string (date-time) | No | Client time used for replay protection. |\n| `client_type` | string | No | Client type. |\n\n### Decrypted response field `login_info` · HTTP 200\n\nSchema: `SamlLoginResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `data` | string | Yes | Ephemeral Box ciphertext containing the session details, not vault content. |\n| `data_nonce` | string | Yes | Hex-encoded nonce for the encrypted content, separate from the transport nonce. |\n| `server_session_public_key` | string | Yes | Server session public key. |\n\n### Decrypted response field `login_info.data` · HTTP 200\n\nSchema: `SamlSessionDetails`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_validator` | string | Yes | Encrypted user-validator challenge used for token activation. |\n| `user_validator_nonce` | string | Yes | Hex-encoded nonce for user validator. |\n| `token` | string | Yes | Authentication token returned by the indicated exchange. |\n| `session_key` | string | Yes | Session identifier/key distinct from the symmetric session encryption key. |\n| `required_multifactors` | array | Yes | Required multifactors. |\n| `session_secret_key` | string | Yes | Session encryption key, encrypted/wrapped in login exchanges as described by the protocol. |\n| `password` | string,null | Yes | Password value for the operation; password and authkey are different credentials. |\n| `user` | object | Yes | User. |",
        "x-psono-source": {
          "file": "enterprise/views/saml_login.py",
          "view": "SamlLoginView",
          "method": "post"
        }
      }
    },
    "/saml/{saml_provider_id}/metadata/": {
      "get": {
        "operationId": "getSamlBySamlProviderIdMetadata",
        "summary": "Get SAML service-provider metadata",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "saml_provider_id",
            "in": "path",
            "required": true,
            "description": "Saml provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseSamlMetadataGetResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReturns service-provider metadata XML for the configured SAML provider. Configure this metadata in the identity provider. No session token is required.\n\n**Configuration required:** `AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/saml_metadata.py",
          "view": "SamlMetadataView",
          "method": "get"
        }
      }
    },
    "/saml/{saml_provider_id}/initiate-login/": {
      "post": {
        "operationId": "postSamlBySamlProviderIdInitiateLogin",
        "summary": "Start SAML login",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "saml_provider_id",
            "in": "path",
            "required": true,
            "description": "Saml provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EnterpriseSamlInitiateLoginRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseSamlInitiateLoginPostResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nFirst step in the SAML login process. Takes a \"return to url\", packs it together in a SAML request and returns\nthe redirect url, so the client knows where to redirect the user to\n\nValidation may return: `SAML_CONFIGURATION_DOES_NOT_EXIST`, `SAML_CONFIGURATION_ID_NOT_SPECIFIED`, `SAML_CONFIGURATION_IS_NOT_VALID`, `SAML_RETURN_TO_URL_NOT_ALLOWED`.\n\n**Configuration required:** `AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/saml_initiate_login.py",
          "view": "SamlInitiateLoginView",
          "method": "post"
        }
      }
    },
    "/saml/{saml_provider_id}/acs/": {
      "post": {
        "operationId": "postSamlBySamlProviderIdAcs",
        "summary": "Process SAML assertion",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "saml_provider_id",
            "in": "path",
            "required": true,
            "description": "Saml provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseSamlAssertionConsumerServicePostResult200Enterprise"
                }
              }
            }
          },
          "302": {
            "description": "Browser redirect to the configured identity provider or client return URL.",
            "headers": {
              "Location": {
                "description": "Redirect destination.",
                "schema": {
                  "type": "string",
                  "format": "uri"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nSecond step of the login process. Validates the SAML Response from the IDP and redirects the user to the specified\nreturn url. Creates the saml token database entry. Attaches the created saml token id to the return url as parameter.\n\nValidation may return: `SAML_CONFIGURATION_DOES_NOT_EXIST`, `SAML_CONFIGURATION_ID_NOT_SPECIFIED`, `SAML_CONFIGURATION_IS_NOT_VALID`, `SAML_EMAIL_ATTRIBUTE_NOT_IN_ATTRIBUTES`, `SAML_RETURN_TO_URL_NOT_ALLOWED`, `SAML_USERNAME_ATTRIBUTE_NOT_IN_ATTRIBUTES`.\n\n**Configuration required:** `AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/saml_assertion_consumer_service.py",
          "view": "SamlAssertionConsumerServiceView",
          "method": "post"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/SamlAssertionForm"
              }
            }
          }
        }
      }
    },
    "/saml/{saml_provider_id}/sls/": {
      "get": {
        "operationId": "getSamlBySamlProviderIdSls",
        "summary": "Process SAML logout",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "saml_provider_id",
            "in": "path",
            "required": true,
            "description": "Saml provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          },
          {
            "name": "SAMLRequest",
            "in": "query",
            "required": false,
            "description": "SAML logout-flow parameter supplied by the identity provider/client.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "SAMLResponse",
            "in": "query",
            "required": false,
            "description": "SAML logout-flow parameter supplied by the identity provider/client.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "RelayState",
            "in": "query",
            "required": false,
            "description": "SAML logout-flow parameter supplied by the identity provider/client.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "SigAlg",
            "in": "query",
            "required": false,
            "description": "SAML logout-flow parameter supplied by the identity provider/client.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Signature",
            "in": "query",
            "required": false,
            "description": "SAML logout-flow parameter supplied by the identity provider/client.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
                }
              }
            }
          },
          "302": {
            "description": "Browser redirect to the configured identity provider or client return URL.",
            "headers": {
              "Location": {
                "description": "Redirect destination.",
                "schema": {
                  "type": "string",
                  "format": "uri"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCheck the health of the application\n\nValidation may return: `SAML_CONFIGURATION_DOES_NOT_EXIST`, `SAML_CONFIGURATION_ID_NOT_SPECIFIED`, `SAML_CONFIGURATION_IS_NOT_VALID`.\n\n**Configuration required:** `AUTHENTICATION_METHODS includes SAML; SAML_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/saml_logout_service.py",
          "view": "SamlLogoutServiceView",
          "method": "get"
        }
      }
    },
    "/oidc/login/": {
      "post": {
        "operationId": "postOidcLogin",
        "summary": "Complete OIDC login",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "sso-login-box",
          "requestFieldPayloads": {
            "login_info": {
              "$ref": "#/components/schemas/OidcLoginInfoPayload"
            }
          },
          "responseFieldPayloads": {
            "200": {
              "login_info": {
                "$ref": "#/components/schemas/OidcLoginResultEnterprise"
              },
              "login_info.data": {
                "$ref": "#/components/schemas/OidcSessionDetails"
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EnterpriseOidcLoginRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseSamlLoginPostResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCompletes OIDC login using the one-time provider token and returns the session details.\n\nThe whole exchange runs in a single transaction: it begins with the row lock on the\nOIDC_State_Token (select_for_update in the serializer) and ends with the creation of\nthe session Token and the assignment of the user to the OIDC_State_Token, which\nmarks the state token as consumed (user IS NOT NULL) and prevents any replay.\n\nValidation may return: `IP_ADDRESS_NOT_ALLOWED`, `LOGIN_INFO_CANNOT_BE_DECRYPTED`, `NO_OIDC_TOKEN_ID_PROVIDED`, `OIDC_TOKEN_NOT_FOUND_ALREADY_USED_OR_EXPIRED`, `USER_NOT_PART_OF_REQUIRED_GROUP`.\n\n**Configuration required:** `AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS`.\n\n**Encryption:** [Double-boxed SSO login](protocol.html#enterprise-saml-and-oidc)\n\n### JSON inside request field `login_info`\n\nSchema: `OidcLoginInfoPayload`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `oidc_token_id` | string (uuid) | Yes | One-time token returned by the identity-provider browser exchange. |\n| `device_fingerprint` | string | No | Client device/session fingerprint. |\n| `device_description` | string | No | Client device description. |\n| `device_time` | string (date-time) | No | Client time used for replay protection. |\n| `client_type` | string | No | Client type. |\n\n### Decrypted response field `login_info` · HTTP 200\n\nSchema: `OidcLoginResultEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `data` | string | Yes | Ephemeral Box ciphertext containing the session details, not vault content. |\n| `data_nonce` | string | Yes | Hex-encoded nonce for the encrypted content, separate from the transport nonce. |\n| `server_session_public_key` | string | Yes | Server session public key. |\n\n### Decrypted response field `login_info.data` · HTTP 200\n\nSchema: `OidcSessionDetails`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `user_validator` | string | Yes | Encrypted user-validator challenge used for token activation. |\n| `user_validator_nonce` | string | Yes | Hex-encoded nonce for user validator. |\n| `token` | string | Yes | Authentication token returned by the indicated exchange. |\n| `session_key` | string | Yes | Session identifier/key distinct from the symmetric session encryption key. |\n| `required_multifactors` | array | Yes | Required multifactors. |\n| `session_secret_key` | string | Yes | Session encryption key, encrypted/wrapped in login exchanges as described by the protocol. |\n| `password` | string,null | Yes | Password value for the operation; password and authkey are different credentials. |\n| `user` | object | Yes | User. |",
        "x-psono-source": {
          "file": "enterprise/views/oidc_login.py",
          "view": "OidcLoginView",
          "method": "post"
        }
      }
    },
    "/oidc/proxy-redirect/{oidc_state_token_id}/": {
      "get": {
        "operationId": "getOidcProxyRedirectByOidcStateTokenId",
        "summary": "Redirect OIDC login",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "oidc_state_token_id",
            "in": "path",
            "required": true,
            "description": "Oidc state token id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "302": {
            "description": "Browser redirect to the configured identity provider or client return URL.",
            "headers": {
              "Location": {
                "description": "Redirect destination.",
                "schema": {
                  "type": "string",
                  "format": "uri"
                }
              }
            }
          },
          "400": {
            "description": "Invalid provider or authorization/logout parameters. Django rejects the request with an HTML error response.",
            "content": {
              "text/html": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nThis proxy redirect only exists to hide the redirect_uri parameter for the Firefox extension to work proper.\nThis is necessary as Mozilla enforces that an optional redirect_uri parameter in the url (if specified) needs\nto match the firefox extension's uri for whatever reason.\nhttps://searchfox.org/mozilla-central/source/toolkit/components/extensions/child/ext-identity.js\n\n**Configuration required:** `AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/oidc_proxy_redirect.py",
          "view": "OidcProxyRedirectView",
          "method": "get"
        }
      }
    },
    "/oidc/{oidc_provider_id}/initiate-login/": {
      "post": {
        "operationId": "postOidcByOidcProviderIdInitiateLogin",
        "summary": "Start OIDC login",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "oidc_provider_id",
            "in": "path",
            "required": true,
            "description": "Oidc provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EnterpriseOidcInitiateLoginRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseOidcInitiateLoginPostResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nFirst step in the OIDC login process. Takes a \"return to url\", packs it together in a OIDC request and returns\nthe redirect url, so the client knows where to redirect the user to\n\nValidation may return: `OIDC_CONFIGURATION_DOES_NOT_EXIST`, `OIDC_CONFIGURATION_ID_NOT_SPECIFIED`, `OIDC_CONFIGURATION_IS_NOT_VALID`, `OIDC_CONFIGURATION_MISSCONFIGURED_OIDC_ALLOWED_REDIRECT_URLS`.\n\n**Configuration required:** `AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/oidc_initiate_login.py",
          "view": "OidcInitiateLoginView",
          "method": "post"
        }
      }
    },
    "/oidc/{oidc_provider_id}/callback/": {
      "get": {
        "operationId": "getOidcByOidcProviderIdCallback",
        "summary": "Process OIDC callback",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "oidc_provider_id",
            "in": "path",
            "required": true,
            "description": "Oidc provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          },
          {
            "name": "state",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "description": "State."
            },
            "description": "State."
          },
          {
            "name": "code",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Code."
            },
            "description": "Code."
          }
        ],
        "responses": {
          "302": {
            "description": "Browser redirect to the configured identity provider or client return URL.",
            "headers": {
              "Location": {
                "description": "Redirect destination.",
                "schema": {
                  "type": "string",
                  "format": "uri"
                }
              }
            }
          },
          "400": {
            "description": "Invalid provider or authorization/logout parameters. Django rejects the request with an HTML error response.",
            "content": {
              "text/html": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nOIDC authorization code flow callback path\n\n**Configuration required:** `AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/oidc_callback.py",
          "view": "OidcCallbackView",
          "method": "get"
        }
      }
    },
    "/oidc/{oidc_provider_id}/backchannel-logout/": {
      "post": {
        "operationId": "postOidcByOidcProviderIdBackchannelLogout",
        "summary": "Process OIDC backchannel logout",
        "tags": [
          "SSO · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS",
        "security": [],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "oidc_provider_id",
            "in": "path",
            "required": true,
            "description": "Oidc provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Logout processed or user not present. Empty HTTP response body."
          },
          "400": {
            "description": "Invalid provider or authorization/logout parameters. Django rejects the request with an HTML error response.",
            "content": {
              "text/html": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nOIDC backend channel logout url\n\n**Configuration required:** `AUTHENTICATION_METHODS includes OIDC; OIDC_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/oidc_backchannel_logout.py",
          "view": "OidcBackchannelLogoutView",
          "method": "post"
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/OidcBackchannelLogoutForm"
              }
            }
          }
        }
      }
    },
    "/scim/2.0/{scim_provider_id}/Users": {
      "get": {
        "operationId": "getScim20ByScimProviderIdUsers",
        "summary": "List SCIM users",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "SCIM filter expression supported for this resource."
            },
            "description": "SCIM filter expression supported for this resource."
          },
          {
            "name": "count",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records requested/returned; see the operation pagination rules.",
              "minimum": 1
            },
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          {
            "name": "startIndex",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "One-based SCIM pagination offset.",
              "minimum": 1
            },
            "description": "One-based SCIM pagination offset."
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/getScim20ByScimProviderIdUsersResultEnterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nList SCIM users.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_users.py",
          "view": "ScimUsersView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postScim20ByScimProviderIdUsers",
        "summary": "Create SCIM user",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/scim+json": {
              "schema": {
                "$ref": "#/components/schemas/EnterpriseScimCreateUserRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseScimUsersPatchResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "409": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates a user\n\nValidation may return: `EMAIL_REQUIRED`, `INVALID_USERNAME`, `USER_WITH_EMAIL_ALREADY_EXISTS`, `USER_WITH_EXTERNAL_ID_ALREADY_EXISTS`, `USER_WITH_USERNAME_ALREADY_EXISTS`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_users.py",
          "view": "ScimUsersView",
          "method": "post"
        }
      }
    },
    "/scim/2.0/{scim_provider_id}/Users/{user_id}": {
      "delete": {
        "operationId": "deleteScim20ByScimProviderIdUsersByUserId",
        "summary": "Delete SCIM user",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "description": "User id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Operation completed; no response body."
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a user by its id\n\nValidation may return: `USER_ID_NOT_PROVIDED`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_users.py",
          "view": "ScimUsersView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getScim20ByScimProviderIdUsersByUserId",
        "summary": "Get SCIM user",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "description": "User id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/getScim20ByScimProviderIdUsersByUserIdResultEnterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nGet SCIM user.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_users.py",
          "view": "ScimUsersView",
          "method": "get"
        }
      },
      "patch": {
        "operationId": "patchScim20ByScimProviderIdUsersByUserId",
        "summary": "Update SCIM user",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "description": "User id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseScimUsersPatchResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdate SCIM user.\n\nValidation may return: `EMAIL_REQUIRED`, `INVALID_USERNAME`, `SERVER_SECRET_DOES_NOT_EXIST`, `USER_ID_NOT_PROVIDED`, `USER_NOT_FOUND`, `USER_WITH_EMAIL_ALREADY_EXISTS`, `USER_WITH_USERNAME_ALREADY_EXISTS`.\n\nThe case-sensitive Operations array contains SCIM patch instructions. User synchronization handles replace operations for active, userName, displayName, and supported email paths. The SCIM parser/resource serializers accept the standard case-insensitive attribute spellings.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_users.py",
          "view": "ScimUsersView",
          "method": "patch"
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/scim+json": {
              "schema": {
                "$ref": "#/components/schemas/ScimPatchRequest"
              }
            }
          }
        }
      },
      "put": {
        "operationId": "putScim20ByScimProviderIdUsersByUserId",
        "summary": "Replace SCIM user",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "description": "User id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/scim+json": {
              "schema": {
                "$ref": "#/components/schemas/EnterpriseScimReplaceUserRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseScimUsersPatchResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReplaces a user completely (full update)\n\nValidation may return: `EMAIL_REQUIRED`, `INVALID_USERNAME`, `USER_ID_NOT_PROVIDED`, `USER_NOT_FOUND`, `USER_WITH_EMAIL_ALREADY_EXISTS`, `USER_WITH_USERNAME_ALREADY_EXISTS`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_users.py",
          "view": "ScimUsersView",
          "method": "put"
        }
      }
    },
    "/scim/2.0/{scim_provider_id}/Groups": {
      "get": {
        "operationId": "getScim20ByScimProviderIdGroups",
        "summary": "List SCIM groups",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "SCIM filter expression supported for this resource."
            },
            "description": "SCIM filter expression supported for this resource."
          },
          {
            "name": "count",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Number of records requested/returned; see the operation pagination rules.",
              "minimum": 1
            },
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          {
            "name": "startIndex",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "One-based SCIM pagination offset.",
              "minimum": 1
            },
            "description": "One-based SCIM pagination offset."
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/getScim20ByScimProviderIdGroupsResultEnterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nList SCIM groups.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_groups.py",
          "view": "ScimGroupsView",
          "method": "get"
        }
      },
      "post": {
        "operationId": "postScim20ByScimProviderIdGroups",
        "summary": "Create SCIM group",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/scim+json": {
              "schema": {
                "$ref": "#/components/schemas/EnterpriseScimCreateGroupRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseScimGroupsPostResult201Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "409": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreates a SCIM group\n\nValidation may return: `GROUP_WITH_DISPLAY_NAME_ALREADY_EXISTS`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_groups.py",
          "view": "ScimGroupsView",
          "method": "post"
        }
      }
    },
    "/scim/2.0/{scim_provider_id}/Groups/{scim_group_id}": {
      "delete": {
        "operationId": "deleteScim20ByScimProviderIdGroupsByScimGroupId",
        "summary": "Delete SCIM group",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "scim_group_id",
            "in": "path",
            "required": true,
            "description": "Scim group id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Operation completed; no response body."
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nDeletes a group by its id\n\nValidation may return: `GROUP_ID_NOT_PROVIDED`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_groups.py",
          "view": "ScimGroupsView",
          "method": "delete"
        }
      },
      "get": {
        "operationId": "getScim20ByScimProviderIdGroupsByScimGroupId",
        "summary": "Get SCIM group",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "scim_group_id",
            "in": "path",
            "required": true,
            "description": "Scim group id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/getScim20ByScimProviderIdGroupsByScimGroupIdResultEnterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nGet SCIM group.\n\nValidation may return: `ERROR_NO_VALID_INTEGER`, `ERROR_VALUE_TOO_SMALL`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_groups.py",
          "view": "ScimGroupsView",
          "method": "get"
        }
      },
      "patch": {
        "operationId": "patchScim20ByScimProviderIdGroupsByScimGroupId",
        "summary": "Update SCIM group",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "scim_group_id",
            "in": "path",
            "required": true,
            "description": "Scim group id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseScimGroupsPatchResult200Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdate SCIM group.\n\nValidation may return: `GROUP_ID_NOT_PROVIDED`, `GROUP_NOT_FOUND`.\n\nThe case-sensitive Operations array contains SCIM patch instructions. User synchronization handles replace operations for active, userName, displayName, and supported email paths. The SCIM parser/resource serializers accept the standard case-insensitive attribute spellings.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_groups.py",
          "view": "ScimGroupsView",
          "method": "patch"
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/scim+json": {
              "schema": {
                "$ref": "#/components/schemas/ScimPatchRequest"
              }
            }
          }
        }
      },
      "put": {
        "operationId": "putScim20ByScimProviderIdGroupsByScimGroupId",
        "summary": "Replace SCIM group",
        "tags": [
          "SCIM · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "SCIM_CONFIGURATIONS",
        "security": [
          {
            "ScimBearer": []
          }
        ],
        "x-psono-encryption": {
          "profile": "none"
        },
        "parameters": [
          {
            "name": "scim_provider_id",
            "in": "path",
            "required": true,
            "description": "Scim provider id identifier.",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "name": "scim_group_id",
            "in": "path",
            "required": true,
            "description": "Scim group id identifier.",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/scim+json": {
              "schema": {
                "$ref": "#/components/schemas/EnterpriseScimReplaceGroupRequestEnterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation completed successfully.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/EnterpriseScimGroupsPostResult201Enterprise"
                }
              }
            }
          },
          "400": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "404": {
            "description": "Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimError"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nReplaces a SCIM group completely (full update)\n\nValidation may return: `GROUP_ID_NOT_PROVIDED`, `GROUP_NOT_FOUND`.\n\n**Configuration required:** `SCIM_CONFIGURATIONS`.\n\n**Encryption:** [No session envelope](protocol.html#wire-format-versus-logical-payload)",
        "x-psono-source": {
          "file": "enterprise/views/scim_groups.py",
          "view": "ScimGroupsView",
          "method": "put"
        }
      }
    },
    "/gateway/alive/": {
      "put": {
        "operationId": "putGatewayAlive",
        "summary": "Send gateway heartbeat",
        "tags": [
          "Gateway · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "GATEWAY_HANDLER_ENABLED",
        "security": [
          {
            "GatewayToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "gateway-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/RestapiGAVerifyPostResult200"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nUpdates the \"alive\" value in the database\n\n**Configuration required:** `GATEWAY_HANDLER_ENABLED`.\n\n**Encryption:** [Gateway SecretBox](protocol.html#file-transfer-and-service-credentials)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `RestapiGAVerifyPostResult200`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "gateway/views/alive.py",
          "view": "AliveView",
          "method": "put"
        }
      }
    },
    "/gateway/clusters/": {
      "get": {
        "operationId": "getGatewayClusters",
        "summary": "List available gateway clusters",
        "tags": [
          "Gateway · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "GATEWAY_HANDLER_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/AvailableGatewayClusters"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nList available gateway clusters.\n\n**Configuration required:** `GATEWAY_HANDLER_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `AvailableGatewayClusters`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `clusters` | array | Yes | Clusters. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "gateway/views/gateway_clusters.py",
          "view": "GatewayClustersView",
          "method": "get"
        }
      }
    },
    "/gateway/launch/": {
      "post": {
        "operationId": "postGatewayLaunch",
        "summary": "Create gateway connection",
        "tags": [
          "Gateway · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "GATEWAY_HANDLER_ENABLED",
        "security": [
          {
            "SessionToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "session-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/GatewayGatewayLaunchRequestEnterprise"
          },
          "responsePayloads": {
            "201": {
              "$ref": "#/components/schemas/GatewayGatewayLaunchPostResult201Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Transport-encrypted response. Validation or access error. Inspect field errors, non_field_errors, detail, or error/message.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCreate gateway connection.\n\n**Configuration required:** `GATEWAY_HANDLER_ENABLED`.\n\n**Encryption:** [Session SecretBox](protocol.html#session-secretbox-profile)\n\n### Payload before transport encryption\n\nSchema: `GatewayGatewayLaunchRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cluster_id` | string (uuid) | Yes | Cluster id identifier. |\n| `secret_id` | string (uuid) | Yes | Secret id identifier. |\n| `data` | string | Yes | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | string | Yes | Hex-encoded nonce for the encrypted content, separate from the transport nonce. |\n\n### Payload after transport decryption · HTTP 201\n\nSchema: `GatewayGatewayLaunchPostResult201Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `launch_id` | string | Yes | Launch id identifier. |\n| `gateway_url` | string | Yes | Gateway url. |\n| `valid_till` | string,null (date-time) | Yes | Expiration time in ISO 8601 format. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "gateway/views/gateway_launch.py",
          "view": "GatewayLaunchView",
          "method": "post"
        }
      }
    },
    "/gateway/launch/trade/": {
      "put": {
        "operationId": "putGatewayLaunchTrade",
        "summary": "Exchange gateway launch code",
        "tags": [
          "Gateway · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "GATEWAY_HANDLER_ENABLED",
        "security": [
          {
            "GatewayToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "gateway-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/GatewayGatewayLaunchTradeRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/GatewayGatewayLaunchTradePutResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nExchange gateway launch code.\n\n**Configuration required:** `GATEWAY_HANDLER_ENABLED`.\n\n**Encryption:** [Gateway SecretBox](protocol.html#file-transfer-and-service-credentials)\n\n### Payload before transport encryption\n\nSchema: `GatewayGatewayLaunchTradeRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `launch_id` | string | Yes | Launch id identifier. Maximum length: 64. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `GatewayGatewayLaunchTradePutResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `data` | string | Yes | Encrypted content. Vault data remains encrypted after removing the transport envelope. |\n| `data_nonce` | string | Yes | Hex-encoded nonce for the encrypted content, separate from the transport nonce. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "gateway/views/gateway_launch_trade.py",
          "view": "GatewayLaunchTradeView",
          "method": "put"
        }
      }
    },
    "/gateway/launch/status/": {
      "post": {
        "operationId": "postGatewayLaunchStatus",
        "summary": "Check gateway connection status",
        "tags": [
          "Gateway · Enterprise only"
        ],
        "x-psono-editions": [
          "EE"
        ],
        "x-psono-requires-configuration": "GATEWAY_HANDLER_ENABLED",
        "security": [
          {
            "GatewayToken": []
          }
        ],
        "x-psono-encryption": {
          "profile": "gateway-secretbox",
          "requestPayload": {
            "$ref": "#/components/schemas/GatewayGatewayLaunchStatusRequestEnterprise"
          },
          "responsePayloads": {
            "200": {
              "$ref": "#/components/schemas/GatewayGatewayLaunchStatusPostResult200Enterprise"
            },
            "400": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EncryptedEnvelope"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transport-encrypted response. Operation completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or validation failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed. Plaintext error; not a transport-encrypted response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogicalError"
                }
              }
            }
          },
          "403": {
            "description": "Authenticated identity lacks the required permission. Transport-encrypted when a service/session secret was established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                }
              }
            }
          },
          "423": {
            "$ref": "#/components/responses/ServerLocked"
          },
          "429": {
            "description": "Request throttled. Transport-encrypted after successful session/service authentication; otherwise plaintext.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/EncryptedEnvelope"
                    },
                    {
                      "$ref": "#/components/schemas/LogicalError"
                    }
                  ]
                }
              }
            }
          }
        },
        "description": "**Availability:** **Enterprise Edition only**\n\n\n\nCheck gateway connection status.\n\n**Configuration required:** `GATEWAY_HANDLER_ENABLED`.\n\n**Encryption:** [Gateway SecretBox](protocol.html#file-transfer-and-service-credentials)\n\n### Payload before transport encryption\n\nSchema: `GatewayGatewayLaunchStatusRequestEnterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `launch_ids` | array | Yes | Launch ids. |\n\n### Payload after transport decryption · HTTP 200\n\nSchema: `GatewayGatewayLaunchStatusPostResult200Enterprise`.\n\n\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `valid_launch_ids` | array | Yes | Valid launch ids. |\n\n### Payload after transport decryption · HTTP 400\n\nSchema: `LogicalError`.\n\nDRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.\n\n\nIllustrative logical JSON (not the HTTP body):\n\n```json\n{\n  \"non_field_errors\": [\n    \"NO_PERMISSION_OR_NOT_EXIST\"\n  ]\n}\n```",
        "x-psono-source": {
          "file": "gateway/views/gateway_launch_status.py",
          "view": "GatewayLaunchStatusView",
          "method": "post"
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "SessionToken": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Enter the complete value: Token <session-token>. Not Bearer. Obtain a session through login, complete required multifactor challenges, and activate the token."
      },
      "FileTransfer": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Enter Filetransfer <transfer-id>. Use the corresponding transfer secret for transport encryption."
      },
      "FileserverToken": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Enter Token <fileserver-id>. This is a registered file-server identity, not a user token."
      },
      "GatewayToken": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Enter Token <gateway-id>. This is a registered Enterprise gateway identity."
      },
      "ManagementCommandToken": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Enter Token <MANAGEMENT_COMMAND_ACCESS_KEY>. This endpoint uses ordinary JSON and its configured management access key, not a user session."
      },
      "ScimBearer": {
        "type": "http",
        "scheme": "bearer",
        "description": "Enterprise SCIM provider TOKEN, configured in SCIM_CONFIGURATIONS."
      }
    },
    "responses": {
      "ServerLocked": {
        "description": "Plaintext JSON returned before the view runs. Server disabled, maintenance active, or (EE) license expired beyond its grace period.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/LogicalError"
            },
            "example": {
              "non_field_errors": [
                "MAINTENANCE_MODE_ACTIVE"
              ]
            }
          }
        }
      },
      "SessionForbidden": {
        "description": "The authenticated session lacks permission. Errors after successful session authentication are session-encrypted.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                },
                {
                  "$ref": "#/components/schemas/PlainAuthError"
                }
              ]
            }
          }
        }
      },
      "SessionUnauthenticated": {
        "description": "Missing, invalid, inactive, or expired token. Plaintext JSON with a WWW-Authenticate Token challenge.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/PlainAuthError"
            }
          }
        }
      },
      "SessionRateLimit": {
        "description": "Request throttled. Session-encrypted after successful authentication; otherwise plaintext.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/EncryptedEnvelope"
                },
                {
                  "$ref": "#/components/schemas/PlainAuthError"
                }
              ]
            }
          }
        }
      },
      "PlainRateLimit": {
        "description": "Request throttled, in plaintext JSON.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/LogicalError"
            }
          }
        }
      }
    },
    "schemas": {
      "EncryptedEnvelope": {
        "type": "object",
        "description": "Transport envelope. See the encryption guide. Example values are placeholders.",
        "required": [
          "text",
          "nonce"
        ],
        "properties": {
          "text": {
            "type": "string",
            "pattern": "^(?:[0-9a-fA-F]{2})+$",
            "minLength": 32,
            "description": "Hex-encoded ciphertext."
          },
          "nonce": {
            "type": "string",
            "pattern": "^[0-9a-fA-F]{48}$",
            "description": "Hex-encoded nonce."
          }
        },
        "example": {
          "text": "0123456789abcdef0123456789abcdef0123456789abcdef",
          "nonce": "000000000000000000000000000000000000000000000001"
        }
      },
      "SignedServerInfo": {
        "type": "object",
        "required": [
          "info",
          "signature",
          "verify_key"
        ],
        "properties": {
          "info": {
            "type": "string",
            "description": "Exact signed JSON string. Once verified and parsed, includes version, api, type (CE/EE), public_key and authentication_methods, among other configuration fields."
          },
          "signature": {
            "type": "string",
            "pattern": "^[0-9a-fA-F]{128}$",
            "description": "Detached Ed25519 signature in hex (64 bytes)."
          },
          "verify_key": {
            "type": "string",
            "pattern": "^[0-9a-fA-F]{64}$",
            "description": "Ed25519 verification key in hex (32 bytes)."
          }
        }
      },
      "CreateSecretPayload": {
        "type": "object",
        "description": "Exactly one parent ID is required. This is the JSON before session encryption; data is already vault-encrypted.",
        "required": [
          "data",
          "data_nonce",
          "link_id"
        ],
        "oneOf": [
          {
            "required": [
              "parent_datastore_id"
            ]
          },
          {
            "required": [
              "parent_share_id"
            ]
          }
        ],
        "properties": {
          "data": {
            "type": "string",
            "minLength": 1,
            "description": "Vault-encrypted secret content; not a plaintext password-entry object."
          },
          "data_nonce": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "description": "Nonce for vault-encrypted data. The serializer accepts at most 64 characters."
          },
          "link_id": {
            "type": "string",
            "format": "uuid",
            "description": "New client-generated, unique link ID."
          },
          "parent_datastore_id": {
            "type": "string",
            "format": "uuid",
            "description": "Parent datastore ID. Required if parent_share_id is absent."
          },
          "parent_share_id": {
            "type": "string",
            "format": "uuid",
            "description": "Parent share ID. Required if parent_datastore_id is absent."
          },
          "callback_url": {
            "type": "string",
            "maxLength": 2048,
            "default": "",
            "description": "Optional callback URL; empty disables the callback."
          },
          "callback_user": {
            "type": "string",
            "maxLength": 128,
            "default": "",
            "description": "Optional callback authentication username."
          },
          "callback_pass": {
            "type": "string",
            "maxLength": 128,
            "default": "",
            "description": "Optional callback authentication password."
          }
        },
        "example": {
          "data": "aabbccdd",
          "data_nonce": "000000000000000000000000000000000000000000000002",
          "link_id": "22222222-2222-4222-8222-222222222222",
          "parent_datastore_id": "33333333-3333-4333-8333-333333333333"
        }
      },
      "CreateSecretResult": {
        "type": "object",
        "required": [
          "secret_id"
        ],
        "properties": {
          "secret_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the newly created secret."
          }
        },
        "example": {
          "secret_id": "11111111-1111-4111-8111-111111111111"
        }
      },
      "ReadSecretResult": {
        "type": "object",
        "required": [
          "create_date",
          "write_date",
          "data",
          "data_nonce",
          "type",
          "read_count",
          "callback_url",
          "callback_user",
          "callback_pass"
        ],
        "properties": {
          "create_date": {
            "type": "string",
            "format": "date-time",
            "description": "Creation time (ISO 8601)."
          },
          "write_date": {
            "type": "string",
            "format": "date-time",
            "description": "Last write time (ISO 8601)."
          },
          "data": {
            "type": "string",
            "description": "Vault ciphertext. Still encrypted after the session envelope is removed."
          },
          "data_nonce": {
            "type": "string",
            "description": "Nonce for data; can be empty for secrets without one."
          },
          "type": {
            "type": "string",
            "description": "Stored server-side secret type marker."
          },
          "read_count": {
            "type": "integer",
            "minimum": 1,
            "description": "Read count including this read."
          },
          "callback_url": {
            "type": "string",
            "description": "Configured callback URL, or empty."
          },
          "callback_user": {
            "type": "string",
            "description": "Configured callback username, or empty."
          },
          "callback_pass": {
            "type": "string",
            "description": "Callback password after database decryption, or empty. Protected by the session envelope."
          }
        },
        "example": {
          "create_date": "2026-11-01T10:00:00Z",
          "write_date": "2026-11-01T10:00:00Z",
          "data": "aabbccdd",
          "data_nonce": "000000000000000000000000000000000000000000000002",
          "type": "password",
          "read_count": 3,
          "callback_url": "",
          "callback_user": "",
          "callback_pass": ""
        }
      },
      "ApiKeyReadRequest": {
        "type": "object",
        "required": [
          "api_key_id",
          "secret_id"
        ],
        "properties": {
          "api_key_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of an active API key with read access to this secret."
          },
          "secret_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of a secret assigned to this API key."
          },
          "api_key_secret_key": {
            "type": "string",
            "minLength": 1,
            "description": "Optional hex-encoded API-key symmetric secret (normally 32 bytes). Enables remote decryption; requires allow_insecure_access. Omit for local decryption."
          },
          "json_filter": {
            "type": "string",
            "minLength": 1,
            "description": "Optional dot-separated JSON path for remote decryption, for example website_password_password. Omit for the complete value. Not applied in local mode."
          }
        },
        "example": {
          "api_key_id": "44444444-4444-4444-8444-444444444444",
          "secret_id": "11111111-1111-4111-8111-111111111111"
        }
      },
      "ApiKeyEncryptedSecret": {
        "type": "object",
        "required": [
          "data",
          "data_nonce",
          "secret_key",
          "secret_key_nonce",
          "read_count",
          "write_date"
        ],
        "properties": {
          "data": {
            "type": "string",
            "description": "Vault-encrypted secret JSON, hex encoded."
          },
          "data_nonce": {
            "type": "string",
            "description": "Nonce for the vault ciphertext, hex encoded."
          },
          "secret_key": {
            "type": "string",
            "description": "Secret's symmetric key, encrypted with the API-key symmetric secret and hex encoded."
          },
          "secret_key_nonce": {
            "type": "string",
            "description": "Nonce for the wrapped secret key, hex encoded."
          },
          "read_count": {
            "type": "integer",
            "minimum": 1,
            "description": "Read count including this read."
          },
          "write_date": {
            "type": "string",
            "format": "date-time",
            "description": "Last write time."
          }
        }
      },
      "RemoteDecryptedValue": {
        "description": "Any JSON value stored in the secret, or selected by json_filter. This deliberately unconstrained schema overlaps the local-mode object; mode selection depends on the request, not on response discrimination."
      },
      "LogicalError": {
        "type": "object",
        "description": "DRF field errors, non_field_errors, detail, or error/message pairs. Logical errors can be inside a session envelope; check each operation's wire schema.",
        "additionalProperties": true,
        "example": {
          "non_field_errors": [
            "NO_PERMISSION_OR_NOT_EXIST"
          ]
        }
      },
      "PlainAuthError": {
        "type": "object",
        "required": [
          "detail"
        ],
        "properties": {
          "detail": {
            "type": "string",
            "description": "Authentication, permission, or throttling message."
          }
        }
      },
      "ScimSchemaList": {
        "type": "object",
        "required": [
          "schemas",
          "itemsPerPage",
          "startIndex",
          "totalResults",
          "Resources"
        ],
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "urn:ietf:params:scim:api:messages:2.0:ListResponse"
            ]
          },
          "itemsPerPage": {
            "type": "integer",
            "description": "Currently 50, even though only two resources are returned.",
            "example": 50
          },
          "startIndex": {
            "type": "integer",
            "example": 1
          },
          "totalResults": {
            "type": "integer",
            "example": 2
          },
          "Resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScimSchema"
            }
          }
        }
      },
      "ScimSchema": {
        "type": "object",
        "required": [
          "schemas",
          "id",
          "name",
          "description",
          "attributes",
          "meta"
        ],
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "urn:ietf:params:scim:schemas:core:2.0:Schema"
            ]
          },
          "id": {
            "type": "string",
            "description": "User or Group schema URN."
          },
          "name": {
            "type": "string",
            "enum": [
              "User",
              "Group"
            ]
          },
          "description": {
            "type": "string"
          },
          "attributes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScimAttribute"
            }
          },
          "meta": {
            "type": "object",
            "required": [
              "resourceType",
              "location"
            ],
            "properties": {
              "resourceType": {
                "type": "string",
                "const": "Schema"
              },
              "location": {
                "type": "string",
                "description": "Server-supplied relative schema location."
              }
            }
          }
        }
      },
      "ScimAttribute": {
        "type": "object",
        "required": [
          "name",
          "type",
          "multiValued",
          "description",
          "required"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "multiValued": {
            "type": "boolean"
          },
          "description": {
            "type": "string"
          },
          "required": {
            "type": "boolean"
          },
          "caseExact": {
            "type": "boolean"
          },
          "mutability": {
            "type": "string"
          },
          "returned": {
            "type": "string"
          },
          "uniqueness": {
            "type": "string"
          },
          "canonicalValues": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "subAttributes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScimAttribute"
            }
          }
        }
      },
      "RestapiPreLoginRequest": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "minLength": 1,
            "maxLength": 254
          }
        },
        "required": [
          "username"
        ],
        "x-psono-validation-errors": [
          "INVALID_USERNAME_FORMAT"
        ]
      },
      "RestapiPreLoginPostResult200": {
        "type": "object",
        "properties": {
          "hashing_parameters": {
            "type": "object",
            "additionalProperties": true,
            "description": "Hashing parameters."
          },
          "hashing_algorithm": {
            "type": "string",
            "description": "Hashing algorithm."
          }
        },
        "required": [
          "hashing_parameters",
          "hashing_algorithm"
        ]
      },
      "RestapiLoginPostResult200": {
        "type": "object",
        "properties": {
          "login_info": {
            "type": "string",
            "description": "Hex-encoded ciphertext for the operation-specific login exchange."
          },
          "login_info_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for login info."
          }
        },
        "required": [
          "login_info",
          "login_info_nonce"
        ]
      },
      "RestapiGAVerifyRequest": {
        "type": "object",
        "properties": {
          "ga_token": {
            "description": "Current one-time code from the configured authenticator.",
            "type": "string",
            "minLength": 6,
            "maxLength": 6
          }
        },
        "required": [
          "ga_token"
        ],
        "x-psono-validation-errors": [
          "GA_TOKENS_ONLY_CONTAIN_DIGITS",
          "GA_TOKEN_INCORRECT",
          "NO_GOOGLE_AUTHENTICATOR_FOUND"
        ]
      },
      "RestapiGAVerifyPostResult200": {
        "type": "object",
        "properties": {}
      },
      "RestapiDuoVerifyRequest": {
        "type": "object",
        "properties": {
          "duo_token": {
            "description": "Duo token.",
            "type": "string",
            "minLength": 6
          }
        },
        "x-psono-validation-errors": [
          "DUO_HOST_NOT_ALLOWED",
          "NO_DUO_FOUND",
          "VALIDATION_FAILED"
        ]
      },
      "RestapiWebauthnVerifyRequest": {
        "type": "object",
        "properties": {
          "credential": {
            "description": "Credential.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "credential"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiWebauthnVerifyInitRequest": {
        "type": "object",
        "properties": {
          "origin": {
            "description": "Origin.",
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          },
          "rp_id": {
            "description": "Rp id identifier.",
            "type": "string",
            "minLength": 1,
            "maxLength": 253
          },
          "legacy": {
            "description": "Legacy.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "origin"
        ],
        "x-psono-validation-errors": [
          "INVALID_ORIGIN",
          "NO_PERMISSION_OR_NOT_EXIST",
          "PROTOCOL_NOT_SUPPORTED",
          "RP_ID_NOT_ALLOWED"
        ]
      },
      "RestapiWebauthnVerifyPutResult200": {
        "type": "object",
        "properties": {
          "options": {
            "type": "object",
            "additionalProperties": true,
            "description": "Options."
          },
          "legacy_available": {
            "type": "boolean",
            "description": "Legacy available."
          }
        },
        "required": [
          "options",
          "legacy_available"
        ]
      },
      "RestapiYubikeyOTPVerifyRequest": {
        "type": "object",
        "properties": {
          "yubikey_otp": {
            "description": "One-time password produced by the YubiKey.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "yubikey_otp"
        ],
        "x-psono-validation-errors": [
          "NO_YUBIKEY_FOUND",
          "SERVER_NOT_SUPPORT_YUBIKEY",
          "YUBICO_TOKEN_INVALID"
        ]
      },
      "RestapiIvaltVerifyRequest": {
        "type": "object",
        "properties": {
          "request_type": {
            "description": "Request type.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "request_type"
        ],
        "x-psono-validation-errors": [
          "AUTHENTICATION_FAILED",
          "INVALID_VALUE_FOR_REQUEST_TYPE",
          "NO_IVALT_2FA_FOUND"
        ]
      },
      "RestapiActivateTokenRequest": {
        "type": "object",
        "properties": {
          "verification": {
            "description": "Encrypted proof of possession of the user validator.",
            "type": "string",
            "minLength": 1
          },
          "verification_nonce": {
            "description": "Hex-encoded nonce for verification.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "zoneinfo": {
            "description": "Zoneinfo.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1
          }
        },
        "required": [
          "verification",
          "verification_nonce"
        ],
        "x-psono-validation-errors": [
          "DUO_CHALLENGE_UNSOLVED",
          "GA_CHALLENGE_UNSOLVED",
          "IVALT_CHALLENGE_UNSOLVED",
          "TOKEN_INCORRECT",
          "VERIFICATION_CODE_INCORRECT",
          "WEBAUTHN_CHALLENGE_UNSOLVED",
          "YUBIKEY_CHALLENGE_UNSOLVED"
        ]
      },
      "RestapiSessionGetResult200": {
        "type": "object",
        "properties": {
          "sessions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": "string",
                  "description": "Creation time in ISO 8601 format."
                },
                "device_description": {
                  "type": "string",
                  "description": "Human-readable description of the client device."
                },
                "current_session": {
                  "type": "boolean",
                  "description": "Current session."
                }
              },
              "required": [
                "id",
                "create_date",
                "device_description",
                "current_session"
              ]
            },
            "description": "Sessions."
          }
        },
        "required": [
          "sessions"
        ]
      },
      "RestapiRegisterRequest": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "email": {
            "description": "Email address.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "authkey": {
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key.",
            "type": "string",
            "minLength": 1
          },
          "public_key": {
            "description": "Hex-encoded public key.",
            "type": "string",
            "minLength": 1
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "user_sauce": {
            "description": "User sauce.",
            "type": "string",
            "minLength": 1
          },
          "hashing_algorithm": {
            "description": "Hashing algorithm.",
            "type": "string"
          },
          "hashing_parameters": {
            "description": "Hashing parameters.",
            "type": "object",
            "additionalProperties": true
          }
        },
        "required": [
          "username",
          "email",
          "authkey",
          "public_key",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce",
          "user_sauce"
        ],
        "x-psono-validation-errors": [
          "EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER",
          "INVALID_HASHING_PARAMETER",
          "PROVIDED_DOMAIN_NOT_ALLOWED_FOR_REGISTRATION",
          "USERNAME_ALREADY_EXISTS",
          "USERNAME_VALIDATION_NAME_CONTAINS_INVALID_CHARS",
          "USER_WITH_EMAIL_ALREADY_EXISTS"
        ]
      },
      "RestapiRegisterPostResult201": {
        "type": "object",
        "properties": {
          "success": {
            "type": "string",
            "example": "REGISTRATION_SUCCESSFUL",
            "description": "Success."
          }
        },
        "required": [
          "success"
        ]
      },
      "RestapiVerifyEmailRequest": {
        "type": "object",
        "properties": {
          "activation_code": {
            "description": "Activation code.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "activation_code"
        ],
        "x-psono-validation-errors": [
          "ACTIVATION_CODE_INCORRECT"
        ]
      },
      "RestapiVerifyEmailPostResult200": {
        "type": "object",
        "properties": {
          "success": {
            "type": "string",
            "example": "Successfully activated.",
            "description": "Success."
          }
        },
        "required": [
          "success"
        ]
      },
      "RestapiUserUpdateRequest": {
        "type": "object",
        "properties": {
          "email": {
            "description": "Email address.",
            "type": [
              "string",
              "null"
            ],
            "format": "email",
            "minLength": 1
          },
          "authkey": {
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1
          },
          "authkey_old": {
            "description": "Authkey old.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          },
          "user_sauce": {
            "description": "User sauce.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          },
          "hashing_algorithm": {
            "description": "Hashing algorithm.",
            "type": "string"
          },
          "hashing_parameters": {
            "description": "Hashing parameters.",
            "type": "object",
            "additionalProperties": true
          },
          "language": {
            "description": "Language.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 16
          },
          "zoneinfo": {
            "description": "Zoneinfo.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1
          }
        },
        "x-psono-validation-errors": [
          "AUTHKEY_REQUIRED",
          "CANNOT_REUSE_OLD_PASSWORD",
          "INVALID_HASHING_PARAMETER",
          "NO_VALID_HEX",
          "OLD_PASSWORD_INCORRECT",
          "USER_WITH_EMAIL_ALREADY_EXISTS"
        ]
      },
      "RestapiUserUpdatePutResult200": {
        "type": "object",
        "properties": {
          "success": {
            "type": "string",
            "example": "User updated.",
            "description": "Success."
          }
        },
        "required": [
          "success"
        ]
      },
      "RestapiUserUpgradeHashingRequest": {
        "type": "object",
        "properties": {
          "authkey": {
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key.",
            "type": "string",
            "minLength": 1
          },
          "authkey_old": {
            "description": "Authkey old.",
            "type": "string",
            "minLength": 1
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "hashing_algorithm": {
            "description": "Hashing algorithm.",
            "type": "string"
          },
          "hashing_parameters": {
            "description": "Hashing parameters.",
            "type": "object",
            "additionalProperties": true
          }
        },
        "required": [
          "authkey",
          "authkey_old",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce",
          "hashing_algorithm",
          "hashing_parameters"
        ],
        "x-psono-validation-errors": [
          "INVALID_HASHING_PARAMETER",
          "INVALID_HASHING_UPGRADE",
          "NO_VALID_HEX",
          "OLD_PASSWORD_INCORRECT"
        ]
      },
      "RestapiUserUpgradeHashingPutResult200": {
        "type": "object",
        "properties": {
          "success": {
            "type": "string",
            "example": "Hashing parameters upgraded.",
            "description": "Success."
          }
        },
        "required": [
          "success"
        ]
      },
      "RestapiDeleteGARequest": {
        "type": "object",
        "properties": {
          "google_authenticator_id": {
            "description": "Google authenticator id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "google_authenticator_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUserGAGetResult200": {
        "type": "object",
        "properties": {
          "google_authenticators": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                }
              },
              "required": [
                "id",
                "active",
                "title"
              ]
            },
            "description": "Google authenticators."
          }
        },
        "required": [
          "google_authenticators"
        ]
      },
      "RestapiActivateGARequest": {
        "type": "object",
        "properties": {
          "google_authenticator_id": {
            "description": "Google authenticator id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "google_authenticator_token": {
            "description": "Google authenticator token.",
            "type": "string",
            "minLength": 6,
            "maxLength": 6
          }
        },
        "required": [
          "google_authenticator_id",
          "google_authenticator_token"
        ],
        "x-psono-validation-errors": [
          "GA_TOKENS_ONLY_CONTAIN_DIGITS",
          "GA_TOKEN_INCORRECT",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiNewGARequest": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          }
        },
        "required": [
          "title"
        ],
        "x-psono-validation-errors": [
          "SERVER_NOT_SUPPORT_GA"
        ]
      },
      "RestapiUserGAPutResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "secret": {
            "type": "string",
            "description": "Secret."
          }
        },
        "required": [
          "id",
          "secret"
        ]
      },
      "RestapiDeleteDuoRequest": {
        "type": "object",
        "properties": {
          "duo_id": {
            "description": "Duo id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "duo_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUserDuoGetResult200": {
        "type": "object",
        "properties": {
          "duos": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                }
              },
              "required": [
                "id",
                "active",
                "title"
              ]
            },
            "description": "Duos."
          }
        },
        "required": [
          "duos"
        ]
      },
      "RestapiActivateDuoRequest": {
        "type": "object",
        "properties": {
          "duo_id": {
            "description": "Duo id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "duo_token": {
            "description": "Duo token.",
            "type": "string",
            "minLength": 6
          }
        },
        "required": [
          "duo_id"
        ],
        "x-psono-validation-errors": [
          "DUO_ENROLLMENT_EXPIRED",
          "DUO_HOST_NOT_ALLOWED",
          "NO_PERMISSION_OR_NOT_EXIST",
          "SCAN_THE_BARCODE_FIRST",
          "VALIDATION_FAILED"
        ]
      },
      "RestapiNewDuoRequest": {
        "type": "object",
        "properties": {
          "use_system_wide_duo": {
            "description": "Use system wide duo.",
            "type": "boolean",
            "default": false
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "integration_key": {
            "description": "Integration key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "host": {
            "description": "Host.",
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          }
        },
        "x-psono-validation-errors": [
          "DUO_HOST_NOT_ALLOWED",
          "ONLY_ONE_DUO_DEVICE_ALLOWED",
          "SERVER_NOT_SUPPORT_DUO"
        ]
      },
      "RestapiUserDuoPutResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "activation_code": {
            "type": "string",
            "description": "Activation code."
          }
        },
        "required": [
          "id",
          "activation_code"
        ]
      },
      "RestapiDeleteWebauthnRequest": {
        "type": "object",
        "properties": {
          "webauthn_id": {
            "description": "Webauthn id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "webauthn_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUserWebauthnGetResult200": {
        "type": "object",
        "properties": {
          "webauthns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                }
              },
              "required": [
                "id",
                "active",
                "title"
              ]
            },
            "description": "Webauthns."
          }
        },
        "required": [
          "webauthns"
        ]
      },
      "RestapiActivateWebauthnRequest": {
        "type": "object",
        "properties": {
          "webauthn_id": {
            "description": "Webauthn id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "credential": {
            "description": "Credential.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "webauthn_id",
          "credential"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiNewWebauthnRequest": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "origin": {
            "description": "Origin.",
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          },
          "rp_id": {
            "description": "Rp id identifier.",
            "type": "string",
            "minLength": 1,
            "pattern": "\\A[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?\\Z",
            "maxLength": 253
          }
        },
        "required": [
          "title",
          "origin"
        ],
        "x-psono-validation-errors": [
          "INVALID_ORIGIN",
          "PROTOCOL_NOT_SUPPORTED",
          "RP_ID_NOT_ALLOWED",
          "SERVER_NOT_SUPPORT_WEBAUTHN"
        ]
      },
      "RestapiUserWebauthnPutResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "options": {
            "type": "object",
            "additionalProperties": true,
            "description": "Options."
          }
        },
        "required": [
          "id",
          "options"
        ]
      },
      "RestapiDeleteYubikeyRequest": {
        "type": "object",
        "properties": {
          "yubikey_otp_id": {
            "description": "Yubikey otp id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "yubikey_otp_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUserYubikeyOTPGetResult200": {
        "type": "object",
        "properties": {
          "yubikey_otps": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                }
              },
              "required": [
                "id",
                "active",
                "title"
              ]
            },
            "description": "Yubikey otps."
          }
        },
        "required": [
          "yubikey_otps"
        ]
      },
      "RestapiActivateYubikeyRequest": {
        "type": "object",
        "properties": {
          "yubikey_id": {
            "description": "Yubikey id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "yubikey_otp": {
            "description": "One-time password produced by the YubiKey.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "yubikey_id",
          "yubikey_otp"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "SERVER_DOES_NOT_SUPPORT_YUBIKEYS",
          "YUBIKEY_OTP_INCORRECT",
          "YUBIKEY_OTP_NOT_ATTACHED_TO_THIS_ACCOUNT"
        ]
      },
      "RestapiNewYubikeyOTPRequest": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "yubikey_otp": {
            "description": "One-time password produced by the YubiKey.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "title",
          "yubikey_otp"
        ],
        "x-psono-validation-errors": [
          "SERVER_NOT_SUPPORT_YUBIKEY",
          "YUBICO_TOKEN_INVALID"
        ]
      },
      "RestapiUserYubikeyOTPPutResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          }
        },
        "required": [
          "id"
        ]
      },
      "RestapiDeleteIvaltRequest": {
        "type": "object",
        "properties": {
          "ivalt_id": {
            "description": "Ivalt id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "ivalt_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUserIvaltGetResult200": {
        "type": "object",
        "properties": {
          "ivalt": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "mobile": {
                  "type": "string",
                  "description": "Mobile."
                }
              },
              "required": [
                "id",
                "active",
                "mobile"
              ]
            },
            "description": "Ivalt."
          }
        },
        "required": [
          "ivalt"
        ]
      },
      "RestapiUserIvaltPostResult200": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "BIOMETRIC_AUTHENTICATION_SUCCESSFULLY_DONE",
            "description": "Message."
          }
        },
        "required": [
          "message"
        ]
      },
      "RestapiCreateIvaltRequest": {
        "type": "object",
        "properties": {
          "mobile": {
            "description": "Mobile.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          }
        },
        "required": [
          "mobile"
        ],
        "x-psono-validation-errors": [
          "AUTHENTICATION_FAILED",
          "IVALT_SECRET_KEY_NOT_EXIST",
          "ONLY_ONE_IVALT_MOBILE_ALLOWED",
          "SERVER_NOT_SUPPORT_IVALT"
        ]
      },
      "RestapiUserIvaltPutResult201": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "BIOMETRIC_AUTH_REQUEST_SUCCESSFULLY_SENT",
            "description": "Message."
          },
          "id": {
            "type": "string",
            "description": "Id identifier."
          }
        },
        "required": [
          "message",
          "id"
        ]
      },
      "RestapiUserSearchRequest": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "user_username": {
            "description": "User username.",
            "type": "string"
          },
          "user_email": {
            "description": "User email.",
            "type": "string"
          }
        },
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUserSearchPostResult200": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Id identifier."
            },
            "public_key": {
              "type": "string",
              "description": "Hex-encoded public key."
            },
            "username": {
              "type": "string",
              "description": "Account username, normally including the configured domain."
            },
            "avatar_id": {
              "type": "string",
              "description": "Avatar id identifier."
            },
            "multifactor_auth_enabled": {
              "type": "boolean",
              "description": "Multifactor auth enabled."
            },
            "recovery_code_enabled": {
              "type": "boolean",
              "description": "Recovery code enabled."
            }
          },
          "required": [
            "id",
            "public_key",
            "username",
            "avatar_id"
          ]
        }
      },
      "RestapiCreateSecurityReportRequest": {
        "type": "object",
        "properties": {
          "entries": {
            "description": "Entries.",
            "type": "array",
            "items": {
              "description": "Entries item.",
              "type": "object",
              "additionalProperties": true
            }
          },
          "check_haveibeenpwned": {
            "description": "Check haveibeenpwned.",
            "type": "boolean"
          },
          "authkey": {
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "entries",
          "check_haveibeenpwned",
          "authkey"
        ],
        "x-psono-validation-errors": [
          "CENTRAL_SECURITY_REPORTS_DISABLED",
          "PASSWORD_INCORRECT"
        ]
      },
      "RestapiAvatarImageGetResult200": {
        "type": "string",
        "format": "binary"
      },
      "RestapiDeleteAvatarRequest": {
        "type": "object",
        "properties": {
          "avatar_id": {
            "description": "Avatar id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "avatar_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiAvatarGetResult200": {
        "type": "object",
        "properties": {
          "avatars": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                }
              },
              "required": [
                "id"
              ]
            },
            "description": "Avatars."
          }
        },
        "required": [
          "avatars"
        ]
      },
      "RestapiCreateAvatarRequest": {
        "type": "object",
        "properties": {
          "data_base64": {
            "description": "Data base64.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "data_base64"
        ],
        "x-psono-validation-errors": [
          "DATA_NO_IMAGE",
          "DIMENSIONS_EXCEEDED",
          "INVALID_BASE64",
          "SIZE_EXCEEDED"
        ]
      },
      "RestapiAvatarPostResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          }
        },
        "required": [
          "id"
        ]
      },
      "RestapiSessionKeyGetResult200": {
        "type": "object",
        "properties": {
          "session_key": {
            "type": "string",
            "description": "Session identifier/key distinct from the symmetric session encryption key."
          }
        },
        "required": [
          "session_key"
        ]
      },
      "RestapiRecoveryCodePostResult200": {
        "type": "object",
        "properties": {
          "recovery_code_id": {
            "type": "string",
            "description": "Recovery code id identifier."
          }
        },
        "required": [
          "recovery_code_id"
        ]
      },
      "RestapiDeleteEmergencycodeRequest": {
        "type": "object",
        "properties": {
          "emergency_code_id": {
            "description": "Emergency code id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "emergency_code_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiEmergencyCodeGetResult200": {
        "type": "object",
        "properties": {
          "emegency_codes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "description": {
                  "type": "string",
                  "description": "Human-readable description."
                },
                "activation_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Activation date."
                },
                "activation_delay": {
                  "type": "integer",
                  "description": "Activation delay."
                }
              },
              "required": [
                "id",
                "description",
                "activation_date",
                "activation_delay"
              ]
            },
            "description": "Emegency codes."
          },
          "default_hashing_algorithm": {
            "type": "string",
            "description": "Default hashing algorithm."
          },
          "default_hashing_parameters": {
            "type": "object",
            "additionalProperties": true,
            "description": "Default hashing parameters."
          }
        },
        "required": [
          "emegency_codes",
          "default_hashing_algorithm",
          "default_hashing_parameters"
        ]
      },
      "RestapiEmergencyCodePostResult201": {
        "type": "object",
        "properties": {
          "emergency_code_id": {
            "type": "string",
            "description": "Emergency code id identifier."
          }
        },
        "required": [
          "emergency_code_id"
        ]
      },
      "RestapiEmergencyLoginRequest": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "emergency_authkey": {
            "description": "Emergency authkey.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "username",
          "emergency_authkey"
        ],
        "x-psono-validation-errors": [
          "USERNAME_OR_EMERGENCY_CODE_INCORRECT"
        ]
      },
      "RestapiActivateEmergencyLoginRequest": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "emergency_authkey": {
            "description": "Emergency authkey.",
            "type": "string",
            "minLength": 1
          },
          "update_data": {
            "description": "Update data.",
            "type": "string",
            "minLength": 1
          },
          "update_data_nonce": {
            "description": "Hex-encoded nonce for update data.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "username",
          "emergency_authkey",
          "update_data",
          "update_data_nonce"
        ],
        "x-psono-validation-errors": [
          "EMAIL_NOT_YET_VERIFIED",
          "NO_VALID_HEX",
          "USERNAME_OR_EMERGENCY_CODE_INCORRECT",
          "USERNAME_OR_RECOVERY_CODE_INCORRECT",
          "USER_ACCOUNT_IS_DISABLED",
          "VALIDATOR_EXPIRED",
          "VALIDATOR_FAILED"
        ]
      },
      "RestapiAPIKeyAccessInspectPostResult200": {
        "type": "object",
        "properties": {
          "allow_insecure_access": {
            "type": "boolean",
            "description": "Allow insecure access."
          },
          "restrict_to_secrets": {
            "type": "boolean",
            "description": "Restrict to secrets."
          },
          "read": {
            "type": "boolean",
            "description": "Whether read access is granted."
          },
          "write": {
            "type": "boolean",
            "description": "Whether write access is granted."
          },
          "api_key_secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "secret_id": {
                  "type": "string",
                  "description": "Secret id identifier."
                },
                "write_date": {
                  "type": "string",
                  "description": "Last write time in ISO 8601 format."
                }
              },
              "required": [
                "secret_id",
                "write_date"
              ]
            },
            "description": "Api key secrets."
          }
        },
        "required": [
          "allow_insecure_access",
          "restrict_to_secrets",
          "read",
          "write",
          "api_key_secrets"
        ]
      },
      "RestapiAPIKeyAccessSecretPutResult200": {
        "type": "object",
        "properties": {
          "write_date": {
            "type": "string",
            "description": "Last write time in ISO 8601 format."
          }
        },
        "required": [
          "write_date"
        ]
      },
      "RestapiRemoveSecretFromAPIKeyRequest": {
        "type": "object",
        "properties": {
          "api_key_secret_id": {
            "description": "Api key secret id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "api_key_secret_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiAPIKeySecretGetResult200": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Id identifier."
            },
            "secret_id": {
              "type": "string",
              "description": "Secret id identifier."
            },
            "title": {
              "type": "string",
              "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
            },
            "title_nonce": {
              "type": "string",
              "description": "Hex-encoded nonce for title."
            }
          },
          "required": [
            "id",
            "secret_id",
            "title",
            "title_nonce"
          ]
        }
      },
      "RestapiAPIKeySecretPutResult201": {
        "type": "object",
        "properties": {
          "api_key_secret_id": {
            "type": "string",
            "description": "Api key secret id identifier."
          }
        },
        "required": [
          "api_key_secret_id"
        ]
      },
      "RestapiAPIKeyLoginPostResult200": {
        "type": "object",
        "properties": {
          "login_info": {
            "type": "string",
            "description": "Hex-encoded ciphertext for the operation-specific login exchange."
          },
          "login_info_signature": {
            "type": "string",
            "description": "Login info signature."
          },
          "login_info_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for login info."
          },
          "server_session_public_key": {
            "type": "string",
            "description": "Server session public key."
          }
        },
        "required": [
          "login_info",
          "login_info_signature",
          "login_info_nonce",
          "server_session_public_key"
        ]
      },
      "RestapiDeleteAPIKeyRequest": {
        "type": "object",
        "properties": {
          "api_key_id": {
            "description": "Api key id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "api_key_id"
        ],
        "x-psono-validation-errors": [
          "API_KEY_DOES_NOT_EXIST"
        ]
      },
      "RestapiAPIKeyPutResult201": {
        "type": "object",
        "properties": {
          "api_key_id": {
            "type": "string",
            "description": "Api key id identifier."
          }
        },
        "required": [
          "api_key_id"
        ]
      },
      "RestapiLinkShareAccessPostResult200": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "node": {
                "type": "string",
                "description": "Node."
              },
              "node_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for node."
              },
              "secret_data": {
                "type": "string",
                "description": "Secret data."
              },
              "secret_data_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for secret data."
              },
              "secret_read_count": {
                "type": "integer",
                "description": "Secret read count."
              },
              "allow_write": {
                "type": "boolean",
                "example": false,
                "description": "Allow write."
              }
            },
            "required": [
              "node",
              "node_nonce",
              "secret_data",
              "secret_data_nonce",
              "secret_read_count",
              "allow_write"
            ]
          },
          {
            "type": "object",
            "properties": {
              "file_transfer_id": {
                "type": "string",
                "description": "File transfer id identifier."
              },
              "file_transfer_secret_key": {
                "type": "string",
                "description": "File transfer secret key."
              },
              "shards": {
                "description": "Shards.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": true
                }
              },
              "node": {
                "type": "string",
                "description": "Node."
              },
              "node_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for node."
              },
              "allow_write": {
                "type": "boolean",
                "example": false,
                "description": "Allow write."
              }
            },
            "required": [
              "file_transfer_id",
              "file_transfer_secret_key",
              "shards",
              "node",
              "node_nonce",
              "allow_write"
            ]
          }
        ]
      },
      "RestapiUpdateLinkShareAccessRequest": {
        "type": "object",
        "properties": {
          "link_share_id": {
            "description": "Link share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "secret_data": {
            "description": "Secret data.",
            "type": "string",
            "minLength": 1
          },
          "secret_data_nonce": {
            "description": "Hex-encoded nonce for secret data.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "passphrase": {
            "description": "Passphrase.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "link_share_id",
          "secret_data",
          "secret_data_nonce"
        ],
        "x-psono-validation-errors": [
          "EITHER_SECRET_OR_FILE_REQUIRED",
          "INSUFFICIENT_FUNDS",
          "NO_FILESERVER_AVAILABLE",
          "NO_PERMISSION_OR_NOT_EXIST",
          "PASSPHRASE_REQUIRED"
        ]
      },
      "RestapiDeleteLinkShareRequest": {
        "type": "object",
        "properties": {
          "link_share_id": {
            "description": "Link share id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "link_share_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiLinkSharePutResult201": {
        "type": "object",
        "properties": {
          "link_share_id": {
            "type": "string",
            "description": "Link share id identifier."
          }
        },
        "required": [
          "link_share_id"
        ]
      },
      "RestapiUpdateDatastoreRequest": {
        "type": "object",
        "properties": {
          "datastore_id": {
            "description": "Datastore id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "data": {
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope.",
            "type": "string"
          },
          "data_nonce": {
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce.",
            "type": "string",
            "maxLength": 64
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "description": {
            "description": "Human-readable description.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "is_default": {
            "description": "Is default.",
            "type": "boolean"
          },
          "old_write_date": {
            "description": "Expected previous write timestamp for optimistic concurrency control.",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "datastore_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "WRITE_DATE_MISMATCH"
        ]
      },
      "RestapiDatastorePostResult200": {
        "type": "object",
        "properties": {
          "success": {
            "type": "string",
            "example": "Data updated.",
            "description": "Success."
          },
          "write_date": {
            "type": "string",
            "description": "Last write time in ISO 8601 format."
          }
        },
        "required": [
          "success",
          "write_date"
        ]
      },
      "RestapiDatastorePutResult201": {
        "type": "object",
        "properties": {
          "datastore_id": {
            "type": "string",
            "description": "Datastore id identifier."
          }
        },
        "required": [
          "datastore_id"
        ]
      },
      "RestapiDeleteFileLinkRequest": {
        "type": "object",
        "properties": {
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "link_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiMoveFileLinkRequest": {
        "type": "object",
        "properties": {
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          },
          "new_parent_share_id": {
            "description": "New parent share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "new_parent_datastore_id": {
            "description": "New parent datastore id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "link_id"
        ],
        "x-psono-validation-errors": [
          "NO_PARENT_PROVIDED",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiDeleteFileRequest": {
        "type": "object",
        "properties": {
          "file_id": {
            "description": "File id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "file_id"
        ],
        "x-psono-validation-errors": [
          "FILE_NOT_ATTACHED_TO_SECRET",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiFileDeleteResult200": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": true,
            "description": "Success."
          }
        },
        "required": [
          "success"
        ]
      },
      "RestapiFileGetResult201": {
        "type": "object",
        "properties": {
          "file_transfer_id": {
            "type": "string",
            "description": "File transfer id identifier."
          },
          "file_transfer_secret_key": {
            "type": "string",
            "description": "File transfer secret key."
          }
        },
        "required": [
          "file_transfer_id",
          "file_transfer_secret_key"
        ]
      },
      "RestapiCreateFileRequest": {
        "type": "object",
        "properties": {
          "shard_id": {
            "description": "Shard id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "file_repository_id": {
            "description": "File repository id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "chunk_count": {
            "description": "Chunk count.",
            "type": "integer"
          },
          "size": {
            "description": "Size.",
            "type": "integer",
            "minimum": 0
          },
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          },
          "parent_share_id": {
            "description": "Parent share UUID. Where a parent datastore is also supported, supply exactly one parent.",
            "type": "string",
            "format": "uuid"
          },
          "parent_datastore_id": {
            "description": "Parent datastore UUID. Where a parent share is also supported, supply exactly one parent.",
            "type": "string",
            "format": "uuid"
          },
          "parent_secret_id": {
            "description": "Parent secret id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "chunk_count"
        ],
        "oneOf": [
          {
            "required": [
              "parent_datastore_id"
            ]
          },
          {
            "required": [
              "parent_share_id"
            ]
          }
        ],
        "description": "Supply exactly one parent: parent_datastore_id or parent_share_id.",
        "x-psono-validation-errors": [
          "EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED",
          "EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED_NOT_BOTH",
          "EITHER_PARENT_SECRET_OR_LINK_NEED_TO_BE_DEFINED",
          "EITHER_PARENT_SECRET_OR_LINK_NOT_BOTH",
          "INSUFFICIENT_FUNDS",
          "NO_FILESERVER_AVAILABLE",
          "NO_PERMISSION_OR_NOT_EXIST",
          "SELECT_EITHER_SHARD_OR_REPOSITORY"
        ]
      },
      "RestapiFilePutResult201": {
        "type": "object",
        "properties": {
          "file_id": {
            "type": "string",
            "description": "File id identifier."
          },
          "file_transfer_id": {
            "type": "string",
            "description": "File transfer id identifier."
          },
          "file_transfer_secret_key": {
            "type": "string",
            "description": "File transfer secret key."
          }
        },
        "required": [
          "file_id",
          "file_transfer_id",
          "file_transfer_secret_key"
        ]
      },
      "RestapiFileRepositoryRightAcceptRequest": {
        "type": "object",
        "properties": {
          "file_repository_right_id": {
            "description": "File repository right id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "file_repository_right_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiFileRepositoryRightPutResult201": {
        "type": "object",
        "properties": {
          "file_repository_right_id": {
            "type": "string",
            "description": "File repository right id identifier."
          }
        },
        "required": [
          "file_repository_right_id"
        ]
      },
      "RestapiDeleteGroupFileRepositoryRightRequest": {
        "type": "object",
        "properties": {
          "group_file_repository_right_id": {
            "description": "Group file repository right id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_file_repository_right_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUpdateGroupFileRepositoryRightRequest": {
        "type": "object",
        "properties": {
          "group_file_repository_right_id": {
            "description": "Group file repository right id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean",
            "default": true
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean",
            "default": true
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "group_file_repository_right_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiCreateGroupFileRepositoryRightRequest": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "file_repository_id": {
            "description": "File repository id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean",
            "default": true
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean",
            "default": true
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "group_id",
          "file_repository_id"
        ],
        "x-psono-validation-errors": [
          "GROUP_HAS_ALREADY_RIGHTS_FOR_FILE_REPOSITORY",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiGroupFileRepositoryRightPutResult201": {
        "type": "object",
        "properties": {
          "group_file_repository_right_id": {
            "type": "string",
            "description": "Group file repository right id identifier."
          }
        },
        "required": [
          "group_file_repository_right_id"
        ]
      },
      "RestapiFileRepositoryDownloadPutResult200": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type."
          },
          "url": {
            "type": "string",
            "description": "Url."
          }
        },
        "required": [
          "type",
          "url"
        ]
      },
      "RestapiFileRepositoryUploadPutResult200": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "Url."
          },
          "fields": {
            "type": "object",
            "additionalProperties": true,
            "description": "Fields."
          }
        },
        "required": [
          "url",
          "fields"
        ]
      },
      "RestapiDeleteFileRepositoryRequest": {
        "type": "object",
        "properties": {
          "file_repository_id": {
            "description": "File repository id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "file_repository_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiFileRepositoryPutResult201": {
        "type": "object",
        "properties": {
          "file_repository_id": {
            "type": "string",
            "description": "File repository id identifier."
          }
        },
        "required": [
          "file_repository_id"
        ]
      },
      "RestapiBulkDeleteSecretLinkRequest": {
        "type": "object",
        "properties": {
          "link_ids": {
            "description": "Link ids.",
            "type": "array",
            "items": {
              "description": "Link ids item.",
              "type": "string",
              "format": "uuid"
            },
            "minItems": 1
          }
        },
        "required": [
          "link_ids"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiBulkMoveSecretLinkRequest": {
        "type": "object",
        "properties": {
          "link_ids": {
            "description": "Link ids.",
            "type": "array",
            "items": {
              "description": "Link ids item.",
              "type": "string",
              "format": "uuid"
            },
            "minItems": 1
          },
          "new_parent_share_id": {
            "description": "New parent share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "new_parent_datastore_id": {
            "description": "New parent datastore id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "link_ids"
        ],
        "x-psono-validation-errors": [
          "NO_PARENT_PROVIDED",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiBulkCreateSecretRequest": {
        "type": "object",
        "properties": {
          "secrets": {
            "description": "Secrets.",
            "type": "array",
            "items": {
              "description": "Secrets item.",
              "$ref": "#/components/schemas/RestapiBulkCreateSecretSingleRequest"
            },
            "minItems": 1
          },
          "parent_share_id": {
            "description": "Parent share UUID. Where a parent datastore is also supported, supply exactly one parent.",
            "type": "string",
            "format": "uuid"
          },
          "parent_datastore_id": {
            "description": "Parent datastore UUID. Where a parent share is also supported, supply exactly one parent.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "secrets"
        ],
        "oneOf": [
          {
            "required": [
              "parent_datastore_id"
            ]
          },
          {
            "required": [
              "parent_share_id"
            ]
          }
        ],
        "description": "Supply exactly one parent: parent_datastore_id or parent_share_id.",
        "x-psono-validation-errors": [
          "EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED",
          "EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED_NOT_BOTH",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiBulkCreateSecretSingleRequest": {
        "type": "object",
        "properties": {
          "data": {
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope.",
            "type": "string",
            "minLength": 1
          },
          "data_nonce": {
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "callback_url": {
            "description": "Callback URL; an empty value disables the callback.",
            "type": "string",
            "maxLength": 2048,
            "default": ""
          },
          "callback_user": {
            "description": "Optional callback HTTP authentication username.",
            "type": "string",
            "maxLength": 128,
            "default": ""
          },
          "callback_pass": {
            "description": "Optional callback HTTP authentication password.",
            "type": "string",
            "maxLength": 128,
            "default": ""
          },
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "data",
          "data_nonce",
          "link_id"
        ]
      },
      "RestapiBulkSecretPutResult201": {
        "type": "object",
        "properties": {
          "secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "link_id": {
                  "type": "string",
                  "description": "Client-generated unique link UUID."
                },
                "secret_id": {
                  "type": "string",
                  "description": "Secret id identifier."
                }
              },
              "required": [
                "link_id",
                "secret_id"
              ]
            },
            "description": "Secrets."
          }
        },
        "required": [
          "secrets"
        ]
      },
      "RestapiBulkReadSecretRequest": {
        "type": "object",
        "properties": {
          "secret_ids": {
            "description": "Secret ids.",
            "type": "array",
            "items": {
              "description": "Secret ids item.",
              "type": "string",
              "format": "uuid"
            }
          }
        },
        "required": [
          "secret_ids"
        ]
      },
      "RestapiBulkSecretReadPostResult200": {
        "type": "object",
        "properties": {
          "secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": "string",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": "string",
                  "description": "Last write time in ISO 8601 format."
                },
                "data": {
                  "type": "string",
                  "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope."
                },
                "data_nonce": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "string",
                      "example": ""
                    }
                  ],
                  "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce."
                },
                "type": {
                  "type": "string",
                  "description": "Type."
                },
                "read_count": {
                  "type": "integer",
                  "description": "Read count including the current read where applicable."
                },
                "callback_url": {
                  "type": "string",
                  "description": "Callback URL; an empty value disables the callback."
                },
                "callback_user": {
                  "type": "string",
                  "description": "Optional callback HTTP authentication username."
                },
                "callback_pass": {
                  "type": "string",
                  "example": "",
                  "description": "Optional callback HTTP authentication password."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "data",
                "data_nonce",
                "type",
                "read_count",
                "callback_url",
                "callback_user",
                "callback_pass"
              ]
            },
            "description": "Secrets."
          }
        },
        "required": [
          "secrets"
        ]
      },
      "RestapiUpdateSecretRequest": {
        "type": "object",
        "properties": {
          "secret_id": {
            "description": "Secret id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "data": {
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope.",
            "type": "string",
            "minLength": 1
          },
          "data_nonce": {
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "old_write_date": {
            "description": "Expected previous write timestamp for optimistic concurrency control.",
            "type": "string",
            "format": "date-time"
          },
          "callback_url": {
            "description": "Callback URL; an empty value disables the callback.",
            "type": "string",
            "maxLength": 2048
          },
          "callback_user": {
            "description": "Optional callback HTTP authentication username.",
            "type": "string",
            "maxLength": 128
          },
          "callback_pass": {
            "description": "Optional callback HTTP authentication password.",
            "type": "string",
            "maxLength": 128
          }
        },
        "required": [
          "secret_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "WRITE_DATE_MISMATCH"
        ]
      },
      "RestapiSecretHistoryGetResult200": {
        "type": "object",
        "properties": {
          "history": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                }
              },
              "required": [
                "id",
                "create_date",
                "username"
              ]
            },
            "description": "History."
          }
        },
        "required": [
          "history"
        ]
      },
      "RestapiHistoryGetResult200": {
        "type": "object",
        "properties": {
          "create_date": {
            "type": "string",
            "description": "Creation time in ISO 8601 format."
          },
          "write_date": {
            "type": "string",
            "description": "Last write time in ISO 8601 format."
          },
          "data": {
            "type": "string",
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope."
          },
          "data_nonce": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "example": ""
              }
            ],
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce."
          },
          "type": {
            "type": "string",
            "description": "Type."
          },
          "callback_url": {
            "type": "string",
            "description": "Callback URL; an empty value disables the callback."
          },
          "callback_user": {
            "type": "string",
            "description": "Optional callback HTTP authentication username."
          },
          "callback_pass": {
            "type": "string",
            "example": "",
            "description": "Optional callback HTTP authentication password."
          }
        },
        "required": [
          "create_date",
          "write_date",
          "data",
          "data_nonce",
          "type",
          "callback_url",
          "callback_user",
          "callback_pass"
        ]
      },
      "RestapiShareRightsGetResult200": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "own_share_rights": {
            "$ref": "#/components/schemas/EffectiveAccess",
            "description": "Own share rights."
          },
          "user_share_rights": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": "string",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": "string",
                  "description": "Last write time in ISO 8601 format."
                },
                "accepted": {
                  "type": "boolean",
                  "example": true,
                  "description": "Whether the invitation/right has been accepted."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "grant": {
                  "type": "boolean",
                  "description": "Whether the recipient may grant access to others."
                },
                "group_id": {
                  "type": "string",
                  "description": "Group id identifier."
                },
                "share_id": {
                  "type": "string",
                  "description": "Share id identifier."
                },
                "group_name": {
                  "type": "string",
                  "description": "Group name."
                },
                "expiration_date": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Expiration date."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "accepted",
                "read",
                "write",
                "grant",
                "group_id",
                "share_id",
                "group_name",
                "expiration_date"
              ]
            },
            "description": "User share rights."
          },
          "group_share_rights": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": "string",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": "string",
                  "description": "Last write time in ISO 8601 format."
                },
                "accepted": {
                  "type": "boolean",
                  "example": true,
                  "description": "Whether the invitation/right has been accepted."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "grant": {
                  "type": "boolean",
                  "description": "Whether the recipient may grant access to others."
                },
                "group_id": {
                  "type": "string",
                  "description": "Group id identifier."
                },
                "share_id": {
                  "type": "string",
                  "description": "Share id identifier."
                },
                "group_name": {
                  "type": "string",
                  "description": "Group name."
                },
                "expiration_date": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Expiration date."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "accepted",
                "read",
                "write",
                "grant",
                "group_id",
                "share_id",
                "group_name",
                "expiration_date"
              ]
            },
            "description": "Group share rights."
          }
        },
        "required": [
          "id",
          "own_share_rights",
          "user_share_rights",
          "group_share_rights"
        ]
      },
      "RestapiShareRightAcceptRequest": {
        "type": "object",
        "properties": {
          "share_right_id": {
            "description": "Share right id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "key": {
            "description": "Wrapped encryption key for the recipient, as indicated by key_type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "key_type": {
            "description": "Key-wrapping method used for the key value.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256,
            "default": "symmetric"
          },
          "key_nonce": {
            "description": "Hex-encoded nonce for key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "share_right_id"
        ]
      },
      "RestapiShareRightAcceptPostResult200": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "share_id": {
                "type": "string",
                "description": "Share id identifier."
              },
              "share_type": {
                "type": "string",
                "description": "Share type."
              },
              "share_type_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for share type."
              }
            },
            "required": [
              "share_id",
              "share_type",
              "share_type_nonce"
            ]
          },
          {
            "type": "object",
            "properties": {
              "share_id": {
                "type": "string",
                "description": "Share id identifier."
              },
              "share_data": {
                "type": "string",
                "description": "Share data."
              },
              "share_data_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for share data."
              },
              "share_type": {
                "type": "string",
                "description": "Share type."
              },
              "share_type_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for share type."
              }
            },
            "required": [
              "share_id",
              "share_data",
              "share_data_nonce",
              "share_type",
              "share_type_nonce"
            ]
          }
        ]
      },
      "RestapiShareRightDeclineRequest": {
        "type": "object",
        "properties": {
          "share_right_id": {
            "description": "Share right id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "share_right_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiDeleteShareRightRequest": {
        "type": "object",
        "properties": {
          "user_share_right_id": {
            "description": "User share right id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_share_right_id": {
            "description": "Group share right id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiShareRightGetResult200": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "title": {
            "type": "string",
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
          },
          "title_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for title."
          },
          "key": {
            "type": "string",
            "description": "Wrapped encryption key for the recipient, as indicated by key_type."
          },
          "key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for key."
          },
          "read": {
            "type": "boolean",
            "description": "Whether read access is granted."
          },
          "write": {
            "type": "boolean",
            "description": "Whether write access is granted."
          },
          "grant": {
            "type": "boolean",
            "description": "Whether the recipient may grant access to others."
          },
          "share_id": {
            "type": "string",
            "description": "Share id identifier."
          },
          "expiration_date": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Expiration date."
          }
        },
        "required": [
          "id",
          "title",
          "title_nonce",
          "key",
          "key_nonce",
          "read",
          "write",
          "grant",
          "share_id",
          "expiration_date"
        ]
      },
      "RestapiUpdateShareRightRequest": {
        "type": "object",
        "properties": {
          "share_id": {
            "description": "Share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean"
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean"
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean"
          },
          "expiration_date": {
            "description": "Expiration date.",
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "required": [
          "share_id",
          "read",
          "write",
          "grant"
        ],
        "x-psono-validation-errors": [
          "EXPIRATION_DATE_NEEDS_TO_BE_IN_THE_FUTURE",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiShareRightPostResult200": {
        "type": "object",
        "properties": {
          "share_right_id": {
            "type": "string",
            "description": "Share right id identifier."
          }
        },
        "required": [
          "share_right_id"
        ]
      },
      "RestapiCreateShareRightRequest": {
        "type": "object",
        "properties": {
          "key": {
            "description": "Wrapped encryption key for the recipient, as indicated by key_type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "key_nonce": {
            "description": "Hex-encoded nonce for key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          },
          "title_nonce": {
            "description": "Hex-encoded nonce for title.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "type": {
            "description": "Type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          },
          "type_nonce": {
            "description": "Hex-encoded nonce for type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "share_id": {
            "description": "Share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean"
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean"
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean"
          },
          "expiration_date": {
            "description": "Expiration date.",
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "required": [
          "key",
          "key_nonce",
          "title",
          "title_nonce",
          "type",
          "type_nonce",
          "share_id",
          "read",
          "write",
          "grant"
        ],
        "x-psono-validation-errors": [
          "EXPIRATION_DATE_NEEDS_TO_BE_IN_THE_FUTURE",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiShareRightPutResult201": {
        "type": "object",
        "properties": {
          "share_right_id": {
            "type": "string",
            "description": "Share right id identifier."
          }
        },
        "required": [
          "share_right_id"
        ]
      },
      "RestapiUpdateShareLinkRequest": {
        "type": "object",
        "properties": {
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          },
          "new_parent_share_id": {
            "description": "New parent share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "new_parent_datastore_id": {
            "description": "New parent datastore id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "link_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiCreateShareLinkRequest": {
        "type": "object",
        "properties": {
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          },
          "share_id": {
            "description": "Share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "parent_share_id": {
            "description": "Parent share UUID. Where a parent datastore is also supported, supply exactly one parent.",
            "type": "string",
            "format": "uuid"
          },
          "parent_datastore_id": {
            "description": "Parent datastore UUID. Where a parent share is also supported, supply exactly one parent.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "link_id",
          "share_id"
        ],
        "oneOf": [
          {
            "required": [
              "parent_datastore_id"
            ]
          },
          {
            "required": [
              "parent_share_id"
            ]
          }
        ],
        "description": "Supply exactly one parent: parent_datastore_id or parent_share_id.",
        "x-psono-validation-errors": [
          "EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED",
          "EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED_NOT_BOTH",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiSharePostResult201": {
        "type": "object",
        "properties": {
          "share_id": {
            "type": "string",
            "description": "Share id identifier."
          }
        },
        "required": [
          "share_id"
        ]
      },
      "RestapiUpdateShareRequest": {
        "type": "object",
        "properties": {
          "share_id": {
            "description": "Share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "data": {
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope.",
            "type": "string",
            "minLength": 1
          },
          "data_nonce": {
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "old_write_date": {
            "description": "Expected previous write timestamp for optimistic concurrency control.",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "share_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "WRITE_DATE_MISMATCH"
        ]
      },
      "RestapiDeleteGroupRequest": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUpdateGroupRequest": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          }
        },
        "required": [
          "group_id",
          "name"
        ],
        "x-psono-validation-errors": [
          "NAME_CONTAINS_FORBIDDEN_CHARACTERS",
          "NAME_TOO_SHORT",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiGroupPutResult201": {
        "type": "object",
        "properties": {
          "group_id": {
            "type": "string",
            "description": "Group id identifier."
          },
          "name": {
            "type": "string",
            "description": "Display name."
          },
          "secret_key": {
            "type": "string",
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
          },
          "secret_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for secret key."
          },
          "secret_key_type": {
            "type": "string",
            "example": "symmetric",
            "description": "Secret key type."
          },
          "private_key": {
            "type": "string",
            "description": "Encrypted private key; never send an unencrypted vault private key here."
          },
          "private_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for private key."
          },
          "private_key_type": {
            "type": "string",
            "example": "symmetric",
            "description": "Private key type."
          },
          "public_key": {
            "type": "string",
            "description": "Hex-encoded public key."
          },
          "group_admin": {
            "type": "boolean",
            "example": true,
            "description": "Group admin."
          },
          "share_admin": {
            "type": "boolean",
            "example": true,
            "description": "Share admin."
          },
          "accepted": {
            "type": "boolean",
            "example": true,
            "description": "Whether the invitation/right has been accepted."
          }
        },
        "required": [
          "group_id",
          "name",
          "secret_key",
          "secret_key_nonce",
          "secret_key_type",
          "private_key",
          "private_key_nonce",
          "private_key_type",
          "public_key",
          "group_admin",
          "share_admin",
          "accepted"
        ]
      },
      "RestapiGroupRightsGetResult200": {
        "type": "object",
        "properties": {
          "group_rights": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "group_id": {
                  "type": "string",
                  "description": "Group id identifier."
                },
                "share_id": {
                  "type": "string",
                  "description": "Share id identifier."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "grant": {
                  "type": "boolean",
                  "description": "Whether the recipient may grant access to others."
                },
                "expiration_date": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Expiration date."
                }
              },
              "required": [
                "id",
                "group_id",
                "share_id",
                "read",
                "write",
                "grant",
                "expiration_date"
              ]
            },
            "description": "Group rights."
          }
        },
        "required": [
          "group_rights"
        ]
      },
      "RestapiMembershipAcceptRequest": {
        "type": "object",
        "properties": {
          "membership_id": {
            "description": "Membership id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "membership_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST_OR_ALREADY_PROCESSED_MEMBERSHIP"
        ]
      },
      "RestapiMembershipAcceptPostResult200": {
        "type": "object",
        "properties": {
          "shares": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "share_id": {
                  "type": "string",
                  "description": "Share id identifier."
                },
                "share_title": {
                  "type": "string",
                  "description": "Share title."
                },
                "share_title_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for share title."
                },
                "share_type": {
                  "type": "string",
                  "description": "Share type."
                },
                "share_type_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for share type."
                },
                "share_key": {
                  "type": "string",
                  "description": "Share key."
                },
                "share_key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for share key."
                }
              },
              "required": [
                "share_id",
                "share_title",
                "share_title_nonce",
                "share_type",
                "share_type_nonce",
                "share_key",
                "share_key_nonce"
              ]
            },
            "description": "Shares."
          },
          "secret_key": {
            "type": "string",
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
          },
          "secret_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for secret key."
          },
          "secret_key_type": {
            "type": "string",
            "description": "Secret key type."
          },
          "private_key": {
            "type": "string",
            "description": "Encrypted private key; never send an unencrypted vault private key here."
          },
          "private_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for private key."
          },
          "private_key_type": {
            "type": "string",
            "description": "Private key type."
          }
        },
        "required": [
          "shares",
          "secret_key",
          "secret_key_nonce",
          "secret_key_type",
          "private_key",
          "private_key_nonce",
          "private_key_type"
        ]
      },
      "RestapiDeleteMembershipRequest": {
        "type": "object",
        "properties": {
          "membership_id": {
            "description": "Membership id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "membership_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUpdateMembershipRequest": {
        "type": "object",
        "properties": {
          "membership_id": {
            "description": "Membership id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_admin": {
            "description": "Group admin.",
            "type": "boolean",
            "default": false
          },
          "share_admin": {
            "description": "Share admin.",
            "type": "boolean",
            "default": true
          }
        },
        "required": [
          "membership_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiCreateMembershipRequest": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "secret_key_type": {
            "description": "Secret key type.",
            "type": "string",
            "minLength": 1,
            "default": "asymmetric"
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "private_key_type": {
            "description": "Private key type.",
            "type": "string",
            "minLength": 1,
            "default": "asymmetric"
          },
          "group_admin": {
            "description": "Group admin.",
            "type": "boolean",
            "default": false
          },
          "share_admin": {
            "description": "Share admin.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "user_id",
          "group_id",
          "secret_key",
          "secret_key_nonce",
          "private_key",
          "private_key_nonce"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "NO_VALID_HEX",
          "UNKNOWN_PRIVATE_KEY_TYPE",
          "UNKNOWN_SECRET_KEY_TYPE",
          "USER_ALREADY_PART_OF_GROUP",
          "USER_DOES_NOT_EXIST"
        ]
      },
      "RestapiMembershipPutResult201": {
        "type": "object",
        "properties": {
          "membership_id": {
            "type": "string",
            "description": "Membership id identifier."
          }
        },
        "required": [
          "membership_id"
        ]
      },
      "RestapiMetadataDatastoreGetResult200": {
        "type": "object",
        "properties": {
          "write_date": {
            "type": "string",
            "description": "Last write time in ISO 8601 format."
          },
          "shares": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "write_date": {
                  "type": "string",
                  "description": "Last write time in ISO 8601 format."
                }
              },
              "required": [
                "id",
                "write_date"
              ]
            },
            "description": "Shares."
          },
          "secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "write_date": {
                  "type": "string",
                  "description": "Last write time in ISO 8601 format."
                }
              },
              "required": [
                "id",
                "write_date"
              ]
            },
            "description": "Secrets."
          }
        },
        "required": [
          "write_date",
          "shares",
          "secrets"
        ]
      },
      "RestapiManagementCommandRequest": {
        "type": "object",
        "properties": {
          "command_name": {
            "description": "Command name.",
            "type": "string",
            "minLength": 1
          },
          "command_args": {
            "description": "Command args.",
            "type": "array",
            "items": {},
            "default": []
          }
        },
        "required": [
          "command_name"
        ],
        "x-psono-validation-errors": [
          "MANAGEMENT_COMMAND_NOT_ALLOWED"
        ]
      },
      "RestapiCreateDeviceCodeRequest": {
        "type": "object",
        "properties": {
          "device_fingerprint": {
            "description": "Unique fingerprint identifier for the initiating device.",
            "type": "string",
            "minLength": 22,
            "maxLength": 128
          },
          "device_description": {
            "description": "Description of the initiating device.",
            "type": "string",
            "minLength": 3,
            "maxLength": 256
          },
          "device_date": {
            "description": "Device timestamp in ISO format.",
            "type": "string",
            "format": "date-time"
          },
          "user_public_key": {
            "description": "Hex-encoded public key of the initiating user/device.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "client_type": {
            "description": "Initiating client type, as in normal login; omitted or null defaults to app.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64,
            "default": "app"
          },
          "session_duration": {
            "description": "Requested session duration in seconds; omitted or null uses the client type's default.",
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 2147483647
          }
        },
        "required": [
          "device_fingerprint",
          "device_description",
          "device_date",
          "user_public_key"
        ],
        "x-psono-validation-errors": [
          "INVALID_USER_PUBLIC_KEY"
        ]
      },
      "RestapiDeviceCodePostResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "user_code": {
            "type": "string",
            "description": "User code."
          },
          "state": {
            "type": "string",
            "description": "State."
          },
          "valid_till": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Expiration time in ISO 8601 format."
          },
          "server_public_key": {
            "type": "string",
            "description": "Server public key."
          },
          "web_client_url": {
            "type": "string",
            "description": "Web client url."
          }
        },
        "required": [
          "id",
          "user_code",
          "state",
          "valid_till",
          "server_public_key",
          "web_client_url"
        ]
      },
      "RestapiDeviceCodeTokenPostResult200": {
        "type": "object",
        "properties": {
          "boxed_payload": {
            "type": "string",
            "description": "Boxed payload."
          },
          "nonce": {
            "type": "string",
            "description": "Hex-encoded encryption nonce. Use the nonce for the indicated ciphertext/key pair."
          }
        },
        "required": [
          "boxed_payload",
          "nonce"
        ]
      },
      "RestapiClaimDeviceCodeRequest": {
        "type": "object",
        "properties": {
          "encrypted_credentials_input": {
            "description": "Hex-encoded encrypted credentials (keys and token).",
            "type": "string",
            "minLength": 1
          },
          "encrypted_credentials_nonce": {
            "description": "Hex-encoded nonce used for encryption.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "encrypted_credentials_input",
          "encrypted_credentials_nonce"
        ],
        "x-psono-validation-errors": [
          "API_KEY_SESSION_NOT_ALLOWED",
          "DEVICE_CODE_ALREADY_CLAIMED",
          "DEVICE_CODE_INSTANCE_REQUIRED",
          "DEVICE_CODE_USER_MISMATCH",
          "NO_VALID_HEX",
          "USER_AUTHENTICATION_REQUIRED"
        ]
      },
      "RestapiDeviceCodeClaimGetResult200": {
        "type": "object",
        "properties": {
          "user_code": {
            "type": "string",
            "description": "User code."
          },
          "device_description": {
            "type": "string",
            "description": "Human-readable description of the client device."
          },
          "device_fingerprint": {
            "type": "string",
            "description": "Client device/session fingerprint used by device protection."
          },
          "device_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Device date."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "valid_till": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Expiration time in ISO 8601 format."
          },
          "state": {
            "type": "string",
            "description": "State."
          }
        },
        "required": [
          "user_code",
          "device_description",
          "device_fingerprint",
          "device_date",
          "create_date",
          "valid_till",
          "state"
        ]
      },
      "RestapiDeviceCodeClaimPutResult200": {
        "type": "object",
        "properties": {
          "state": {
            "type": "string",
            "description": "State."
          },
          "user": {
            "type": "string",
            "description": "Id identifier."
          },
          "server_public_key": {
            "type": "string",
            "description": "Server public key."
          },
          "user_public_key": {
            "type": "string",
            "description": "User public key."
          },
          "encrypted_credentials": {
            "type": [
              "string",
              "null"
            ],
            "description": "Encrypted credentials."
          },
          "encrypted_credentials_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for encrypted credentials."
          }
        },
        "required": [
          "state",
          "user",
          "server_public_key",
          "user_public_key",
          "encrypted_credentials",
          "encrypted_credentials_nonce"
        ]
      },
      "RestapiHealthCheckGetResult200": {
        "type": "object",
        "properties": {
          "db_read": {
            "type": "object",
            "properties": {
              "healthy": {
                "type": "boolean",
                "example": false,
                "description": "Healthy."
              }
            },
            "required": [
              "healthy"
            ],
            "description": "Db read."
          },
          "db_sync": {
            "type": "object",
            "properties": {
              "healthy": {
                "type": "boolean",
                "example": false,
                "description": "Healthy."
              }
            },
            "required": [
              "healthy"
            ],
            "description": "Db sync."
          },
          "time_sync": {
            "type": "object",
            "properties": {
              "healthy": {
                "type": "boolean",
                "example": false,
                "description": "Healthy."
              }
            },
            "required": [
              "healthy"
            ],
            "description": "Time sync."
          },
          "_info": {
            "type": "object",
            "properties": {
              "ip": {
                "type": "string",
                "description": "Ip."
              }
            },
            "required": [
              "ip"
            ],
            "description": "Info."
          }
        },
        "required": [
          "db_read",
          "db_sync",
          "time_sync",
          "_info"
        ]
      },
      "AdministrationTenantPostResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "name": {
            "type": "string",
            "description": "Display name."
          },
          "description": {
            "type": "string",
            "description": "Human-readable description."
          },
          "is_active": {
            "type": "boolean",
            "description": "Is active."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "write_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Last write time in ISO 8601 format."
          },
          "user_count": {
            "type": "integer",
            "description": "User count."
          },
          "group_count": {
            "type": "integer",
            "description": "Group count."
          },
          "users": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                }
              },
              "required": [
                "id",
                "username"
              ]
            },
            "description": "Users."
          },
          "groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                }
              },
              "required": [
                "id",
                "name"
              ]
            },
            "description": "Groups."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "is_active",
          "create_date",
          "write_date",
          "user_count",
          "group_count"
        ]
      },
      "AdministrationTenantMembershipRequest": {
        "type": "object",
        "properties": {
          "tenant_id": {
            "description": "Tenant id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "tenant_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "USER_OR_GROUP_REQUIRED"
        ]
      },
      "AdministrationAdministrativeRoleRequest": {
        "type": "object",
        "properties": {
          "role_id": {
            "description": "Role id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "description": {
            "description": "Human-readable description.",
            "type": "string"
          },
          "is_active": {
            "description": "Is active.",
            "type": "boolean"
          },
          "capabilities": {
            "description": "Capabilities.",
            "type": "array",
            "items": {
              "description": "Capabilities item.",
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          }
        },
        "x-psono-validation-errors": [
          "ADMINISTRATIVE_ROLE_NAME_ALREADY_EXISTS",
          "FIELD_REQUIRED",
          "INVALID_CAPABILITY",
          "NO_PERMISSION_OR_NOT_EXIST",
          "ROLE_REQUIRES_GLOBAL_SCOPE"
        ],
        "required": [
          "role_id"
        ]
      },
      "AdministrationAdministrativeRolePostResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "name": {
            "type": "string",
            "description": "Display name."
          },
          "description": {
            "type": "string",
            "description": "Human-readable description."
          },
          "is_active": {
            "type": "boolean",
            "description": "Is active."
          },
          "is_system": {
            "type": "boolean",
            "description": "Is system."
          },
          "is_full_access": {
            "type": "boolean",
            "description": "Is full access."
          },
          "capabilities": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Capabilities."
          },
          "assignments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "role_id": {
                  "type": "string",
                  "description": "Role id identifier."
                },
                "role_name": {
                  "type": "string",
                  "description": "Role name."
                },
                "user_id": {
                  "type": "string",
                  "description": "User id identifier."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "is_global": {
                  "type": "boolean",
                  "description": "Is global."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "description": "Tenant ids."
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name."
                      }
                    },
                    "required": [
                      "id",
                      "name"
                    ]
                  },
                  "description": "Tenants."
                }
              },
              "required": [
                "id",
                "role_id",
                "role_name",
                "user_id",
                "username",
                "is_global",
                "tenant_ids",
                "tenants"
              ]
            },
            "description": "Assignments."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "is_active",
          "is_system",
          "is_full_access",
          "capabilities"
        ]
      },
      "AdministrationAdministrativeRoleAssignmentRequest": {
        "type": "object",
        "properties": {
          "assignment_id": {
            "description": "Assignment id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "role_id": {
            "description": "Role id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "is_global": {
            "description": "Is global.",
            "type": "boolean"
          },
          "tenant_ids": {
            "description": "Tenant ids.",
            "type": "array",
            "items": {
              "description": "Tenant ids item.",
              "type": "string",
              "format": "uuid"
            }
          }
        },
        "x-psono-validation-errors": [
          "ADMINISTRATIVE_ROLE_ASSIGNMENT_ALREADY_EXISTS",
          "DUPLICATE_TENANT",
          "GLOBAL_ASSIGNMENT_HAS_TENANTS",
          "NO_PERMISSION_OR_NOT_EXIST",
          "ROLE_AND_USER_REQUIRED",
          "ROLE_REQUIRES_GLOBAL_SCOPE",
          "TENANT_NOT_EXIST",
          "TENANT_REQUIRED"
        ],
        "required": [
          "assignment_id"
        ]
      },
      "AdministrationAdministrativeRoleAssignmentPostResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "role_id": {
            "type": "string",
            "description": "Role id identifier."
          },
          "role_name": {
            "type": "string",
            "description": "Role name."
          },
          "user_id": {
            "type": "string",
            "description": "User id identifier."
          },
          "username": {
            "type": "string",
            "description": "Account username, normally including the configured domain."
          },
          "is_global": {
            "type": "boolean",
            "description": "Is global."
          },
          "tenant_ids": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Tenant ids."
          },
          "tenants": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                }
              },
              "required": [
                "id",
                "name"
              ]
            },
            "description": "Tenants."
          }
        },
        "required": [
          "id",
          "role_id",
          "role_name",
          "user_id",
          "username",
          "is_global",
          "tenant_ids",
          "tenants"
        ]
      },
      "AdministrationInfoGetResult200": {
        "type": "object",
        "properties": {
          "info": {
            "type": "string",
            "example": "",
            "description": "JSON-encoded string. Preserve its exact bytes when signing or verifying it."
          },
          "signature": {
            "type": "string",
            "example": "",
            "description": "Hex-encoded detached signature over the exact serialized signed payload."
          },
          "verify_key": {
            "type": "string",
            "example": "",
            "description": "Verify key."
          },
          "token_count_total": {
            "type": "integer",
            "description": "Token count total."
          },
          "token_count_device": {
            "type": "integer",
            "description": "Token count device."
          },
          "token_count_user": {
            "type": "integer",
            "description": "Token count user."
          },
          "user_count_active": {
            "type": "integer",
            "description": "User count active."
          },
          "user_count_total": {
            "type": "integer",
            "description": "User count total."
          },
          "registrations_over_month": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "count_new": {
                  "type": "integer",
                  "description": "Count new."
                },
                "count_total": {
                  "type": "integer",
                  "description": "Count total."
                },
                "month": {
                  "type": "string",
                  "description": "Month."
                }
              },
              "required": [
                "count_new",
                "count_total",
                "month"
              ]
            },
            "description": "Registrations over month."
          },
          "registrations_over_day": {
            "type": "array",
            "items": {},
            "description": "Registrations over day."
          },
          "fileserver": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "fileserver_cluster_title": {
                  "type": "string",
                  "description": "Fileserver cluster title."
                },
                "hostname": {
                  "type": "string",
                  "description": "Hostname."
                },
                "version": {
                  "type": "string",
                  "description": "Version."
                }
              },
              "required": [
                "create_date",
                "fileserver_cluster_title",
                "hostname",
                "version"
              ]
            },
            "description": "Fileserver."
          },
          "registrations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "date": {
                  "description": "Date.",
                  "type": "string"
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                }
              },
              "required": [
                "date",
                "username",
                "active"
              ]
            },
            "description": "Registrations."
          }
        },
        "required": [
          "info",
          "signature",
          "verify_key"
        ]
      },
      "AdministrationDeleteUserRequest": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "confirm_shared_ownership": {
            "description": "Confirm shared ownership.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "user_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "SHARED_OWNERSHIP_CONFIRMATION_REQUIRED"
        ]
      },
      "AdministrationCreateUserRequest": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "email": {
            "description": "Email address.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "password": {
            "description": "Password value for the operation; password and authkey are different credentials.",
            "type": "string",
            "minLength": 1
          },
          "language": {
            "description": "Language.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 16
          },
          "require_password_change": {
            "description": "Require password change.",
            "type": "boolean"
          },
          "tenant_ids": {
            "description": "Tenant ids.",
            "type": "array",
            "items": {
              "description": "Tenant ids item.",
              "type": "string",
              "format": "uuid"
            }
          }
        },
        "required": [
          "username",
          "email"
        ],
        "x-psono-validation-errors": [
          "DUPLICATE_TENANT",
          "TENANT_NOT_EXIST",
          "TENANT_REQUIRED",
          "USER_WITH_EMAIL_ALREADY_EXISTS",
          "USER_WITH_USERNAME_ALREADY_EXISTS"
        ]
      },
      "AdministrationUserPostResult201": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "password": {
            "type": [
              "string",
              "null"
            ],
            "description": "Password value for the operation; password and authkey are different credentials."
          }
        },
        "required": [
          "id",
          "password"
        ]
      },
      "AdministrationDeleteUserShareRightRequest": {
        "type": "object",
        "properties": {
          "user_share_right_id": {
            "description": "User share right id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "user_share_right_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationUpdateUserShareRightRequest": {
        "type": "object",
        "properties": {
          "user_share_right_id": {
            "description": "User share right id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean"
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean"
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean"
          }
        },
        "required": [
          "user_share_right_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeleteRecoveryCodeRequest": {
        "type": "object",
        "properties": {
          "recovery_code_id": {
            "description": "Recovery code id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "recovery_code_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationRecoveryCodeGetResult200": {
        "type": "object",
        "properties": {
          "recovery_codes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "user": {
                  "type": "string",
                  "description": "User."
                }
              },
              "required": [
                "id",
                "create_date",
                "user"
              ]
            },
            "description": "Recovery codes."
          }
        },
        "required": [
          "recovery_codes"
        ]
      },
      "AdministrationEmergencyCodeGetResult200": {
        "type": "object",
        "properties": {
          "emergency_codes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "user": {
                  "type": "string",
                  "description": "User."
                },
                "description": {
                  "type": "string",
                  "description": "Human-readable description."
                }
              },
              "required": [
                "id",
                "create_date",
                "user",
                "description"
              ]
            },
            "description": "Emergency codes."
          }
        },
        "required": [
          "emergency_codes"
        ]
      },
      "AdministrationDeleteSessionRequest": {
        "type": "object",
        "properties": {
          "session_id": {
            "description": "Session id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "session_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationSessionGetResult200": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "sessions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "valid_till": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Expiration time in ISO 8601 format."
                },
                "device_description": {
                  "type": "string",
                  "description": "Human-readable description of the client device."
                },
                "device_fingerprint": {
                  "type": "string",
                  "description": "Client device/session fingerprint used by device protection."
                }
              },
              "required": [
                "id",
                "create_date",
                "username",
                "active",
                "valid_till",
                "device_description",
                "device_fingerprint"
              ]
            },
            "description": "Sessions."
          }
        },
        "required": [
          "count",
          "sessions"
        ]
      },
      "AdministrationDeleteGroupRequest": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "confirm_shared_ownership": {
            "description": "Confirm shared ownership.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "SHARED_OWNERSHIP_CONFIRMATION_REQUIRED"
        ]
      },
      "AdministrationDeleteGroupShareRightRequest": {
        "type": "object",
        "properties": {
          "group_share_right_id": {
            "description": "Group share right id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_share_right_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationUpdateGroupShareRightRequest": {
        "type": "object",
        "properties": {
          "group_share_right_id": {
            "description": "Group share right id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean"
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean"
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean"
          }
        },
        "required": [
          "group_share_right_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationMembershipGetResult200": {
        "type": "object",
        "properties": {
          "memberships": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "group": {
                  "type": "string",
                  "description": "Group."
                }
              },
              "required": [
                "id",
                "create_date",
                "username",
                "group"
              ]
            },
            "description": "Memberships."
          }
        },
        "required": [
          "memberships"
        ]
      },
      "AdministrationUpdateMembershipRequest": {
        "type": "object",
        "properties": {
          "membership_id": {
            "description": "Membership id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_admin": {
            "description": "Group admin.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "share_admin": {
            "description": "Share admin.",
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "membership_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationStatsBrowserGetResult200": {
        "type": "object",
        "properties": {
          "other": {
            "type": "integer",
            "description": "Other."
          },
          "firefox": {
            "type": "integer",
            "description": "Firefox."
          },
          "chrome": {
            "type": "integer",
            "description": "Chrome."
          },
          "safari": {
            "type": "integer",
            "description": "Safari."
          },
          "vivaldi": {
            "type": "integer",
            "description": "Vivaldi."
          },
          "edge": {
            "type": "integer",
            "description": "Edge."
          },
          "brave": {
            "type": "integer",
            "description": "Brave."
          },
          "opera": {
            "type": "integer",
            "description": "Opera."
          }
        },
        "required": [
          "other",
          "firefox",
          "chrome",
          "safari",
          "vivaldi",
          "edge",
          "brave",
          "opera"
        ]
      },
      "AdministrationStatsDeviceGetResult200": {
        "type": "object",
        "properties": {
          "other": {
            "type": "integer",
            "description": "Other."
          },
          "linux": {
            "type": "integer",
            "description": "Linux."
          },
          "windows": {
            "type": "integer",
            "description": "Windows."
          },
          "mac": {
            "type": "integer",
            "description": "Mac."
          },
          "android": {
            "type": "integer",
            "description": "Android."
          },
          "iphone": {
            "type": "integer",
            "description": "Iphone."
          },
          "ipad": {
            "type": "integer",
            "description": "Ipad."
          }
        },
        "required": [
          "other",
          "linux",
          "windows",
          "mac",
          "android",
          "iphone",
          "ipad"
        ]
      },
      "AdministrationStatsOsGetResult200": {
        "type": "object",
        "properties": {
          "other": {
            "type": "integer",
            "description": "Other."
          },
          "linux": {
            "type": "integer",
            "description": "Linux."
          },
          "windows": {
            "type": "integer",
            "description": "Windows."
          },
          "mac_os": {
            "type": "integer",
            "description": "Mac os."
          },
          "android": {
            "type": "integer",
            "description": "Android."
          },
          "ios": {
            "type": "integer",
            "description": "Ios."
          },
          "ipados": {
            "type": "integer",
            "description": "Ipados."
          }
        },
        "required": [
          "other",
          "linux",
          "windows",
          "mac_os",
          "android",
          "ios",
          "ipados"
        ]
      },
      "AdministrationGenerateFileserverClusterConfigRequest": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "cluster_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "NO_SHARDS_LINKED"
        ]
      },
      "AdministrationFileserverClusterConfigPostResult200": {
        "type": "object",
        "properties": {
          "configuration": {
            "type": "object",
            "additionalProperties": true,
            "description": "Configuration."
          }
        },
        "required": [
          "configuration"
        ]
      },
      "AdministrationDeleteFileserverClusterRequest": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "cluster_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateFileserverClusterRequest": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "file_size_limit": {
            "description": "File size limit.",
            "type": "integer",
            "minimum": 0,
            "maximum": 9223372036854776000,
            "default": 0
          }
        },
        "required": [
          "title"
        ]
      },
      "AdministrationUpdateFileserverClusterRequest": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "file_size_limit": {
            "description": "File size limit.",
            "type": "integer",
            "minimum": 0,
            "maximum": 9223372036854776000
          }
        },
        "required": [
          "cluster_id",
          "title",
          "file_size_limit"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeleteFileserverShardRequest": {
        "type": "object",
        "properties": {
          "shard_id": {
            "description": "Shard id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "shard_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateFileserverShardRequest": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "description": {
            "description": "Human-readable description.",
            "type": "string"
          },
          "active": {
            "description": "Whether the resource or account is active.",
            "type": "boolean",
            "default": true
          }
        },
        "required": [
          "title",
          "description"
        ]
      },
      "AdministrationUpdateFileserverShardRequest": {
        "type": "object",
        "properties": {
          "shard_id": {
            "description": "Shard id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "description": {
            "description": "Human-readable description.",
            "type": "string"
          },
          "active": {
            "description": "Whether the resource or account is active.",
            "type": "boolean"
          }
        },
        "required": [
          "shard_id",
          "title",
          "description",
          "active"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateFileserverClusterShardLinkRequest": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "shard_id": {
            "description": "Shard id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean",
            "default": true
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean",
            "default": true
          },
          "delete_capability": {
            "description": "Delete capability.",
            "type": "boolean",
            "default": true
          },
          "allow_link_shares": {
            "description": "Allow link shares.",
            "type": "boolean",
            "default": true
          }
        },
        "required": [
          "cluster_id",
          "shard_id"
        ],
        "x-psono-validation-errors": [
          "LINK_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationUpdateFileserverClusterShardLinkRequest": {
        "type": "object",
        "properties": {
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean"
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean"
          },
          "delete_capability": {
            "description": "Delete capability.",
            "type": "boolean"
          },
          "allow_link_shares": {
            "description": "Allow link shares.",
            "type": "boolean"
          }
        },
        "required": [
          "link_id",
          "read",
          "write",
          "delete_capability",
          "allow_link_shares"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationStatsTwoFactorGetResult200": {
        "type": "object",
        "properties": {
          "users": {
            "type": "integer",
            "description": "Users."
          },
          "user_google_authenticator_enabled_count": {
            "type": "integer",
            "description": "User google authenticator enabled count."
          },
          "user_duo_enabled_count": {
            "type": "integer",
            "description": "User duo enabled count."
          },
          "user_webauthn_enabled_count": {
            "type": "integer",
            "description": "User webauthn enabled count."
          },
          "user_yubikey_otp_enabled_count": {
            "type": "integer",
            "description": "User yubikey otp enabled count."
          }
        },
        "required": [
          "users",
          "user_google_authenticator_enabled_count",
          "user_duo_enabled_count",
          "user_webauthn_enabled_count",
          "user_yubikey_otp_enabled_count"
        ]
      },
      "FileserverFileserverAuthorizeUploadRequest": {
        "type": "object",
        "properties": {
          "file_transfer_id": {
            "description": "File transfer id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "ticket": {
            "description": "Ticket.",
            "type": "string",
            "minLength": 1
          },
          "ticket_nonce": {
            "description": "Hex-encoded nonce for ticket.",
            "type": "string",
            "minLength": 1
          },
          "chunk_size": {
            "description": "Chunk size.",
            "type": "integer",
            "minimum": 0
          },
          "hash_checksum": {
            "description": "Hash checksum.",
            "type": "string",
            "minLength": 1
          },
          "ip_address": {
            "description": "Ip address.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "file_transfer_id",
          "ticket",
          "ticket_nonce",
          "chunk_size",
          "hash_checksum",
          "ip_address"
        ],
        "x-psono-validation-errors": [
          "HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION"
        ]
      },
      "FileserverAuthorizeUploadPutResult200": {
        "type": "object",
        "properties": {
          "shard_id": {
            "type": "string",
            "description": "Shard id identifier."
          }
        },
        "required": [
          "shard_id"
        ]
      },
      "FileserverFileserverAuthorizeDownloadRequest": {
        "type": "object",
        "properties": {
          "file_transfer_id": {
            "description": "File transfer id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "ticket": {
            "description": "Ticket.",
            "type": "string",
            "minLength": 1
          },
          "ticket_nonce": {
            "description": "Hex-encoded nonce for ticket.",
            "type": "string",
            "minLength": 1
          },
          "ip_address": {
            "description": "Ip address.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "file_transfer_id",
          "ticket",
          "ticket_nonce",
          "ip_address"
        ],
        "x-psono-validation-errors": [
          "HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "FileserverAuthorizeDownloadPutResult200": {
        "type": "object",
        "properties": {
          "shard_id": {
            "type": "string",
            "description": "Shard id identifier."
          },
          "hash_checksum": {
            "type": "string",
            "description": "Hash checksum."
          }
        },
        "required": [
          "shard_id",
          "hash_checksum"
        ]
      },
      "FileserverCleanupChunksGetResult200": {
        "type": "object",
        "properties": {
          "shards": {
            "type": "object",
            "properties": {},
            "description": "Shards."
          }
        },
        "required": [
          "shards"
        ]
      },
      "FileserverFileserverConfirmChunkDeletionRequest": {
        "type": "object",
        "properties": {
          "deleted_chunks": {
            "description": "Deleted chunks.",
            "type": "array",
            "items": {
              "description": "Deleted chunks item.",
              "type": "object",
              "additionalProperties": true
            }
          }
        },
        "required": [
          "deleted_chunks"
        ]
      },
      "RestapiLoginRequestEnterprise": {
        "type": "object",
        "properties": {
          "public_key": {
            "description": "Hex-encoded public key.",
            "type": "string",
            "minLength": 64,
            "maxLength": 64
          },
          "login_info": {
            "description": "Hex-encoded ciphertext for the operation-specific login exchange.",
            "type": "string",
            "minLength": 1
          },
          "login_info_nonce": {
            "description": "Hex-encoded nonce for login info.",
            "type": "string",
            "minLength": 1
          },
          "session_duration": {
            "description": "Requested session lifetime in seconds, bounded by server/client-type configuration.",
            "type": "integer"
          }
        },
        "required": [
          "public_key",
          "login_info",
          "login_info_nonce"
        ],
        "x-psono-validation-errors": [
          "ACCOUNT_NOT_VERIFIED",
          "AUTHKEY_REQUIRED",
          "IP_ADDRESS_NOT_ALLOWED",
          "LOGIN_INFO_CANNOT_BE_DECRYPTED",
          "USERNAME_OR_PASSWORD_WRONG",
          "USERNAME_REQUIRED",
          "USER_DISABLED_ASK_ADMIN_TO_ENABLE"
        ]
      },
      "RestapiLogoutRequestEnterprise": {
        "type": "object",
        "properties": {
          "session_id": {
            "description": "Session id identifier.",
            "type": "string",
            "minLength": 1
          },
          "post_logout_redirect_uri": {
            "description": "Post logout redirect uri.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiLogoutPostResult200Enterprise": {
        "type": "object",
        "properties": {
          "success": {
            "type": "string",
            "example": "Successfully logged out.",
            "description": "Success."
          },
          "redirect_url": {
            "type": "string",
            "description": "Redirect url."
          }
        },
        "required": [
          "success"
        ]
      },
      "RestapiActivateTokenPostResult200Enterprise": {
        "type": "object",
        "properties": {
          "default_hashing_algorithm": {
            "type": "string",
            "description": "Default hashing algorithm."
          },
          "default_hashing_parameters": {
            "type": "object",
            "additionalProperties": true,
            "description": "Default hashing parameters."
          },
          "user": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Id identifier."
              },
              "authentication": {
                "type": "string",
                "description": "Authentication."
              },
              "email": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "string",
                    "example": ""
                  }
                ],
                "description": "Email address."
              },
              "secret_key": {
                "type": "string",
                "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
              },
              "secret_key_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for secret key."
              },
              "hashing_algorithm": {
                "type": "string",
                "description": "Hashing algorithm."
              },
              "hashing_parameters": {
                "type": "object",
                "additionalProperties": true,
                "description": "Hashing parameters."
              },
              "registration_date": {
                "type": "string",
                "description": "Registration date."
              },
              "server_secret_exists": {
                "type": "boolean",
                "description": "Server secret exists."
              },
              "require_password_change": {
                "type": "boolean",
                "description": "Require password change."
              }
            },
            "required": [
              "id",
              "authentication",
              "email",
              "secret_key",
              "secret_key_nonce",
              "hashing_algorithm",
              "hashing_parameters",
              "registration_date",
              "server_secret_exists",
              "require_password_change"
            ],
            "description": "User."
          }
        },
        "required": [
          "default_hashing_algorithm",
          "default_hashing_parameters",
          "user"
        ]
      },
      "RestapiCreateUnregisterRequestEnterprise": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email"
          },
          "email": {
            "description": "Email address.",
            "type": "string",
            "format": "email"
          }
        },
        "x-psono-validation-errors": [
          "ACCOUNT_DELETION_DISABLED",
          "EITHER_USERNAME_OR_EMAIL_NEED_TO_BE_DEFINED",
          "EITHER_USERNAME_OR_EMAIL_NEED_TO_BE_DEFINED_NOT_BOTH",
          "UNREGISTRATION_HAS_BEEN_DISABLED",
          "USER_HAS_NO_EMAIL_ADDRESS_ASSOCIATED",
          "USER_WITH_EMAIL_DOESNT_EXIST",
          "USER_WITH_USERNAME_DOESNT_EXIST"
        ]
      },
      "RestapiUpdateUnregisterRequestEnterprise": {
        "type": "object",
        "properties": {
          "unregister_code": {
            "description": "Unregister code.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "unregister_code"
        ],
        "x-psono-validation-errors": [
          "ACCOUNT_DELETION_DISABLED",
          "UNREGISTRATION_CODE_INCORRECT"
        ]
      },
      "RestapiDeleteGARequestEnterprise": {
        "type": "object",
        "properties": {
          "google_authenticator_id": {
            "description": "Google authenticator id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "google_authenticator_id"
        ],
        "x-psono-validation-errors": [
          "ADD_OTHER_SECOND_FACTOR_BEFORE_DELETING",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiDeleteDuoRequestEnterprise": {
        "type": "object",
        "properties": {
          "duo_id": {
            "description": "Duo id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "duo_id"
        ],
        "x-psono-validation-errors": [
          "ADD_OTHER_SECOND_FACTOR_BEFORE_DELETING",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiDeleteYubikeyRequestEnterprise": {
        "type": "object",
        "properties": {
          "yubikey_otp_id": {
            "description": "Yubikey otp id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "yubikey_otp_id"
        ],
        "x-psono-validation-errors": [
          "ADD_OTHER_SECOND_FACTOR_BEFORE_DELETING",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUserPolicyGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "policies": {
            "type": "object",
            "additionalProperties": true,
            "description": "Policies."
          }
        },
        "required": [
          "policies"
        ]
      },
      "RestapiUserDeleteRequestEnterprise": {
        "type": "object",
        "properties": {
          "authkey": {
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key.",
            "type": "string",
            "minLength": 1
          },
          "password": {
            "description": "Password value for the operation; password and authkey are different credentials.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "authkey"
        ],
        "x-psono-validation-errors": [
          "ACCOUNT_DELETION_DISABLED",
          "PASSWORD_INCORRECT"
        ]
      },
      "RestapiStatusGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "unaccepted_shares_count": {
            "type": "integer",
            "description": "Unaccepted shares count."
          },
          "unaccepted_groups_count": {
            "type": "integer",
            "description": "Unaccepted groups count."
          },
          "unaccepted_forced_groups_count": {
            "type": "integer",
            "description": "Unaccepted forced groups count."
          },
          "last_security_report_created": {
            "type": "string",
            "description": "Last security report created."
          }
        },
        "required": [
          "unaccepted_shares_count",
          "unaccepted_groups_count",
          "unaccepted_forced_groups_count",
          "last_security_report_created"
        ]
      },
      "RestapiEnableNewPasswordRequestEnterprise": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "recovery_authkey": {
            "description": "Recovery authkey.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "username",
          "recovery_authkey"
        ],
        "x-psono-validation-errors": [
          "PASSWORD_RESET_HAS_BEEN_DISABLED",
          "RECOVERY_CODES_DISABLED",
          "USERNAME_OR_RECOVERY_CODE_INCORRECT"
        ]
      },
      "RestapiPasswordPostResult200Enterprise": {
        "type": "object",
        "properties": {
          "recovery_data": {
            "type": "string",
            "description": "Recovery data."
          },
          "recovery_data_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for recovery data."
          },
          "recovery_sauce": {
            "type": "string",
            "description": "Recovery sauce."
          },
          "user_sauce": {
            "type": "string",
            "description": "User sauce."
          },
          "policies": {
            "type": "object",
            "additionalProperties": true,
            "description": "Policies."
          },
          "hashing_algorithm": {
            "type": "string",
            "description": "Hashing algorithm."
          },
          "hashing_parameters": {
            "type": "object",
            "additionalProperties": true,
            "description": "Hashing parameters."
          },
          "verifier_public_key": {
            "type": "string",
            "description": "Verifier public key."
          },
          "verifier_time_valid": {
            "type": "integer",
            "description": "Verifier time valid."
          }
        },
        "required": [
          "recovery_data",
          "recovery_data_nonce",
          "recovery_sauce",
          "user_sauce",
          "policies",
          "hashing_algorithm",
          "hashing_parameters",
          "verifier_public_key",
          "verifier_time_valid"
        ]
      },
      "RestapiSetNewPasswordRequestEnterprise": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "recovery_authkey": {
            "description": "Recovery authkey.",
            "type": "string",
            "minLength": 1
          },
          "update_data": {
            "description": "Update data.",
            "type": "string",
            "minLength": 1
          },
          "update_data_nonce": {
            "description": "Hex-encoded nonce for update data.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "hashing_algorithm": {
            "description": "Hashing algorithm.",
            "type": "string"
          },
          "hashing_parameters": {
            "description": "Hashing parameters.",
            "type": "object",
            "additionalProperties": true
          }
        },
        "required": [
          "username",
          "recovery_authkey",
          "update_data",
          "update_data_nonce"
        ],
        "x-psono-validation-errors": [
          "INVALID_HASHING_PARAMETER",
          "NO_VALID_HEX",
          "RECOVERY_CODES_DISABLED",
          "USERNAME_OR_RECOVERY_CODE_INCORRECT",
          "VALIDATOR_EXPIRED"
        ]
      },
      "RestapiCreateRecoverycodeRequestEnterprise": {
        "type": "object",
        "properties": {
          "recovery_authkey": {
            "description": "Recovery authkey.",
            "type": "string",
            "minLength": 1
          },
          "recovery_data": {
            "description": "Recovery data.",
            "type": "string",
            "minLength": 1
          },
          "recovery_data_nonce": {
            "description": "Hex-encoded nonce for recovery data.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "recovery_sauce": {
            "description": "Recovery sauce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "recovery_authkey",
          "recovery_data",
          "recovery_data_nonce",
          "recovery_sauce"
        ],
        "x-psono-validation-errors": [
          "NO_VALID_HEX",
          "RECOVERY_CODES_DISABLED"
        ]
      },
      "RestapiCreateEmergencycodeRequestEnterprise": {
        "type": "object",
        "properties": {
          "description": {
            "description": "Human-readable description.",
            "type": "string",
            "minLength": 1
          },
          "activation_delay": {
            "description": "Activation delay.",
            "type": "integer",
            "minimum": 0,
            "maximum": 2147483647
          },
          "emergency_authkey": {
            "description": "Emergency authkey.",
            "type": "string",
            "minLength": 1
          },
          "emergency_data": {
            "description": "Emergency data.",
            "type": "string",
            "minLength": 1
          },
          "emergency_data_nonce": {
            "description": "Hex-encoded nonce for emergency data.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "emergency_sauce": {
            "description": "Emergency sauce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "description",
          "activation_delay",
          "emergency_authkey",
          "emergency_data",
          "emergency_data_nonce",
          "emergency_sauce"
        ],
        "x-psono-validation-errors": [
          "ACTIVATION_DELAY_NEEDS_TO_BE_A_POSITIVE_INTEGER",
          "EMERGENCY_CODES_DISABLED",
          "NO_VALID_HEX"
        ]
      },
      "RestapiEmergencyLoginPostResult200Enterprise": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "remaining_wait_time": {
                "type": "integer",
                "example": 0,
                "description": "Remaining wait time."
              },
              "status": {
                "type": "string",
                "example": "ready",
                "description": "Status."
              },
              "emergency_data": {
                "type": "string",
                "description": "Emergency data."
              },
              "emergency_data_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for emergency data."
              },
              "emergency_sauce": {
                "type": "string",
                "description": "Emergency sauce."
              },
              "user_sauce": {
                "type": "string",
                "description": "User sauce."
              },
              "policies": {
                "type": "object",
                "additionalProperties": true,
                "description": "Policies."
              },
              "authentication": {
                "type": "string",
                "description": "Authentication."
              },
              "hashing_algorithm": {
                "type": "string",
                "description": "Hashing algorithm."
              },
              "hashing_parameters": {
                "type": "object",
                "additionalProperties": true,
                "description": "Hashing parameters."
              },
              "verifier_public_key": {
                "type": "string",
                "description": "Verifier public key."
              },
              "verifier_time_valid": {
                "type": "integer",
                "description": "Verifier time valid."
              }
            },
            "required": [
              "remaining_wait_time",
              "status",
              "emergency_data",
              "emergency_data_nonce",
              "emergency_sauce",
              "user_sauce",
              "policies",
              "authentication",
              "hashing_algorithm",
              "hashing_parameters",
              "verifier_public_key",
              "verifier_time_valid"
            ]
          },
          {
            "type": "object",
            "properties": {
              "remaining_wait_time": {
                "type": "integer",
                "description": "Remaining wait time."
              },
              "status": {
                "type": "string",
                "example": "waiting",
                "description": "Status."
              }
            },
            "required": [
              "remaining_wait_time",
              "status"
            ]
          },
          {
            "type": "object",
            "properties": {
              "remaining_wait_time": {
                "type": "integer",
                "description": "Remaining wait time."
              },
              "status": {
                "type": "string",
                "example": "started",
                "description": "Status."
              }
            },
            "required": [
              "remaining_wait_time",
              "status"
            ]
          }
        ]
      },
      "RestapiReadAPIKeyInspectRequestEnterprise": {
        "type": "object",
        "properties": {
          "api_key_id": {
            "description": "Api key id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "api_key_id"
        ],
        "x-psono-validation-errors": [
          "API_KEYS_DISABLED",
          "IP_ADDRESS_NOT_ALLOWED",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUpdateSecretWithAPIKeyRequestEnterprise": {
        "type": "object",
        "properties": {
          "api_key_id": {
            "description": "Api key id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "secret_id": {
            "description": "Secret id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "api_key_secret_key": {
            "description": "API-key symmetric secret in hex. Supplying it requests server-side decryption and requires allow_insecure_access.",
            "type": "string",
            "minLength": 1
          },
          "data": {
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope.",
            "type": "string",
            "minLength": 1
          },
          "data_nonce": {
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "old_write_date": {
            "description": "Expected previous write timestamp for optimistic concurrency control.",
            "type": "string",
            "format": "date-time"
          },
          "callback_url": {
            "description": "Callback URL; an empty value disables the callback.",
            "type": "string",
            "maxLength": 2048
          },
          "callback_user": {
            "description": "Optional callback HTTP authentication username.",
            "type": "string",
            "maxLength": 128
          },
          "callback_pass": {
            "description": "Optional callback HTTP authentication password.",
            "type": "string",
            "maxLength": 128
          },
          "insecure_data": {
            "description": "Insecure data.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "api_key_id",
          "secret_id"
        ],
        "x-psono-validation-errors": [
          "API_KEYS_DISABLED",
          "API_KEY_SECRET_KEY_INVALID",
          "API_KEY_SECRET_KEY_SPECIFIED_YET_INSECURE_DATA_NO_JSON",
          "INSECURE_ACCESS_NOT_ALLOWED",
          "IP_ADDRESS_NOT_ALLOWED",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiAddSecretToAPIKeyRequestEnterprise": {
        "type": "object",
        "properties": {
          "api_key_id": {
            "description": "Api key id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "secret_id": {
            "description": "Secret id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1
          },
          "title_nonce": {
            "description": "Hex-encoded nonce for title.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "api_key_id",
          "secret_id",
          "secret_key",
          "secret_key_nonce",
          "title",
          "title_nonce"
        ],
        "x-psono-validation-errors": [
          "API_KEYS_DISABLED",
          "API_KEY_SECRET_ALREADY_EXIST",
          "NO_PERMISSION_OR_NOT_EXIST",
          "NO_VALID_HEX"
        ]
      },
      "RestapiAPIKeyLoginRequestEnterprise": {
        "type": "object",
        "properties": {
          "info": {
            "description": "JSON-encoded string. Preserve its exact bytes when signing or verifying it.",
            "type": "string",
            "minLength": 1
          },
          "signature": {
            "description": "Hex-encoded detached signature over the exact serialized signed payload.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "info",
          "signature"
        ],
        "x-psono-validation-errors": [
          "API_KEYS_DISABLED",
          "API_KEY_RESTRICTED_TO_SECRETS",
          "IP_ADDRESS_NOT_ALLOWED",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiUpdateAPIKeyRequestEnterprise": {
        "type": "object",
        "properties": {
          "api_key_id": {
            "description": "Api key id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "restrict_to_secrets": {
            "description": "Restrict to secrets.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "allow_insecure_access": {
            "description": "Allow insecure access.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "allow_api_key_management": {
            "description": "Allow api key management.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "allow_admin_access": {
            "description": "Allow admin access.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "allow_recovery_access": {
            "description": "Allow recovery access.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "allow_emergency_access": {
            "description": "Allow emergency access.",
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "api_key_id"
        ],
        "x-psono-validation-errors": [
          "API_KEYS_DISABLED",
          "NOTHING_TO_UPDATE",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiCreateAPIKeyRequestEnterprise": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean",
            "default": true
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean",
            "default": false
          },
          "restrict_to_secrets": {
            "description": "Restrict to secrets.",
            "type": "boolean",
            "default": false
          },
          "allow_insecure_access": {
            "description": "Allow insecure access.",
            "type": "boolean",
            "default": false
          },
          "allow_api_key_management": {
            "description": "Allow api key management.",
            "type": "boolean",
            "default": false
          },
          "allow_admin_access": {
            "description": "Allow admin access.",
            "type": "boolean",
            "default": false
          },
          "allow_recovery_access": {
            "description": "Allow recovery access.",
            "type": "boolean",
            "default": false
          },
          "allow_emergency_access": {
            "description": "Allow emergency access.",
            "type": "boolean",
            "default": false
          },
          "public_key": {
            "description": "Hex-encoded public key.",
            "type": "string",
            "minLength": 1
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "user_private_key": {
            "description": "User private key.",
            "type": "string",
            "minLength": 1
          },
          "user_private_key_nonce": {
            "description": "Hex-encoded nonce for user private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "user_secret_key": {
            "description": "User secret key.",
            "type": "string",
            "minLength": 1
          },
          "user_secret_key_nonce": {
            "description": "Hex-encoded nonce for user secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "verify_key": {
            "description": "Verify key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "title",
          "public_key",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce",
          "user_private_key",
          "user_private_key_nonce",
          "user_secret_key",
          "user_secret_key_nonce",
          "verify_key"
        ],
        "x-psono-validation-errors": [
          "API_KEYS_DISABLED",
          "NO_VALID_HEX"
        ]
      },
      "RestapiReadLinkShareAccessRequestEnterprise": {
        "type": "object",
        "properties": {
          "link_share_id": {
            "description": "Link share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "passphrase": {
            "description": "Passphrase.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "link_share_id"
        ],
        "x-psono-validation-errors": [
          "EITHER_SECRET_OR_FILE_REQUIRED",
          "INSUFFICIENT_FUNDS",
          "LINK_SHARES_HAVE_BEEN_DISABLED",
          "NO_FILESERVER_AVAILABLE",
          "NO_PERMISSION_OR_NOT_EXIST",
          "PASSPHRASE_REQUIRED"
        ]
      },
      "RestapiUpdateLinkShareRequestEnterprise": {
        "type": "object",
        "properties": {
          "link_share_id": {
            "description": "Link share id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "public_title": {
            "description": "Public title.",
            "type": "string",
            "minLength": 1
          },
          "allowed_reads": {
            "description": "Allowed reads.",
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0
          },
          "passphrase": {
            "description": "Passphrase.",
            "type": [
              "string",
              "null"
            ]
          },
          "valid_till": {
            "description": "Expiration time in ISO 8601 format.",
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "allow_write": {
            "description": "Allow write.",
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "link_share_id",
          "public_title"
        ],
        "x-psono-validation-errors": [
          "LINK_SHARES_HAVE_BEEN_DISABLED",
          "NO_PERMISSION_OR_NOT_EXIST",
          "VALID_TILL_CANNOT_BE_IN_THE_PAST"
        ]
      },
      "RestapiCreateLinkShareRequestEnterprise": {
        "type": "object",
        "properties": {
          "secret_id": {
            "description": "Secret id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "file_id": {
            "description": "File id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "node": {
            "description": "Node.",
            "type": "string",
            "minLength": 1
          },
          "node_nonce": {
            "description": "Hex-encoded nonce for node.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "public_title": {
            "description": "Public title.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "allowed_reads": {
            "description": "Allowed reads.",
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0
          },
          "passphrase": {
            "description": "Passphrase.",
            "type": [
              "string",
              "null"
            ]
          },
          "valid_till": {
            "description": "Expiration time in ISO 8601 format.",
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "allow_write": {
            "description": "Allow write.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "node",
          "node_nonce",
          "public_title"
        ],
        "x-psono-validation-errors": [
          "EITHER_SECRET_OR_FILE_REQUIRED",
          "EITHER_SECRET_OR_FILE_REQUIRED_NOT_BOTH",
          "LINK_SHARES_HAVE_BEEN_DISABLED",
          "NO_PERMISSION_OR_NOT_EXIST",
          "VALID_TILL_CANNOT_BE_IN_THE_PAST"
        ]
      },
      "RestapiDeleteDatastoreRequestEnterprise": {
        "type": "object",
        "properties": {
          "datastore_id": {
            "description": "Datastore id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "authkey": {
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key.",
            "type": "string"
          }
        },
        "required": [
          "datastore_id",
          "authkey"
        ],
        "x-psono-validation-errors": [
          "CANNOT_DELETE_DEFAULT_DATASTORE",
          "DATASTORE_DOES_NOT_EXIST",
          "PASSWORD_INCORRECT"
        ]
      },
      "RestapiCreateDatastoreRequestEnterprise": {
        "type": "object",
        "properties": {
          "type": {
            "description": "Type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "description": {
            "description": "Human-readable description.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "data": {
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope.",
            "type": "string"
          },
          "data_nonce": {
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce.",
            "type": "string",
            "maxLength": 64
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "is_default": {
            "description": "Is default.",
            "type": "boolean",
            "default": true
          }
        },
        "required": [
          "type",
          "description",
          "secret_key",
          "secret_key_nonce"
        ],
        "x-psono-validation-errors": [
          "MULTIPLE_PASSWORD_DATASTORES_DISABLED"
        ]
      },
      "RestapiUpdateFileRepositoryRightRequestEnterprise": {
        "type": "object",
        "properties": {
          "file_repository_right_id": {
            "description": "File repository right id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean",
            "default": true
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean",
            "default": true
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "file_repository_right_id"
        ],
        "x-psono-validation-errors": [
          "FILE_REPOSITORIES_HAVE_BEEN_DISABLED",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiCreateFileRepositoryRightRequestEnterprise": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "file_repository_id": {
            "description": "File repository id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean",
            "default": true
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean",
            "default": true
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "user_id",
          "file_repository_id"
        ],
        "x-psono-validation-errors": [
          "FILE_REPOSITORIES_HAVE_BEEN_DISABLED",
          "NO_PERMISSION_OR_NOT_EXIST",
          "USER_DOES_NOT_EXIST",
          "USER_HAS_ALREADY_RIGHTS_FOR_FILE_REPOSITORY"
        ]
      },
      "RestapiFileRepositoryDownloadRequestEnterprise": {
        "type": "object",
        "properties": {
          "hash_checksum": {
            "description": "Hash checksum.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "hash_checksum"
        ],
        "x-psono-validation-errors": [
          "CHUNK_COUNT_EXCEEDED",
          "CHUNK_SIZE_EXCEEDED",
          "FILE_REPOSITORIES_HAVE_BEEN_DISABLED",
          "FILE_TRANSFER_TYPE_INVALID",
          "HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiFileRepositoryUploadRequestEnterprise": {
        "type": "object",
        "properties": {
          "chunk_size": {
            "description": "Chunk size.",
            "type": "integer",
            "minimum": 0
          },
          "chunk_position": {
            "description": "Chunk position.",
            "type": "integer",
            "minimum": 0,
            "maximum": 2147483647
          },
          "hash_checksum": {
            "description": "Hash checksum.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "chunk_size",
          "chunk_position",
          "hash_checksum"
        ],
        "x-psono-validation-errors": [
          "CHUNK_COUNT_EXCEEDED",
          "CHUNK_SIZE_EXCEEDED",
          "FILE_REPOSITORIES_HAVE_BEEN_DISABLED",
          "FILE_TRANSFER_TYPE_INVALID",
          "HASH_CHECKSUM_NOT_IN_HEX_REPRESENTATION"
        ]
      },
      "RestapiUpdateFileRepositoryRequestEnterprise": {
        "type": "object",
        "properties": {
          "file_repository_id": {
            "description": "File repository id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "type": {
            "description": "Type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          },
          "gcp_cloud_storage_bucket": {
            "description": "Gcp cloud storage bucket.",
            "type": "string",
            "minLength": 1
          },
          "gcp_cloud_storage_json_key": {
            "description": "Gcp cloud storage json key.",
            "type": "string",
            "minLength": 1
          },
          "active": {
            "description": "Whether the resource or account is active.",
            "type": "boolean"
          },
          "aws_s3_bucket": {
            "description": "Aws s3 bucket.",
            "type": "string",
            "minLength": 1
          },
          "aws_s3_region": {
            "description": "Aws s3 region.",
            "type": "string",
            "minLength": 1
          },
          "aws_s3_access_key_id": {
            "description": "Aws s3 access key id identifier.",
            "type": "string",
            "minLength": 1
          },
          "aws_s3_secret_access_key": {
            "description": "Aws s3 secret access key.",
            "type": "string",
            "minLength": 1
          },
          "azure_blob_storage_account_name": {
            "description": "Azure blob storage account name.",
            "type": "string",
            "minLength": 1
          },
          "azure_blob_storage_account_primary_key": {
            "description": "Azure blob storage account primary key.",
            "type": "string",
            "minLength": 1
          },
          "azure_blob_storage_account_container_name": {
            "description": "Azure blob storage account container name.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_bucket": {
            "description": "Other s3 bucket.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_region": {
            "description": "Other s3 region.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_access_key_id": {
            "description": "Other s3 access key id identifier.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_secret_access_key": {
            "description": "Other s3 secret access key.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_endpoint_url": {
            "description": "Other s3 endpoint url.",
            "type": "string",
            "minLength": 1
          },
          "backblaze_bucket": {
            "description": "Backblaze bucket.",
            "type": "string",
            "minLength": 1
          },
          "backblaze_region": {
            "description": "Backblaze region.",
            "type": "string",
            "minLength": 1
          },
          "backblaze_access_key_id": {
            "description": "Backblaze access key id identifier.",
            "type": "string",
            "minLength": 1
          },
          "backblaze_secret_access_key": {
            "description": "Backblaze secret access key.",
            "type": "string",
            "minLength": 1
          },
          "do_space": {
            "description": "Do space.",
            "type": "string",
            "minLength": 1
          },
          "do_region": {
            "description": "Do region.",
            "type": "string",
            "minLength": 1
          },
          "do_key": {
            "description": "Do key.",
            "type": "string",
            "minLength": 1
          },
          "do_secret": {
            "description": "Do secret.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "file_repository_id",
          "title",
          "type",
          "active"
        ],
        "x-psono-validation-errors": [
          "ACCESS_KEY_ID_IS_REQUIRED",
          "ACCOUNT_NAME_IS_REQUIRED",
          "BUCKET_IS_REQUIRED",
          "CONTAINER_NAME_IS_REQUIRED",
          "ENDPOINT_URL_NOT_ALLOWED",
          "FILEREPOSITORY_TYPE_NOT_ALLOWED",
          "FILE_REPOSITORIES_HAVE_BEEN_DISABLED",
          "JSON_KEY_IS_INVALID",
          "JSON_KEY_IS_REQUIRED",
          "KEY_IS_REQUIRED",
          "NO_PERMISSION_OR_NOT_EXIST",
          "PRIMARY_KEY_IS_REQUIRED",
          "REGION_IS_REQUIRED",
          "SECRET_ACCESS_KEY_IS_REQUIRED",
          "SECRET_IS_REQUIRED",
          "SPACE_IS_REQUIRED",
          "UNKNOWN_TYPE",
          "URL_IS_REQUIRED"
        ]
      },
      "RestapiCreateFileRepositoryRequestEnterprise": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "type": {
            "description": "Type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          },
          "gcp_cloud_storage_bucket": {
            "description": "Gcp cloud storage bucket.",
            "type": "string",
            "minLength": 1
          },
          "gcp_cloud_storage_json_key": {
            "description": "Gcp cloud storage json key.",
            "type": "string",
            "minLength": 1
          },
          "aws_s3_bucket": {
            "description": "Aws s3 bucket.",
            "type": "string",
            "minLength": 1
          },
          "aws_s3_region": {
            "description": "Aws s3 region.",
            "type": "string",
            "minLength": 1
          },
          "aws_s3_access_key_id": {
            "description": "Aws s3 access key id identifier.",
            "type": "string",
            "minLength": 1
          },
          "aws_s3_secret_access_key": {
            "description": "Aws s3 secret access key.",
            "type": "string",
            "minLength": 1
          },
          "azure_blob_storage_account_name": {
            "description": "Azure blob storage account name.",
            "type": "string",
            "minLength": 1
          },
          "azure_blob_storage_account_primary_key": {
            "description": "Azure blob storage account primary key.",
            "type": "string",
            "minLength": 1
          },
          "azure_blob_storage_account_container_name": {
            "description": "Azure blob storage account container name.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_bucket": {
            "description": "Other s3 bucket.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_region": {
            "description": "Other s3 region.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_access_key_id": {
            "description": "Other s3 access key id identifier.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_secret_access_key": {
            "description": "Other s3 secret access key.",
            "type": "string",
            "minLength": 1
          },
          "other_s3_endpoint_url": {
            "description": "Other s3 endpoint url.",
            "type": "string",
            "minLength": 1
          },
          "backblaze_bucket": {
            "description": "Backblaze bucket.",
            "type": "string",
            "minLength": 1
          },
          "backblaze_region": {
            "description": "Backblaze region.",
            "type": "string",
            "minLength": 1
          },
          "backblaze_access_key_id": {
            "description": "Backblaze access key id identifier.",
            "type": "string",
            "minLength": 1
          },
          "backblaze_secret_access_key": {
            "description": "Backblaze secret access key.",
            "type": "string",
            "minLength": 1
          },
          "do_space": {
            "description": "Do space.",
            "type": "string",
            "minLength": 1
          },
          "do_region": {
            "description": "Do region.",
            "type": "string",
            "minLength": 1
          },
          "do_key": {
            "description": "Do key.",
            "type": "string",
            "minLength": 1
          },
          "do_secret": {
            "description": "Do secret.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "title",
          "type"
        ],
        "x-psono-validation-errors": [
          "ACCESS_KEY_ID_IS_REQUIRED",
          "ACCOUNT_NAME_IS_REQUIRED",
          "BUCKET_IS_REQUIRED",
          "CONTAINER_NAME_IS_REQUIRED",
          "ENDPOINT_URL_NOT_ALLOWED",
          "FILEREPOSITORY_TYPE_NOT_ALLOWED",
          "FILE_REPOSITORIES_HAVE_BEEN_DISABLED",
          "JSON_KEY_IS_INVALID",
          "JSON_KEY_IS_REQUIRED",
          "KEY_IS_REQUIRED",
          "PRIMARY_KEY_IS_REQUIRED",
          "REGION_IS_REQUIRED",
          "SECRET_ACCESS_KEY_IS_REQUIRED",
          "SECRET_IS_REQUIRED",
          "SPACE_IS_REQUIRED",
          "UNKNOWN_TYPE",
          "URL_IS_REQUIRED"
        ]
      },
      "RestapiDeleteSecretLinkRequestEnterprise": {
        "type": "object",
        "properties": {
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          },
          "log_audit_title": {
            "description": "Log audit title.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "link_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "RestapiCreateShareRequestEnterprise": {
        "type": "object",
        "properties": {
          "link_id": {
            "description": "Client-generated unique link UUID.",
            "type": "string",
            "format": "uuid"
          },
          "data": {
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope.",
            "type": "string",
            "minLength": 1
          },
          "data_nonce": {
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "parent_share_id": {
            "description": "Parent share UUID. Where a parent datastore is also supported, supply exactly one parent.",
            "type": "string",
            "format": "uuid"
          },
          "parent_datastore_id": {
            "description": "Parent datastore UUID. Where a parent share is also supported, supply exactly one parent.",
            "type": "string",
            "format": "uuid"
          },
          "key": {
            "description": "Wrapped encryption key for the recipient, as indicated by key_type.",
            "type": "string",
            "minLength": 1
          },
          "key_nonce": {
            "description": "Hex-encoded nonce for key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "key_type": {
            "description": "Key-wrapping method used for the key value.",
            "type": "string",
            "minLength": 1,
            "default": "asymmetric"
          }
        },
        "required": [
          "link_id",
          "data",
          "data_nonce",
          "key",
          "key_nonce"
        ],
        "x-psono-validation-errors": [
          "EITHER_PARENT_DATASTORE_OR_SHARE_NEED_TO_BE_DEFINED",
          "NO_PERMISSION_OR_NOT_EXIST",
          "SHARING_HAS_BEEN_DISABLED"
        ]
      },
      "RestapiCreateGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "public_key": {
            "description": "Hex-encoded public key.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "secret_key",
          "secret_key_nonce",
          "private_key",
          "private_key_nonce",
          "public_key"
        ],
        "x-psono-validation-errors": [
          "NAME_MAY_NOT_BE_SHORTER_THAN_3_CHARS",
          "NAME_MAY_NOT_CONTAIN_AT",
          "NO_VALID_HEX",
          "UNANAGED_GROUPS_ARE_DISABLED"
        ]
      },
      "RestapiMembershipDeclineRequestEnterprise": {
        "type": "object",
        "properties": {
          "membership_id": {
            "description": "Membership id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "membership_id"
        ],
        "x-psono-validation-errors": [
          "FORCED_MEMBERSHIP_CANNOT_BE_DECLINED",
          "NO_PERMISSION_OR_NOT_EXIST_OR_ALREADY_PROCESSED_MEMBERSHIP"
        ]
      },
      "RestapiDeleteMembershipRequestEnterprise": {
        "type": "object",
        "properties": {
          "membership_id": {
            "description": "Membership id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "membership_id"
        ],
        "x-psono-validation-errors": [
          "FORCED_MEMBERSHIP_CANNOT_BE_DELETED",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationIdentityProviderTenantGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "tenants": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                },
                "is_active": {
                  "type": "boolean",
                  "description": "Is active."
                }
              },
              "required": [
                "id",
                "name",
                "is_active"
              ]
            },
            "description": "Tenants."
          }
        },
        "required": [
          "count",
          "tenants"
        ]
      },
      "AdministrationUpdateIdentityProviderGroupTenantRequestEnterprise": {
        "type": "object",
        "properties": {
          "provider": {
            "description": "Provider.",
            "enum": [
              "ldap",
              "saml",
              "oidc",
              "scim"
            ],
            "type": "string"
          },
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "tenant_ids": {
            "description": "Tenant ids.",
            "type": "array",
            "items": {
              "description": "Tenant ids item.",
              "type": "string",
              "format": "uuid"
            }
          }
        },
        "required": [
          "provider",
          "group_id",
          "tenant_ids"
        ],
        "x-psono-validation-errors": [
          "DUPLICATE_TENANT",
          "NO_PERMISSION_OR_NOT_EXIST",
          "TENANT_NOT_EXIST"
        ]
      },
      "AdministrationUpdateUserRequestEnterprise": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email",
            "minLength": 1,
            "maxLength": 254
          },
          "is_active": {
            "description": "Is active.",
            "type": "boolean"
          },
          "is_email_active": {
            "description": "Is email active.",
            "type": "boolean"
          },
          "is_staff": {
            "description": "Is staff.",
            "type": "boolean"
          },
          "is_superuser": {
            "description": "Is superuser.",
            "type": "boolean"
          },
          "require_password_change": {
            "description": "Require password change.",
            "type": "boolean"
          },
          "email": {
            "description": "Email address.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "language": {
            "description": "Language.",
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 16
          }
        },
        "required": [
          "user_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "USERNAME_CHANGE_REQUIRES_PASSWORD_RESET",
          "USER_KEYS_NOT_AVAILABLE",
          "USER_WITH_EMAIL_ALREADY_EXISTS",
          "USER_WITH_USERNAME_ALREADY_EXISTS"
        ]
      },
      "AdministrationCreateGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1
          },
          "auto_create_folder": {
            "description": "Auto create folder.",
            "type": "boolean",
            "default": false
          },
          "tenant_ids": {
            "description": "Tenant ids.",
            "type": "array",
            "items": {
              "description": "Tenant ids item.",
              "type": "string",
              "format": "uuid"
            }
          }
        },
        "required": [
          "name"
        ],
        "x-psono-validation-errors": [
          "DUPLICATE_TENANT",
          "TENANT_NOT_EXIST",
          "TENANT_REQUIRED"
        ]
      },
      "AdministrationUpdateGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "forced_membership": {
            "description": "Forced membership.",
            "type": "boolean"
          }
        },
        "required": [
          "group_id",
          "name"
        ],
        "x-psono-validation-errors": [
          "NAME_CONTAINS_FORBIDDEN_CHARACTERS",
          "NAME_TOO_SHORT",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateGroupShareRightRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "read": {
            "description": "Whether read access is granted.",
            "type": "boolean"
          },
          "write": {
            "description": "Whether write access is granted.",
            "type": "boolean"
          },
          "grant": {
            "description": "Whether the recipient may grant access to others.",
            "type": "boolean"
          },
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "share_data": {
            "description": "Share data.",
            "type": "string",
            "minLength": 1
          },
          "share_data_nonce": {
            "description": "Hex-encoded nonce for share data.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "group_share_right_key": {
            "description": "Group share right key.",
            "type": "string",
            "minLength": 1
          },
          "group_share_right_key_nonce": {
            "description": "Hex-encoded nonce for group share right key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "group_share_right_title": {
            "description": "Group share right title.",
            "type": "string",
            "minLength": 1
          },
          "group_share_right_title_nonce": {
            "description": "Hex-encoded nonce for group share right title.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "group_share_right_type": {
            "description": "Group share right type.",
            "type": "string",
            "minLength": 1
          },
          "group_share_right_type_nonce": {
            "description": "Hex-encoded nonce for group share right type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "group_id",
          "read",
          "write",
          "grant"
        ],
        "x-psono-validation-errors": [
          "NAME_REQUIRED",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationLDAPUserGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "ldap_users": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "email": {
                  "type": "string",
                  "description": "Email address."
                },
                "display_name": {
                  "type": "string",
                  "description": "Display name."
                },
                "dn": {
                  "type": "string",
                  "description": "Dn."
                },
                "create_date": {
                  "type": "string",
                  "example": "",
                  "description": "Creation time in ISO 8601 format."
                }
              },
              "required": [
                "id",
                "username",
                "email",
                "display_name",
                "dn",
                "create_date"
              ]
            },
            "description": "Ldap users."
          }
        },
        "required": [
          "ldap_users"
        ]
      },
      "AdministrationDeleteLDAPGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "ldap_group_id": {
            "description": "Ldap group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "ldap_group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateLDAPGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "ldap_group_id": {
            "description": "Ldap group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "ldap_group_id"
        ],
        "x-psono-validation-errors": [
          "MAPPING_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationUpdateLDAPGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "ldap_group_map_id": {
            "description": "Ldap group map id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_admin": {
            "description": "Group admin.",
            "type": "boolean"
          },
          "share_admin": {
            "description": "Share admin.",
            "type": "boolean"
          }
        },
        "required": [
          "ldap_group_map_id",
          "group_admin",
          "share_admin"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeleteLDAPGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "ldap_group_id": {
            "description": "Ldap group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "ldap_group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationLDAPGroupGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "ldap_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "dn": {
                  "type": "string",
                  "description": "Dn."
                },
                "domain": {
                  "type": "string",
                  "description": "Domain."
                },
                "groups": {
                  "type": "array",
                  "items": {},
                  "description": "Groups."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "description": "Tenant ids."
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name."
                      },
                      "is_active": {
                        "type": "boolean",
                        "description": "Is active."
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "is_active"
                    ]
                  },
                  "description": "Tenants."
                }
              },
              "required": [
                "id",
                "dn",
                "domain",
                "groups",
                "tenant_ids",
                "tenants"
              ]
            },
            "description": "Ldap groups."
          }
        },
        "required": [
          "ldap_groups"
        ]
      },
      "AdministrationLDAPGroupPostResult200Enterprise": {
        "type": "object",
        "properties": {
          "ldap_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "dn": {
                  "type": "string",
                  "description": "Dn."
                },
                "domain": {
                  "type": "string",
                  "description": "Domain."
                },
                "groups": {
                  "type": "array",
                  "items": {},
                  "description": "Groups."
                }
              },
              "required": [
                "id",
                "dn",
                "domain",
                "groups"
              ]
            },
            "description": "Ldap groups."
          }
        },
        "required": [
          "ldap_groups"
        ]
      },
      "AdministrationDeleteSCIMGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "scim_group_id": {
            "description": "Scim group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "scim_group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateSCIMGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "scim_group_id": {
            "description": "Scim group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "scim_group_id"
        ],
        "x-psono-validation-errors": [
          "MAPPING_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationUpdateSCIMGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "scim_group_map_id": {
            "description": "Scim group map id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_admin": {
            "description": "Group admin.",
            "type": "boolean"
          },
          "share_admin": {
            "description": "Share admin.",
            "type": "boolean"
          }
        },
        "required": [
          "scim_group_map_id",
          "group_admin",
          "share_admin"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeleteSCIMGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "scim_group_id": {
            "description": "Scim group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "scim_group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationSCIMGroupGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "scim_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "scim_provider_id": {
                  "type": "string",
                  "description": "Scim provider id identifier."
                },
                "display_name": {
                  "type": "string",
                  "description": "Display name."
                },
                "groups": {
                  "type": "array",
                  "items": {},
                  "description": "Groups."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "description": "Tenant ids."
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name."
                      },
                      "is_active": {
                        "type": "boolean",
                        "description": "Is active."
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "is_active"
                    ]
                  },
                  "description": "Tenants."
                }
              },
              "required": [
                "id",
                "scim_provider_id",
                "display_name",
                "groups",
                "tenant_ids",
                "tenants"
              ]
            },
            "description": "Scim groups."
          }
        },
        "required": [
          "scim_groups"
        ]
      },
      "AdministrationDeleteSAMLGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "saml_group_id": {
            "description": "Saml group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "saml_group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateSAMLGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "saml_group_id": {
            "description": "Saml group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "saml_group_id"
        ],
        "x-psono-validation-errors": [
          "MAPPING_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationUpdateSAMLGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "saml_group_map_id": {
            "description": "Saml group map id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_admin": {
            "description": "Group admin.",
            "type": "boolean"
          },
          "share_admin": {
            "description": "Share admin.",
            "type": "boolean"
          }
        },
        "required": [
          "saml_group_map_id",
          "group_admin",
          "share_admin"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeleteSAMLGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "saml_group_id": {
            "description": "Saml group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "saml_group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationSAMLGroupGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "saml_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "saml_name": {
                  "type": "string",
                  "description": "Saml name."
                },
                "saml_provider_id": {
                  "type": "string",
                  "description": "Saml provider id identifier."
                },
                "display_name": {
                  "type": "string",
                  "description": "Display name."
                },
                "groups": {
                  "type": "array",
                  "items": {},
                  "description": "Groups."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "description": "Tenant ids."
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name."
                      },
                      "is_active": {
                        "type": "boolean",
                        "description": "Is active."
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "is_active"
                    ]
                  },
                  "description": "Tenants."
                }
              },
              "required": [
                "id",
                "saml_name",
                "saml_provider_id",
                "display_name",
                "groups",
                "tenant_ids",
                "tenants"
              ]
            },
            "description": "Saml groups."
          }
        },
        "required": [
          "saml_groups"
        ]
      },
      "AdministrationDeleteOIDCGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "oidc_group_id": {
            "description": "Oidc group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "oidc_group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateOIDCGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "oidc_group_id": {
            "description": "Oidc group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "oidc_group_id"
        ],
        "x-psono-validation-errors": [
          "MAPPING_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationUpdateOIDCGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "oidc_group_map_id": {
            "description": "Oidc group map id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_admin": {
            "description": "Group admin.",
            "type": "boolean"
          },
          "share_admin": {
            "description": "Share admin.",
            "type": "boolean"
          }
        },
        "required": [
          "oidc_group_map_id",
          "group_admin",
          "share_admin"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeleteOIDCGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "oidc_group_id": {
            "description": "Oidc group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "oidc_group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationOIDCGroupGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "oidc_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "oidc_name": {
                  "type": "string",
                  "description": "Oidc name."
                },
                "oidc_provider_id": {
                  "type": "string",
                  "description": "Oidc provider id identifier."
                },
                "display_name": {
                  "type": "string",
                  "description": "Display name."
                },
                "groups": {
                  "type": "array",
                  "items": {},
                  "description": "Groups."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "description": "Tenant ids."
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name."
                      },
                      "is_active": {
                        "type": "boolean",
                        "description": "Is active."
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "is_active"
                    ]
                  },
                  "description": "Tenants."
                }
              },
              "required": [
                "id",
                "oidc_name",
                "oidc_provider_id",
                "display_name",
                "groups",
                "tenant_ids",
                "tenants"
              ]
            },
            "description": "Oidc groups."
          }
        },
        "required": [
          "oidc_groups"
        ]
      },
      "AdministrationDeletePolicyRequestEnterprise": {
        "type": "object",
        "properties": {
          "policy_id": {
            "description": "Policy id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "policy_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreatePolicyRequestEnterprise": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "priority": {
            "description": "Priority.",
            "type": "number"
          },
          "config": {
            "description": "Config.",
            "$ref": "#/components/schemas/AdministrationPolicyConfigRequestEnterprise"
          }
        },
        "required": [
          "title",
          "priority",
          "config"
        ]
      },
      "AdministrationPolicyConfigRequestEnterprise": {
        "type": "object",
        "properties": {
          "COMPLIANCE_CENTRAL_SECURITY_REPORT_SECURITY_RECURRENCE_INTERVAL": {
            "description": "Compliance central security report security recurrence interval.",
            "type": "integer",
            "minimum": 0
          },
          "COMPLIANCE_DISABLE_API_KEYS": {
            "description": "Compliance disable api keys.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_DELETE_ACCOUNT": {
            "description": "Compliance disable delete account.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_EMERGENCY_CODES": {
            "description": "Compliance disable emergency codes.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_TOTP": {
            "description": "Compliance disable totp.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_EXPORT": {
            "description": "Compliance disable export.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_EXPORT_OF_SHARED_ITEMS": {
            "description": "Compliance disable export of shared items.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_FILE_REPOSITORIES": {
            "description": "Compliance disable file repositories.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_LINK_SHARES": {
            "description": "Compliance disable link shares.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_MULTIPLE_PASSWORD_DATASTORES": {
            "description": "Compliance disable multiple password datastores.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_OFFLINE_MODE": {
            "description": "Compliance disable offline mode.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_SHARES": {
            "description": "Compliance disable shares.",
            "type": "boolean"
          },
          "COMPLIANCE_SERVER_SECRETS": {
            "description": "Compliance server secrets.",
            "enum": [
              "auto",
              "noone",
              "all"
            ],
            "type": "string"
          },
          "COMPLIANCE_MAX_OFFLINE_CACHE_TIME_VALID": {
            "description": "Compliance max offline cache time valid.",
            "type": "integer",
            "minimum": 0
          },
          "COMPLIANCE_DISABLE_RECOVERY_CODES": {
            "description": "Compliance disable recovery codes.",
            "type": "boolean"
          },
          "COMPLIANCE_DISABLE_UNMANAGED_GROUPS": {
            "description": "Compliance disable unmanaged groups.",
            "type": "boolean"
          },
          "COMPLIANCE_ENFORCE_2FA": {
            "description": "Compliance enforce 2fa.",
            "type": "boolean"
          },
          "COMPLIANCE_ENFORCE_LOCKING": {
            "description": "Compliance enforce locking.",
            "type": "boolean"
          },
          "COMPLIANCE_MAX_LOCK_TIMEOUT": {
            "description": "Compliance max lock timeout.",
            "type": "integer",
            "minimum": 0
          },
          "COMPLIANCE_ENFORCE_CENTRAL_SECURITY_REPORTS": {
            "description": "Compliance enforce central security reports.",
            "type": "boolean"
          },
          "COMPLIANCE_ENFORCE_BREACH_DETECTION": {
            "description": "Compliance enforce breach detection.",
            "type": "boolean"
          },
          "COMPLIANCE_CLIPBOARD_CLEAR_DELAY": {
            "description": "Compliance clipboard clear delay.",
            "type": "integer",
            "minimum": 0
          },
          "COMPLIANCE_MIN_CLIPBOARD_CLEAR_DELAY": {
            "description": "Compliance min clipboard clear delay.",
            "type": "integer",
            "minimum": 0
          },
          "COMPLIANCE_MAX_CLIPBOARD_CLEAR_DELAY": {
            "description": "Compliance max clipboard clear delay.",
            "type": "integer",
            "minimum": 0
          },
          "COMPLIANCE_PASSWORD_GENERATOR_DEFAULT_PASSWORD_LENGTH": {
            "description": "Compliance password generator default password length.",
            "type": "integer",
            "minimum": 0
          },
          "COMPLIANCE_PASSWORD_GENERATOR_DEFAULT_WORD_LENGTH": {
            "description": "Compliance password generator default word length.",
            "type": "integer",
            "minimum": 2,
            "maximum": 128
          },
          "COMPLIANCE_PASSWORD_GENERATOR_DEFAULT_LETTERS_UPPERCASE": {
            "description": "Compliance password generator default letters uppercase.",
            "type": "string"
          },
          "COMPLIANCE_PASSWORD_GENERATOR_DEFAULT_LETTERS_LOWERCASE": {
            "description": "Compliance password generator default letters lowercase.",
            "type": "string"
          },
          "COMPLIANCE_PASSWORD_GENERATOR_DEFAULT_NUMBERS": {
            "description": "Compliance password generator default numbers.",
            "type": "string"
          },
          "COMPLIANCE_PASSWORD_GENERATOR_DEFAULT_SPECIAL_CHARS": {
            "description": "Compliance password generator default special chars.",
            "type": "string"
          },
          "COMPLIANCE_IP_RESTRICTIONS": {
            "description": "Compliance ip restrictions.",
            "type": "array",
            "items": {
              "description": "Compliance ip restrictions item.",
              "type": "string",
              "minLength": 1
            }
          },
          "MAX_APP_TOKEN_TIME_VALID": {
            "description": "Max app token time valid.",
            "type": "integer",
            "minimum": 0
          },
          "MAX_WEB_TOKEN_TIME_VALID": {
            "description": "Max web token time valid.",
            "type": "integer",
            "minimum": 0
          },
          "MAX_API_KEY_TOKEN_TIME_VALID": {
            "description": "Max api key token time valid.",
            "type": "integer",
            "minimum": 0
          },
          "MIN_APP_TOKEN_TIME_VALID": {
            "description": "Min app token time valid.",
            "type": "integer",
            "minimum": 0
          },
          "MIN_WEB_TOKEN_TIME_VALID": {
            "description": "Min web token time valid.",
            "type": "integer",
            "minimum": 0
          },
          "MIN_API_KEY_TOKEN_TIME_VALID": {
            "description": "Min api key token time valid.",
            "type": "integer",
            "minimum": 0
          },
          "ALLOWED_FILE_REPOSITORY_TYPES": {
            "description": "Allowed file repository types.",
            "type": "array",
            "items": {
              "description": "Allowed file repository types item.",
              "type": "string",
              "minLength": 1
            }
          },
          "ALLOWED_SECOND_FACTORS": {
            "description": "Allowed second factors.",
            "type": "array",
            "items": {
              "description": "Allowed second factors item.",
              "type": "string",
              "minLength": 1
            }
          },
          "DISABLE_CENTRAL_SECURITY_REPORTS": {
            "description": "Disable central security reports.",
            "type": "boolean"
          },
          "DISABLE_CALLBACKS": {
            "description": "Disable callbacks.",
            "type": "boolean"
          },
          "ALLOW_USER_SEARCH_BY_EMAIL": {
            "description": "Allow user search by email.",
            "type": "boolean"
          },
          "ALLOW_USER_SEARCH_BY_USERNAME_PARTIAL": {
            "description": "Allow user search by username partial.",
            "type": "boolean"
          }
        },
        "x-psono-validation-errors": [
          "UNKNOWN_FILE_REPOSITORY_TYPE"
        ]
      },
      "AdministrationPolicyPostResult201Enterprise": {
        "type": "object",
        "properties": {
          "policy_id": {
            "type": "string",
            "description": "Policy id identifier."
          }
        },
        "required": [
          "policy_id"
        ]
      },
      "AdministrationUpdatePolicyRequestEnterprise": {
        "type": "object",
        "properties": {
          "policy_id": {
            "description": "Policy id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "priority": {
            "description": "Priority.",
            "type": "number"
          },
          "config": {
            "description": "Config.",
            "$ref": "#/components/schemas/AdministrationPolicyConfigRequestEnterprise"
          }
        },
        "required": [
          "policy_id",
          "title",
          "priority",
          "config"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeletePolicyUserMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "policy_id": {
            "description": "Policy id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "user_id",
          "policy_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreatePolicyUserMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "policy_id": {
            "description": "Policy id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "user_id",
          "policy_id"
        ],
        "x-psono-validation-errors": [
          "MAPPING_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeletePolicyGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "policy_id": {
            "description": "Policy id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "policy_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreatePolicyGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "policy_id": {
            "description": "Policy id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "group_id",
          "policy_id"
        ],
        "x-psono-validation-errors": [
          "MAPPING_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationWipeUserRequestEnterprise": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "password": {
            "description": "Password value for the operation; password and authkey are different credentials.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "user_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationUserWipePostResult200Enterprise": {
        "type": "object",
        "properties": {
          "password": {
            "type": "string",
            "description": "Password value for the operation; password and authkey are different credentials."
          }
        },
        "required": [
          "password"
        ]
      },
      "AdministrationUserPasswordResetGetResult200Enterprise": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "description": "Account username, normally including the configured domain."
          },
          "public_key": {
            "type": "string",
            "description": "Hex-encoded public key."
          },
          "private_key": {
            "type": "string",
            "description": "Encrypted private key; never send an unencrypted vault private key here."
          },
          "private_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for private key."
          },
          "secret_key": {
            "type": "string",
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
          },
          "secret_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for secret key."
          },
          "hashing_algorithm": {
            "type": "string",
            "example": "scrypt",
            "description": "Hashing algorithm."
          },
          "hashing_parameters": {
            "type": "object",
            "additionalProperties": true,
            "description": "Hashing parameters."
          }
        },
        "required": [
          "username",
          "public_key",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce",
          "hashing_algorithm",
          "hashing_parameters"
        ]
      },
      "AdministrationUserPasswordResetRequestEnterprise": {
        "type": "object",
        "properties": {
          "username": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "format": "email",
            "minLength": 1,
            "maxLength": 254
          },
          "authkey": {
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key.",
            "type": "string",
            "minLength": 128,
            "pattern": "^[0-9a-fA-F]{128}\\Z",
            "maxLength": 128
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 160,
            "pattern": "^[0-9a-fA-F]{160}\\Z",
            "maxLength": 160
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 48,
            "pattern": "^[0-9a-fA-F]{48}\\Z",
            "maxLength": 48
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 160,
            "pattern": "^[0-9a-fA-F]{160}\\Z",
            "maxLength": 160
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 48,
            "pattern": "^[0-9a-fA-F]{48}\\Z",
            "maxLength": 48
          },
          "user_sauce": {
            "description": "User sauce.",
            "type": "string",
            "minLength": 64,
            "pattern": "^[0-9a-fA-F]{64}\\Z",
            "maxLength": 64
          },
          "require_password_change": {
            "description": "Require password change.",
            "type": "boolean",
            "default": true
          },
          "hashing_algorithm": {
            "description": "Hashing algorithm.",
            "enum": [
              "scrypt"
            ],
            "type": "string"
          },
          "hashing_parameters": {
            "description": "Hashing parameters.",
            "type": "object",
            "additionalProperties": true
          }
        },
        "required": [
          "authkey",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce",
          "user_sauce"
        ],
        "x-psono-validation-errors": [
          "ADMIN_PERMISSION_DENIED",
          "ADMIN_RECOVERY_DOES_NOT_EXIST",
          "INVALID_HASHING_PARAMETER",
          "NO_PERMISSION_OR_NOT_EXIST",
          "PASSWORD_RESET_NOT_AVAILABLE",
          "USER_WITH_USERNAME_ALREADY_EXISTS"
        ]
      },
      "AdministrationDeleteGatewayClusterUserMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "cluster_id",
          "user_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateGatewayClusterUserMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "cluster_id",
          "user_id"
        ],
        "x-psono-validation-errors": [
          "MAPPING_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationDeleteGatewayClusterGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "cluster_id",
          "group_id"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateGatewayClusterGroupMapRequestEnterprise": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "cluster_id",
          "group_id"
        ],
        "x-psono-validation-errors": [
          "MAPPING_ALREADY_EXISTS",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "AdministrationCreateGatewayClusterRequestEnterprise": {
        "type": "object",
        "properties": {
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "allow_all": {
            "description": "Allow all.",
            "type": "boolean",
            "default": true
          }
        },
        "required": [
          "title"
        ]
      },
      "AdministrationUpdateGatewayClusterRequestEnterprise": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "title": {
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "allow_all": {
            "description": "Allow all.",
            "type": "boolean"
          }
        },
        "required": [
          "cluster_id",
          "title",
          "allow_all"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "EnterpriseDeleteServerSecretRequestEnterprise": {
        "type": "object",
        "properties": {
          "authkey": {
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key.",
            "type": "string",
            "minLength": 1
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "user_sauce": {
            "description": "User sauce.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "hashing_algorithm": {
            "description": "Hashing algorithm.",
            "type": "string"
          },
          "hashing_parameters": {
            "description": "Hashing parameters.",
            "type": "object",
            "additionalProperties": true
          }
        },
        "required": [
          "authkey",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce",
          "user_sauce"
        ],
        "x-psono-validation-errors": [
          "CANNOT_REUSE_OLD_PASSWORD",
          "INVALID_HASHING_PARAMETER",
          "NO_VALID_HEX",
          "OPERATION_NOT_ALLOWED",
          "SERVER_SECRET_DOES_NOT_EXIST"
        ]
      },
      "EnterpriseCreateServerSecretRequestEnterprise": {
        "type": "object",
        "properties": {
          "private_key": {
            "description": "User private key in hex for Enterprise server-held key provisioning. Protected by the session transport envelope.",
            "type": "string",
            "minLength": 64,
            "maxLength": 64
          },
          "secret_key": {
            "description": "User symmetric secret key in hex for Enterprise server-held key provisioning. Protected by the session transport envelope.",
            "type": "string",
            "minLength": 64,
            "maxLength": 64
          }
        },
        "required": [
          "private_key",
          "secret_key"
        ],
        "x-psono-validation-errors": [
          "INCORRECT_SECRET_KEY",
          "NO_VALID_HEX",
          "OPERATION_NOT_ALLOWED",
          "SERVER_SECRET_ALREADY_EXISTS"
        ]
      },
      "EnterpriseCreateJobStaffMissingGroupSecretRequestEnterprise": {
        "type": "object",
        "properties": {
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "user_id",
          "group_id",
          "secret_key",
          "secret_key_nonce",
          "private_key",
          "private_key_nonce"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "PRIVATE_KEY_NO_VALID_HEX",
          "SECRET_KEY_NO_VALID_HEX",
          "USER_DOES_NOT_EXIST"
        ]
      },
      "EnterpriseCreateJobMembershipMissingGroupSecretRequestEnterprise": {
        "type": "object",
        "properties": {
          "membership_id": {
            "description": "Membership id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 1
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 1
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "required": [
          "membership_id",
          "secret_key",
          "secret_key_nonce",
          "private_key",
          "private_key_nonce"
        ],
        "x-psono-validation-errors": [
          "NO_PERMISSION_OR_NOT_EXIST",
          "PRIVATE_KEY_NO_VALID_HEX",
          "SECRET_KEY_NO_VALID_HEX"
        ]
      },
      "EnterpriseCreateJobUserMissingAdminSecretRequestEnterprise": {
        "type": "object",
        "properties": {
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 160,
            "pattern": "^[0-9a-fA-F]{160}\\Z",
            "maxLength": 160
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 48,
            "pattern": "^[0-9a-fA-F]{48}\\Z",
            "maxLength": 48
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 160,
            "pattern": "^[0-9a-fA-F]{160}\\Z",
            "maxLength": 160
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 48,
            "pattern": "^[0-9a-fA-F]{48}\\Z",
            "maxLength": 48
          }
        },
        "required": [
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce"
        ],
        "x-psono-validation-errors": [
          "ADMIN_RECOVERY_PUBLIC_KEY_INVALID"
        ]
      },
      "EnterpriseCreateJobGroupMissingAdminSecretRequestEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "description": "Group id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "private_key": {
            "description": "Encrypted private key; never send an unencrypted vault private key here.",
            "type": "string",
            "minLength": 160,
            "pattern": "^[0-9a-fA-F]{160}\\Z",
            "maxLength": 160
          },
          "private_key_nonce": {
            "description": "Hex-encoded nonce for private key.",
            "type": "string",
            "minLength": 48,
            "pattern": "^[0-9a-fA-F]{48}\\Z",
            "maxLength": 48
          },
          "secret_key": {
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation.",
            "type": "string",
            "minLength": 160,
            "pattern": "^[0-9a-fA-F]{160}\\Z",
            "maxLength": 160
          },
          "secret_key_nonce": {
            "description": "Hex-encoded nonce for secret key.",
            "type": "string",
            "minLength": 48,
            "pattern": "^[0-9a-fA-F]{48}\\Z",
            "maxLength": 48
          }
        },
        "required": [
          "group_id",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce"
        ],
        "x-psono-validation-errors": [
          "ADMIN_RECOVERY_PUBLIC_KEY_INVALID",
          "NO_PERMISSION_OR_NOT_EXIST"
        ]
      },
      "EnterpriseSamlLoginRequestEnterprise": {
        "type": "object",
        "properties": {
          "public_key": {
            "description": "Hex-encoded public key.",
            "type": "string",
            "minLength": 64,
            "maxLength": 64
          },
          "login_info": {
            "description": "Hex-encoded ciphertext for the operation-specific login exchange.",
            "type": "string",
            "minLength": 1
          },
          "login_info_nonce": {
            "description": "Hex-encoded nonce for login info.",
            "type": "string",
            "minLength": 1
          },
          "session_duration": {
            "description": "Requested session lifetime in seconds, bounded by server/client-type configuration.",
            "type": "integer"
          }
        },
        "required": [
          "public_key",
          "login_info",
          "login_info_nonce"
        ],
        "x-psono-validation-errors": [
          "IP_ADDRESS_NOT_ALLOWED",
          "LOGIN_INFO_CANNOT_BE_DECRYPTED",
          "NO_SAML_TOKEN_ID_PROVIDED",
          "SAML_TOKEN_NOT_FOUND_ALREADY_USED_OR_EXPIRED",
          "USER_NOT_PART_OF_REQUIRED_GROUP"
        ]
      },
      "EnterpriseSamlLoginPostResult200Enterprise": {
        "type": "object",
        "properties": {
          "login_info_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for login info."
          },
          "login_info": {
            "type": "string",
            "description": "Hex-encoded ciphertext for the operation-specific login exchange."
          }
        },
        "required": [
          "login_info_nonce",
          "login_info"
        ]
      },
      "EnterpriseSamlMetadataGetResult200Enterprise": {
        "type": "string",
        "description": "SAML service-provider metadata XML."
      },
      "EnterpriseSamlInitiateLoginRequestEnterprise": {
        "type": "object",
        "properties": {
          "return_to_url": {
            "description": "Client return URL; must be allowed by the identity-provider configuration.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "return_to_url"
        ],
        "x-psono-validation-errors": [
          "SAML_CONFIGURATION_DOES_NOT_EXIST",
          "SAML_CONFIGURATION_ID_NOT_SPECIFIED",
          "SAML_CONFIGURATION_IS_NOT_VALID",
          "SAML_RETURN_TO_URL_NOT_ALLOWED"
        ]
      },
      "EnterpriseSamlInitiateLoginPostResult200Enterprise": {
        "type": "object",
        "properties": {
          "saml_redirect_url": {
            "type": "string",
            "description": "Saml redirect url."
          }
        },
        "required": [
          "saml_redirect_url"
        ]
      },
      "EnterpriseSamlAssertionConsumerServicePostResult200Enterprise": {
        "type": "object",
        "properties": {
          "saml_token_id": {
            "type": "string",
            "description": "Saml token id identifier."
          }
        },
        "required": [
          "saml_token_id"
        ]
      },
      "EnterpriseOidcLoginRequestEnterprise": {
        "type": "object",
        "properties": {
          "public_key": {
            "description": "Hex-encoded public key.",
            "type": "string",
            "minLength": 64,
            "maxLength": 64
          },
          "login_info": {
            "description": "Hex-encoded ciphertext for the operation-specific login exchange.",
            "type": "string",
            "minLength": 1
          },
          "login_info_nonce": {
            "description": "Hex-encoded nonce for login info.",
            "type": "string",
            "minLength": 1
          },
          "session_duration": {
            "description": "Requested session lifetime in seconds, bounded by server/client-type configuration.",
            "type": "integer"
          }
        },
        "required": [
          "public_key",
          "login_info",
          "login_info_nonce"
        ],
        "x-psono-validation-errors": [
          "IP_ADDRESS_NOT_ALLOWED",
          "LOGIN_INFO_CANNOT_BE_DECRYPTED",
          "NO_OIDC_TOKEN_ID_PROVIDED",
          "OIDC_TOKEN_NOT_FOUND_ALREADY_USED_OR_EXPIRED",
          "USER_NOT_PART_OF_REQUIRED_GROUP"
        ]
      },
      "EnterpriseOidcInitiateLoginRequestEnterprise": {
        "type": "object",
        "properties": {
          "return_to_url": {
            "description": "Client return URL; must be allowed by the identity-provider configuration.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "return_to_url"
        ],
        "x-psono-validation-errors": [
          "OIDC_CONFIGURATION_DOES_NOT_EXIST",
          "OIDC_CONFIGURATION_ID_NOT_SPECIFIED",
          "OIDC_CONFIGURATION_IS_NOT_VALID",
          "OIDC_CONFIGURATION_MISSCONFIGURED_OIDC_ALLOWED_REDIRECT_URLS"
        ]
      },
      "EnterpriseOidcInitiateLoginPostResult200Enterprise": {
        "type": "object",
        "properties": {
          "oidc_redirect_url": {
            "type": "string",
            "description": "Oidc redirect url."
          }
        },
        "required": [
          "oidc_redirect_url"
        ]
      },
      "EnterpriseScimUsersPatchResult200Enterprise": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "urn:ietf:params:scim:schemas:core:2.0:User"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "externalId": {
            "type": "string",
            "description": "External id identifier."
          },
          "meta": {
            "type": "object",
            "properties": {
              "resourceType": {
                "type": "string",
                "example": "User",
                "description": "Resource type."
              },
              "created": {
                "type": "string",
                "description": "Created."
              },
              "lastModified": {
                "type": "string",
                "description": "Last modified."
              }
            },
            "required": [
              "resourceType",
              "created",
              "lastModified"
            ],
            "description": "Meta."
          },
          "userName": {
            "type": "string",
            "description": "User name."
          },
          "displayName": {
            "type": "boolean",
            "description": "Display name."
          },
          "active": {
            "type": "boolean",
            "description": "Whether the resource or account is active."
          },
          "emails": {
            "description": "Emails.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScimEmailValue"
            }
          }
        },
        "required": [
          "schemas",
          "id",
          "externalId",
          "meta",
          "userName",
          "displayName",
          "active",
          "emails"
        ]
      },
      "EnterpriseScimCreateUserRequestEnterprise": {
        "type": "object",
        "properties": {
          "active": {
            "description": "Whether the resource or account is active.",
            "type": "boolean"
          },
          "emails": {
            "description": "Emails.",
            "type": "array",
            "items": {
              "description": "Emails item.",
              "$ref": "#/components/schemas/EnterpriseEmailRequestEnterprise"
            },
            "minItems": 1
          },
          "userName": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "minLength": 1,
            "maxLength": 254
          },
          "displayName": {
            "description": "Display name; accepted case-insensitively as displayName.",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 512,
            "default": ""
          },
          "externalId": {
            "description": "Provisioning-system identifier; accepted case-insensitively as externalId.",
            "type": "string",
            "minLength": 1,
            "maxLength": 1024
          }
        },
        "required": [
          "active",
          "userName",
          "externalId",
          "emails"
        ],
        "x-psono-validation-errors": [
          "EMAIL_REQUIRED",
          "INVALID_USERNAME",
          "USER_WITH_EMAIL_ALREADY_EXISTS",
          "USER_WITH_EXTERNAL_ID_ALREADY_EXISTS",
          "USER_WITH_USERNAME_ALREADY_EXISTS"
        ]
      },
      "EnterpriseEmailRequestEnterprise": {
        "type": "object",
        "properties": {
          "value": {
            "description": "Value.",
            "type": "string",
            "format": "email",
            "minLength": 1
          },
          "display": {
            "description": "Display.",
            "type": [
              "string",
              "null"
            ]
          },
          "type": {
            "description": "Type.",
            "enum": [
              "work",
              "home",
              "other"
            ],
            "type": "string"
          },
          "primary": {
            "description": "Primary.",
            "type": "boolean",
            "default": false
          }
        },
        "required": [
          "value",
          "type"
        ]
      },
      "EnterpriseScimReplaceUserRequestEnterprise": {
        "type": "object",
        "properties": {
          "active": {
            "description": "Whether the resource or account is active.",
            "type": "boolean"
          },
          "emails": {
            "description": "Emails.",
            "type": "array",
            "items": {
              "description": "Emails item.",
              "$ref": "#/components/schemas/EnterpriseEmailRequestEnterprise"
            },
            "minItems": 1
          },
          "userName": {
            "description": "Account username, normally including the configured domain.",
            "type": "string",
            "minLength": 1,
            "maxLength": 254
          },
          "displayName": {
            "description": "Display name; accepted case-insensitively as displayName.",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 512,
            "default": ""
          },
          "externalId": {
            "description": "Provisioning-system identifier; accepted case-insensitively as externalId.",
            "type": "string",
            "minLength": 1,
            "maxLength": 1024
          }
        },
        "required": [
          "active",
          "userName",
          "externalId",
          "emails"
        ],
        "x-psono-validation-errors": [
          "EMAIL_REQUIRED",
          "INVALID_USERNAME",
          "USER_ID_NOT_PROVIDED",
          "USER_NOT_FOUND",
          "USER_WITH_EMAIL_ALREADY_EXISTS",
          "USER_WITH_USERNAME_ALREADY_EXISTS"
        ]
      },
      "EnterpriseScimGroupsPatchResult200Enterprise": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "urn:ietf:params:scim:schemas:core:2.0:Group"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "meta": {
            "type": "object",
            "properties": {
              "resourceType": {
                "type": "string",
                "example": "Group",
                "description": "Resource type."
              },
              "created": {
                "type": "string",
                "description": "Created."
              },
              "lastModified": {
                "type": "string",
                "description": "Last modified."
              }
            },
            "required": [
              "resourceType",
              "created",
              "lastModified"
            ],
            "description": "Meta."
          },
          "displayName": {
            "description": "Display name.",
            "type": "string"
          }
        },
        "required": [
          "schemas",
          "id",
          "meta",
          "displayName"
        ]
      },
      "EnterpriseScimCreateGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "members": {
            "description": "Members.",
            "type": "array",
            "items": {
              "description": "Members item.",
              "$ref": "#/components/schemas/EnterpriseMemberRequestEnterprise"
            }
          },
          "displayName": {
            "description": "Display name; accepted case-insensitively as displayName.",
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          }
        },
        "required": [
          "displayName"
        ],
        "x-psono-validation-errors": [
          "GROUP_WITH_DISPLAY_NAME_ALREADY_EXISTS"
        ]
      },
      "EnterpriseMemberRequestEnterprise": {
        "type": "object",
        "properties": {
          "value": {
            "description": "Value.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "value"
        ],
        "x-psono-validation-errors": [
          "MEMBER_WITH_USERID_DOESNT_EXIST"
        ]
      },
      "EnterpriseScimGroupsPostResult201Enterprise": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "urn:ietf:params:scim:schemas:core:2.0:Group"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "meta": {
            "type": "object",
            "properties": {
              "resourceType": {
                "type": "string",
                "example": "Group",
                "description": "Resource type."
              },
              "created": {
                "type": "string",
                "description": "Created."
              },
              "lastModified": {
                "type": "string",
                "description": "Last modified."
              }
            },
            "required": [
              "resourceType",
              "created",
              "lastModified"
            ],
            "description": "Meta."
          },
          "displayName": {
            "type": "string",
            "description": "Display name."
          }
        },
        "required": [
          "schemas",
          "id",
          "meta",
          "displayName"
        ]
      },
      "EnterpriseScimReplaceGroupRequestEnterprise": {
        "type": "object",
        "properties": {
          "members": {
            "description": "Members.",
            "type": "array",
            "items": {
              "description": "Members item.",
              "$ref": "#/components/schemas/EnterpriseMemberRequestEnterprise"
            }
          },
          "displayName": {
            "description": "Display name; accepted case-insensitively as displayName.",
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          }
        },
        "required": [
          "displayName"
        ],
        "x-psono-validation-errors": [
          "GROUP_ID_NOT_PROVIDED",
          "GROUP_NOT_FOUND"
        ]
      },
      "GatewayGatewayLaunchRequestEnterprise": {
        "type": "object",
        "properties": {
          "cluster_id": {
            "description": "Cluster id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "secret_id": {
            "description": "Secret id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "data": {
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope.",
            "type": "string",
            "minLength": 1
          },
          "data_nonce": {
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce.",
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "cluster_id",
          "secret_id",
          "data",
          "data_nonce"
        ]
      },
      "GatewayGatewayLaunchPostResult201Enterprise": {
        "type": "object",
        "properties": {
          "launch_id": {
            "type": "string",
            "description": "Launch id identifier."
          },
          "gateway_url": {
            "type": "string",
            "description": "Gateway url."
          },
          "valid_till": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Expiration time in ISO 8601 format."
          }
        },
        "required": [
          "launch_id",
          "gateway_url",
          "valid_till"
        ]
      },
      "GatewayGatewayLaunchTradeRequestEnterprise": {
        "type": "object",
        "properties": {
          "launch_id": {
            "description": "Launch id identifier.",
            "type": "string",
            "minLength": 64,
            "maxLength": 64
          }
        },
        "required": [
          "launch_id"
        ]
      },
      "GatewayGatewayLaunchTradePutResult200Enterprise": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope."
          },
          "data_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce."
          }
        },
        "required": [
          "data",
          "data_nonce"
        ]
      },
      "GatewayGatewayLaunchStatusRequestEnterprise": {
        "type": "object",
        "properties": {
          "launch_ids": {
            "description": "Launch ids.",
            "type": "array",
            "items": {
              "description": "Launch ids item.",
              "type": "string",
              "minLength": 1,
              "pattern": "^[0-9a-fA-F]{64}$"
            },
            "maxItems": 500
          }
        },
        "required": [
          "launch_ids"
        ]
      },
      "GatewayGatewayLaunchStatusPostResult200Enterprise": {
        "type": "object",
        "properties": {
          "valid_launch_ids": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Valid launch ids."
          }
        },
        "required": [
          "valid_launch_ids"
        ]
      },
      "EffectiveAccess": {
        "type": "object",
        "properties": {
          "read": {
            "type": "boolean",
            "description": "Whether read access is granted."
          },
          "write": {
            "type": "boolean",
            "description": "Whether write access is granted."
          },
          "grant": {
            "type": "boolean",
            "description": "Whether the recipient may grant access to others."
          }
        },
        "additionalProperties": true,
        "required": [
          "read",
          "write",
          "grant"
        ]
      },
      "ScimEmailValue": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "format": "email",
            "description": "Value."
          },
          "type": {
            "type": "string",
            "enum": [
              "work",
              "home",
              "other"
            ],
            "description": "Type."
          },
          "primary": {
            "type": "boolean",
            "description": "Primary."
          },
          "display": {
            "type": "string",
            "description": "Display."
          }
        },
        "required": [
          "value"
        ]
      },
      "ScimPatchRequest": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "Operations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "op": {
                  "type": "string",
                  "description": "SCIM operation name, typically add, replace, or remove."
                },
                "path": {
                  "type": "string",
                  "description": "Resource attribute path."
                },
                "value": {
                  "description": "JSON value for the selected operation and attribute."
                }
              },
              "required": [
                "op"
              ]
            },
            "description": "SCIM PATCH operations applied in order."
          }
        },
        "example": {
          "schemas": [
            "urn:ietf:params:scim:api:messages:2.0:PatchOp"
          ],
          "Operations": [
            {
              "op": "replace",
              "path": "active",
              "value": false
            }
          ]
        }
      },
      "AvailableShard": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Id identifier."
          },
          "shard_title": {
            "type": "string",
            "description": "Shard title."
          },
          "shard_description": {
            "type": "string",
            "description": "Shard description."
          },
          "read": {
            "type": "boolean",
            "description": "Whether read access is granted."
          },
          "write": {
            "type": "boolean",
            "description": "Whether write access is granted."
          },
          "fileserver": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fileserver_public_key": {
                  "type": "string",
                  "description": "Fileserver public key."
                },
                "fileserver_url": {
                  "type": "string",
                  "format": "uri",
                  "description": "Fileserver url."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                }
              }
            },
            "description": "Fileserver."
          }
        },
        "required": [
          "id",
          "shard_title",
          "shard_description",
          "read",
          "write",
          "fileserver"
        ]
      },
      "LoginInfoPayload": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "description": "Account username."
          },
          "authkey": {
            "type": "string",
            "description": "Derived authentication key."
          },
          "password": {
            "type": "string",
            "description": "Optional password for password-backed authentication such as LDAP."
          },
          "client_type": {
            "type": "string",
            "description": "Client category used when bounding session duration.",
            "default": "webclient"
          },
          "device_fingerprint": {
            "type": "string",
            "description": "Client device/session fingerprint."
          },
          "device_description": {
            "type": "string",
            "description": "Client device description."
          },
          "device_time": {
            "type": "string",
            "description": "Client time used for replay protection.",
            "format": "date-time"
          }
        },
        "required": [
          "username",
          "authkey"
        ]
      },
      "ApiKeySignedInfo": {
        "type": "object",
        "properties": {
          "api_key_id": {
            "type": "string",
            "format": "uuid",
            "description": "Api key id identifier."
          },
          "session_public_key": {
            "type": "string",
            "description": "Temporary Curve25519 public key in hex."
          },
          "session_duration": {
            "type": "integer",
            "description": "Requested session lifetime in seconds, bounded by server/client-type configuration."
          },
          "device_fingerprint": {
            "type": "string",
            "description": "Client device/session fingerprint."
          },
          "device_description": {
            "type": "string",
            "description": "Client device description."
          },
          "device_time": {
            "type": "string",
            "description": "Client time used for replay protection.",
            "format": "date-time"
          }
        },
        "required": [
          "api_key_id",
          "session_public_key"
        ]
      },
      "RecoveryUpdatePayload": {
        "type": "object",
        "properties": {
          "authkey": {
            "type": "string",
            "description": "Derived authentication key. Derive it using the account hashing parameters; this is not the vault encryption key."
          },
          "private_key": {
            "type": "string",
            "description": "Encrypted private key; never send an unencrypted vault private key here."
          },
          "private_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for private key."
          },
          "secret_key": {
            "type": "string",
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
          },
          "secret_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for secret key."
          }
        },
        "required": [
          "authkey",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce"
        ]
      },
      "EmergencyUpdatePayload": {
        "type": "object",
        "properties": {
          "session_public_key": {
            "type": "string",
            "description": "Temporary client public key in hex."
          },
          "device_fingerprint": {
            "type": "string",
            "description": "Client device/session fingerprint."
          },
          "device_description": {
            "type": "string",
            "description": "Client device description."
          },
          "device_time": {
            "type": "string",
            "description": "Client time used for replay protection.",
            "format": "date-time"
          }
        },
        "required": [
          "session_public_key"
        ]
      },
      "ScimError": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "status": {
            "type": [
              "integer",
              "string"
            ],
            "description": "Status."
          },
          "detail": {
            "description": "DRF validation details or an error message."
          }
        },
        "additionalProperties": true
      },
      "PasswordLoginResultEnterprise": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Authentication token returned by the indicated exchange."
          },
          "session_key": {
            "type": "string",
            "description": "Session identifier/key distinct from the symmetric session encryption key."
          },
          "session_valid_till": {
            "type": "string",
            "description": "Session valid till."
          },
          "required_multifactors": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "ivalt_2fa"
            },
            "description": "Required multifactors."
          },
          "session_public_key": {
            "type": "string",
            "description": "Session public key."
          },
          "session_secret_key": {
            "type": "string",
            "description": "Session encryption key, encrypted/wrapped in login exchanges as described by the protocol."
          },
          "session_secret_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for session secret key."
          },
          "user_validator": {
            "type": "string",
            "description": "Encrypted user-validator challenge used for token activation."
          },
          "user_validator_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for user validator."
          },
          "user": {
            "type": "object",
            "properties": {
              "username": {
                "type": "string",
                "description": "Account username, normally including the configured domain."
              },
              "language": {
                "type": "string",
                "description": "Language."
              },
              "public_key": {
                "type": "string",
                "description": "Hex-encoded public key."
              },
              "private_key": {
                "type": "string",
                "description": "Encrypted private key; never send an unencrypted vault private key here."
              },
              "private_key_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for private key."
              },
              "user_sauce": {
                "type": "string",
                "description": "User sauce."
              },
              "policies": {
                "type": "object",
                "additionalProperties": true,
                "description": "Policies."
              },
              "authentication": {
                "type": "string",
                "description": "Authentication."
              },
              "hashing_algorithm": {
                "type": "string",
                "description": "Hashing algorithm."
              },
              "hashing_parameters": {
                "type": "object",
                "additionalProperties": true,
                "description": "Hashing parameters."
              },
              "require_password_change": {
                "type": "boolean",
                "description": "Require password change."
              }
            },
            "required": [
              "username",
              "language",
              "public_key",
              "private_key",
              "private_key_nonce",
              "user_sauce",
              "policies",
              "authentication",
              "hashing_algorithm",
              "hashing_parameters",
              "require_password_change"
            ],
            "description": "User."
          }
        },
        "required": [
          "token",
          "session_key",
          "session_valid_till",
          "required_multifactors",
          "session_public_key",
          "session_secret_key",
          "session_secret_key_nonce",
          "user_validator",
          "user_validator_nonce",
          "user"
        ]
      },
      "EmergencyLoginResult": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Authentication token returned by the indicated exchange."
          },
          "session_valid_till": {
            "type": "string",
            "description": "Session valid till."
          },
          "session_secret_key": {
            "type": "string",
            "description": "Session encryption key, encrypted/wrapped in login exchanges as described by the protocol."
          },
          "user_public_key": {
            "type": "string",
            "description": "User public key."
          },
          "user_email": {
            "description": "User email."
          },
          "user_id": {
            "type": "string",
            "description": "User id identifier."
          },
          "hashing_algorithm": {
            "type": "string",
            "description": "Hashing algorithm."
          },
          "hashing_parameters": {
            "type": "object",
            "additionalProperties": true,
            "description": "Hashing parameters."
          },
          "default_hashing_algorithm": {
            "type": "string",
            "description": "Default hashing algorithm."
          },
          "default_hashing_parameters": {
            "type": "object",
            "additionalProperties": true,
            "description": "Default hashing parameters."
          }
        },
        "required": [
          "token",
          "session_valid_till",
          "session_secret_key",
          "user_public_key",
          "user_email",
          "user_id",
          "hashing_algorithm",
          "hashing_parameters",
          "default_hashing_algorithm",
          "default_hashing_parameters"
        ]
      },
      "ApiKeyLoginResultEnterprise": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Authentication token returned by the indicated exchange."
          },
          "session_valid_till": {
            "type": "string",
            "description": "Session valid till."
          },
          "session_secret_key": {
            "type": "string",
            "description": "Session encryption key, encrypted/wrapped in login exchanges as described by the protocol."
          },
          "api_key_restrict_to_secrets": {
            "type": "boolean",
            "description": "Api key restrict to secrets."
          },
          "api_key_allow_insecure_access": {
            "type": "boolean",
            "description": "Api key allow insecure access."
          },
          "api_key_allow_api_key_management": {
            "type": "boolean",
            "description": "Api key allow api key management."
          },
          "api_key_allow_admin_access": {
            "type": "boolean",
            "description": "Api key allow admin access."
          },
          "api_key_allow_recovery_access": {
            "type": "boolean",
            "description": "Api key allow recovery access."
          },
          "api_key_allow_emergency_access": {
            "type": "boolean",
            "description": "Api key allow emergency access."
          },
          "api_key_read": {
            "type": "boolean",
            "description": "Api key read."
          },
          "api_key_write": {
            "type": "boolean",
            "description": "Api key write."
          },
          "user": {
            "type": "object",
            "properties": {
              "username": {
                "type": "string",
                "description": "Account username, normally including the configured domain."
              },
              "public_key": {
                "type": "string",
                "description": "Hex-encoded public key."
              },
              "private_key": {
                "type": "string",
                "description": "User key material wrapped with the API-key symmetric secret; returned for unrestricted keys."
              },
              "private_key_nonce": {
                "type": "string",
                "description": "User key material wrapped with the API-key symmetric secret; returned for unrestricted keys."
              },
              "secret_key": {
                "type": "string",
                "description": "User key material wrapped with the API-key symmetric secret; returned for unrestricted keys."
              },
              "secret_key_nonce": {
                "type": "string",
                "description": "User key material wrapped with the API-key symmetric secret; returned for unrestricted keys."
              }
            },
            "required": [
              "username",
              "public_key"
            ],
            "description": "User."
          }
        },
        "required": [
          "token",
          "session_valid_till",
          "session_secret_key",
          "api_key_restrict_to_secrets",
          "api_key_allow_insecure_access",
          "api_key_allow_api_key_management",
          "api_key_allow_admin_access",
          "api_key_allow_recovery_access",
          "api_key_allow_emergency_access",
          "api_key_read",
          "api_key_write",
          "user"
        ]
      },
      "getApiKeyByApiKeyIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "title": {
            "type": "string",
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
          },
          "public_key": {
            "type": "string",
            "description": "Hex-encoded public key."
          },
          "private_key": {
            "type": "string",
            "description": "Encrypted private key; never send an unencrypted vault private key here."
          },
          "private_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for private key."
          },
          "secret_key": {
            "type": "string",
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
          },
          "secret_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for secret key."
          },
          "read": {
            "type": "boolean",
            "description": "Whether read access is granted."
          },
          "write": {
            "type": "boolean",
            "description": "Whether write access is granted."
          },
          "restrict_to_secrets": {
            "type": "boolean",
            "description": "Restrict to secrets."
          },
          "allow_insecure_access": {
            "type": "boolean",
            "description": "Allow insecure access."
          },
          "allow_api_key_management": {
            "type": "boolean",
            "description": "Allow api key management."
          },
          "allow_admin_access": {
            "type": "boolean",
            "description": "Allow admin access."
          },
          "allow_recovery_access": {
            "type": "boolean",
            "description": "Allow recovery access."
          },
          "allow_emergency_access": {
            "type": "boolean",
            "description": "Allow emergency access."
          },
          "active": {
            "type": "boolean",
            "description": "Whether the resource or account is active."
          }
        },
        "required": [
          "id",
          "title",
          "public_key",
          "private_key",
          "private_key_nonce",
          "secret_key",
          "secret_key_nonce",
          "read",
          "write",
          "restrict_to_secrets",
          "allow_insecure_access",
          "allow_api_key_management",
          "allow_admin_access",
          "allow_recovery_access",
          "allow_emergency_access",
          "active"
        ]
      },
      "getApiKeyResult": {
        "type": "object",
        "properties": {
          "api_keys": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "restrict_to_secrets": {
                  "type": "boolean",
                  "description": "Restrict to secrets."
                },
                "allow_insecure_access": {
                  "type": "boolean",
                  "description": "Allow insecure access."
                },
                "allow_api_key_management": {
                  "type": "boolean",
                  "description": "Allow api key management."
                },
                "allow_admin_access": {
                  "type": "boolean",
                  "description": "Allow admin access."
                },
                "allow_recovery_access": {
                  "type": "boolean",
                  "description": "Allow recovery access."
                },
                "allow_emergency_access": {
                  "type": "boolean",
                  "description": "Allow emergency access."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                }
              },
              "required": [
                "id",
                "title",
                "read",
                "write",
                "restrict_to_secrets",
                "allow_insecure_access",
                "allow_api_key_management",
                "allow_admin_access",
                "allow_recovery_access",
                "allow_emergency_access",
                "active"
              ]
            },
            "description": "Api keys."
          }
        },
        "required": [
          "api_keys"
        ]
      },
      "getLinkShareByLinkShareIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "secret_id": {
            "type": "string",
            "description": "Secret id identifier."
          },
          "public_title": {
            "type": "string",
            "description": "Public title."
          },
          "allowed_reads": {
            "type": "integer",
            "description": "Allowed reads."
          },
          "valid_till": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Expiration time in ISO 8601 format."
          }
        },
        "required": [
          "id",
          "secret_id",
          "public_title",
          "allowed_reads",
          "valid_till"
        ]
      },
      "getLinkShareResult": {
        "type": "object",
        "properties": {
          "link_shares": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "secret_id": {
                  "type": "string",
                  "description": "Secret id identifier."
                },
                "public_title": {
                  "type": "string",
                  "description": "Public title."
                },
                "allowed_reads": {
                  "type": "integer",
                  "description": "Allowed reads."
                },
                "valid_till": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Expiration time in ISO 8601 format."
                }
              },
              "required": [
                "id",
                "secret_id",
                "public_title",
                "allowed_reads",
                "valid_till"
              ]
            },
            "description": "Link shares."
          }
        },
        "required": [
          "link_shares"
        ]
      },
      "getDatastoreResult": {
        "type": "object",
        "properties": {
          "datastores": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "type": {
                  "type": "string",
                  "description": "Type."
                },
                "description": {
                  "type": "string",
                  "description": "Human-readable description."
                },
                "is_default": {
                  "type": "boolean",
                  "description": "Is default."
                }
              },
              "required": [
                "id",
                "type",
                "description",
                "is_default"
              ]
            },
            "description": "Datastores."
          }
        },
        "required": [
          "datastores"
        ]
      },
      "getDatastoreByDatastoreIdResult": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope."
          },
          "data_nonce": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "example": ""
              }
            ],
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce."
          },
          "type": {
            "type": "string",
            "description": "Type."
          },
          "description": {
            "type": "string",
            "description": "Human-readable description."
          },
          "secret_key": {
            "type": "string",
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
          },
          "secret_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for secret key."
          },
          "is_default": {
            "type": "boolean",
            "description": "Is default."
          },
          "write_date": {
            "type": "string",
            "description": "Last write time in ISO 8601 format."
          }
        },
        "required": [
          "data",
          "data_nonce",
          "type",
          "description",
          "secret_key",
          "secret_key_nonce",
          "is_default",
          "write_date"
        ]
      },
      "ShardListResult": {
        "type": "object",
        "properties": {
          "shards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AvailableShard"
            },
            "description": "Shards."
          }
        },
        "required": [
          "shards"
        ]
      },
      "getFileRepositoryByFileRepositoryIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "title": {
            "type": "string",
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
          },
          "type": {
            "type": "string",
            "description": "Type."
          },
          "active": {
            "type": "boolean",
            "description": "Whether the resource or account is active."
          },
          "read": {
            "type": "boolean",
            "description": "Whether read access is granted."
          },
          "write": {
            "type": "boolean",
            "description": "Whether write access is granted."
          },
          "grant": {
            "type": "boolean",
            "description": "Whether the recipient may grant access to others."
          },
          "file_repository_rights": {
            "type": "array",
            "items": {},
            "description": "File repository rights."
          },
          "group_file_repository_rights": {
            "type": "array",
            "items": {},
            "description": "Group file repository rights."
          }
        },
        "required": [
          "id",
          "title",
          "type",
          "active",
          "read",
          "write",
          "grant",
          "file_repository_rights",
          "group_file_repository_rights"
        ]
      },
      "getFileRepositoryResult": {
        "type": "object",
        "properties": {
          "file_repositories": {
            "type": "array",
            "items": {},
            "description": "File repositories."
          }
        },
        "required": [
          "file_repositories"
        ]
      },
      "ShareRightOverview": {
        "type": "object",
        "properties": {
          "share_rights": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "share_id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Share id identifier."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "grant": {
                  "type": "boolean",
                  "description": "Whether the recipient may grant access to others."
                }
              }
            },
            "description": "Share rights."
          }
        },
        "required": [
          "share_rights"
        ]
      },
      "getShareResult": {
        "type": "object",
        "properties": {
          "shares": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "share_right_create_date": {
                  "type": "string",
                  "description": "Share right create date."
                },
                "share_right_write_date": {
                  "type": "string",
                  "description": "Share right write date."
                },
                "share_right_id": {
                  "type": "string",
                  "description": "Share right id identifier."
                },
                "share_right_user_id": {
                  "type": "string",
                  "description": "Share right user id identifier."
                },
                "share_right_title": {
                  "type": "string",
                  "description": "Share right title."
                },
                "share_right_title_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for share right title."
                },
                "share_right_type": {
                  "type": "string",
                  "description": "Share right type."
                },
                "share_right_type_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for share right type."
                },
                "share_right_key": {
                  "type": "string",
                  "description": "Share right key."
                },
                "share_right_key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for share right key."
                },
                "share_right_key_type": {
                  "type": "string",
                  "example": "symmetric",
                  "description": "Share right key type."
                },
                "share_right_read": {
                  "type": "boolean",
                  "description": "Share right read."
                },
                "share_right_write": {
                  "type": "boolean",
                  "description": "Share right write."
                },
                "share_right_grant": {
                  "type": "boolean",
                  "description": "Share right grant."
                },
                "share_right_accepted": {
                  "type": [
                    "boolean",
                    "null"
                  ],
                  "description": "Share right accepted."
                },
                "share_right_expiration_date": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Share right expiration date."
                },
                "share_right_create_user_id": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Share right create user id identifier."
                    },
                    {
                      "type": "string",
                      "example": ""
                    }
                  ],
                  "description": "Share right create user id identifier."
                },
                "share_right_create_user_username": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "string",
                      "example": ""
                    }
                  ],
                  "description": "Share right create user username."
                },
                "share_right_create_user_public_key": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "string",
                      "example": ""
                    }
                  ],
                  "description": "Share right create user public key."
                }
              },
              "required": [
                "id",
                "share_right_create_date",
                "share_right_write_date",
                "share_right_id",
                "share_right_user_id",
                "share_right_title",
                "share_right_title_nonce",
                "share_right_type",
                "share_right_type_nonce",
                "share_right_key",
                "share_right_key_nonce",
                "share_right_key_type",
                "share_right_read",
                "share_right_write",
                "share_right_grant",
                "share_right_accepted",
                "share_right_expiration_date",
                "share_right_create_user_id",
                "share_right_create_user_username",
                "share_right_create_user_public_key"
              ]
            },
            "description": "Shares."
          }
        },
        "required": [
          "shares"
        ]
      },
      "getShareByShareIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "data": {
            "type": "string",
            "description": "Encrypted content. Vault data remains encrypted after removing the transport envelope."
          },
          "data_nonce": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "example": ""
              }
            ],
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce."
          },
          "user_id": {
            "type": "string",
            "description": "User id identifier."
          },
          "rights": {
            "$ref": "#/components/schemas/EffectiveAccess",
            "description": "Own share rights."
          },
          "write_date": {
            "type": "string",
            "description": "Last write time in ISO 8601 format."
          }
        },
        "required": [
          "id",
          "data",
          "data_nonce",
          "user_id",
          "rights",
          "write_date"
        ]
      },
      "getGroupResultEnterprise": {
        "type": "object",
        "properties": {
          "groups": {
            "type": "object",
            "properties": {
              "group_id": {
                "type": "string",
                "description": "Group id identifier."
              },
              "name": {
                "type": "string",
                "description": "Display name."
              },
              "public_key": {
                "type": "string",
                "description": "Hex-encoded public key."
              },
              "group_admin": {
                "type": "boolean",
                "description": "Group admin."
              },
              "share_admin": {
                "type": "boolean",
                "description": "Share admin."
              },
              "accepted": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether the invitation/right has been accepted."
              },
              "forced_membership": {
                "type": "boolean",
                "description": "Forced membership."
              },
              "secret_key": {
                "type": "string",
                "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
              },
              "secret_key_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for secret key."
              },
              "secret_key_type": {
                "type": "string",
                "description": "Secret key type."
              },
              "private_key": {
                "type": "string",
                "description": "Encrypted private key; never send an unencrypted vault private key here."
              },
              "private_key_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for private key."
              },
              "private_key_type": {
                "type": "string",
                "description": "Private key type."
              },
              "members": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Id identifier."
                    },
                    "membership_create_date": {
                      "type": "string",
                      "description": "Membership create date."
                    },
                    "membership_id": {
                      "type": "string",
                      "description": "Membership id identifier."
                    },
                    "name": {
                      "type": "string",
                      "description": "Display name."
                    },
                    "public_key": {
                      "type": "string",
                      "description": "Hex-encoded public key."
                    },
                    "group_admin": {
                      "type": "boolean",
                      "description": "Group admin."
                    },
                    "share_admin": {
                      "type": "boolean",
                      "description": "Share admin."
                    },
                    "accepted": {
                      "type": [
                        "boolean",
                        "null"
                      ],
                      "description": "Whether the invitation/right has been accepted."
                    }
                  },
                  "required": [
                    "id",
                    "membership_create_date",
                    "membership_id",
                    "name",
                    "public_key",
                    "group_admin",
                    "share_admin",
                    "accepted"
                  ]
                },
                "description": "Members."
              },
              "group_share_rights": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Id identifier."
                    },
                    "create_date": {
                      "type": "string",
                      "description": "Creation time in ISO 8601 format."
                    },
                    "share_id": {
                      "type": "string",
                      "description": "Share id identifier."
                    },
                    "title": {
                      "type": "string",
                      "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                    },
                    "title_nonce": {
                      "type": "string",
                      "description": "Hex-encoded nonce for title."
                    },
                    "type": {
                      "type": "string",
                      "description": "Type."
                    },
                    "type_nonce": {
                      "type": "string",
                      "description": "Hex-encoded nonce for type."
                    },
                    "key": {
                      "type": "string",
                      "description": "Wrapped encryption key for the recipient, as indicated by key_type."
                    },
                    "key_nonce": {
                      "type": "string",
                      "description": "Hex-encoded nonce for key."
                    },
                    "read": {
                      "type": "boolean",
                      "description": "Whether read access is granted."
                    },
                    "write": {
                      "type": "boolean",
                      "description": "Whether write access is granted."
                    },
                    "grant": {
                      "type": "boolean",
                      "description": "Whether the recipient may grant access to others."
                    },
                    "expiration_date": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Expiration date."
                    }
                  },
                  "required": [
                    "id",
                    "create_date",
                    "share_id",
                    "title",
                    "title_nonce",
                    "type",
                    "type_nonce",
                    "key",
                    "key_nonce",
                    "read",
                    "write",
                    "grant",
                    "expiration_date"
                  ]
                },
                "description": "Group share rights."
              },
              "user_id": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "User id identifier."
                  },
                  {
                    "type": "string",
                    "example": ""
                  }
                ],
                "description": "User id identifier."
              },
              "user_username": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "string",
                    "example": ""
                  }
                ],
                "description": "User username."
              }
            },
            "required": [
              "group_id",
              "name",
              "public_key",
              "group_admin",
              "share_admin",
              "accepted",
              "forced_membership"
            ],
            "description": "Groups."
          }
        },
        "required": [
          "groups"
        ]
      },
      "getGroupByGroupIdResultEnterprise": {
        "type": "object",
        "properties": {
          "group_id": {
            "type": "string",
            "description": "Group id identifier."
          },
          "name": {
            "type": "string",
            "description": "Display name."
          },
          "public_key": {
            "type": "string",
            "description": "Hex-encoded public key."
          },
          "group_admin": {
            "type": "boolean",
            "description": "Group admin."
          },
          "share_admin": {
            "type": "boolean",
            "description": "Share admin."
          },
          "accepted": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether the invitation/right has been accepted."
          },
          "forced_membership": {
            "type": "boolean",
            "description": "Forced membership."
          },
          "secret_key": {
            "type": "string",
            "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
          },
          "secret_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for secret key."
          },
          "secret_key_type": {
            "type": "string",
            "description": "Secret key type."
          },
          "private_key": {
            "type": "string",
            "description": "Encrypted private key; never send an unencrypted vault private key here."
          },
          "private_key_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for private key."
          },
          "private_key_type": {
            "type": "string",
            "description": "Private key type."
          },
          "members": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "membership_create_date": {
                  "type": "string",
                  "description": "Membership create date."
                },
                "membership_id": {
                  "type": "string",
                  "description": "Membership id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                },
                "public_key": {
                  "type": "string",
                  "description": "Hex-encoded public key."
                },
                "group_admin": {
                  "type": "boolean",
                  "description": "Group admin."
                },
                "share_admin": {
                  "type": "boolean",
                  "description": "Share admin."
                },
                "accepted": {
                  "type": [
                    "boolean",
                    "null"
                  ],
                  "description": "Whether the invitation/right has been accepted."
                }
              },
              "required": [
                "id",
                "membership_create_date",
                "membership_id",
                "name",
                "public_key",
                "group_admin",
                "share_admin",
                "accepted"
              ]
            },
            "description": "Members."
          },
          "group_share_rights": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": "string",
                  "description": "Creation time in ISO 8601 format."
                },
                "share_id": {
                  "type": "string",
                  "description": "Share id identifier."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "title_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for title."
                },
                "type": {
                  "type": "string",
                  "description": "Type."
                },
                "type_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for type."
                },
                "key": {
                  "type": "string",
                  "description": "Wrapped encryption key for the recipient, as indicated by key_type."
                },
                "key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for key."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "grant": {
                  "type": "boolean",
                  "description": "Whether the recipient may grant access to others."
                },
                "expiration_date": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Expiration date."
                }
              },
              "required": [
                "id",
                "create_date",
                "share_id",
                "title",
                "title_nonce",
                "type",
                "type_nonce",
                "key",
                "key_nonce",
                "read",
                "write",
                "grant",
                "expiration_date"
              ]
            },
            "description": "Group share rights."
          },
          "user_id": {
            "anyOf": [
              {
                "type": "string",
                "description": "User id identifier."
              },
              {
                "type": "string",
                "example": ""
              }
            ],
            "description": "User id identifier."
          },
          "user_username": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "example": ""
              }
            ],
            "description": "User username."
          }
        },
        "required": [
          "group_id",
          "name",
          "public_key",
          "group_admin",
          "share_admin",
          "accepted",
          "forced_membership"
        ]
      },
      "ManagementCommandResult": {
        "type": "object",
        "properties": {
          "output": {
            "type": "string",
            "description": "Captured command standard output."
          }
        },
        "required": [
          "output"
        ]
      },
      "DeviceCodePollPayload": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "state": {
            "type": "string",
            "description": "State."
          },
          "token": {
            "type": "string",
            "description": "Authentication token returned by the indicated exchange."
          },
          "session_secret_key": {
            "type": "string",
            "description": "Session encryption key, encrypted/wrapped in login exchanges as described by the protocol."
          },
          "token_valid_till": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Token valid till."
          },
          "encrypted_credentials": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Encrypted credentials."
          },
          "encrypted_credentials_nonce": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Hex-encoded nonce for encrypted credentials."
          }
        },
        "required": [
          "id",
          "state",
          "token",
          "session_secret_key",
          "token_valid_till",
          "encrypted_credentials",
          "encrypted_credentials_nonce"
        ]
      },
      "AdministrativeAuthorizationResult": {
        "type": "object",
        "properties": {
          "is_superuser": {
            "type": "boolean",
            "description": "Is superuser."
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                },
                "is_global": {
                  "type": "boolean",
                  "description": "Is global."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "description": "Tenant ids."
                }
              }
            },
            "description": "Roles."
          },
          "capabilities": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "global": {
                  "type": "boolean"
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uuid"
                  }
                }
              },
              "required": [
                "global",
                "tenant_ids"
              ]
            },
            "description": "Capabilities."
          }
        },
        "required": [
          "is_superuser",
          "roles",
          "capabilities"
        ]
      },
      "AdministrativeCapabilitiesResult": {
        "type": "object",
        "properties": {
          "capabilities": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Code."
                },
                "category": {
                  "type": "string",
                  "description": "Category."
                },
                "description": {
                  "type": "string",
                  "description": "Human-readable description."
                },
                "tenant_scopeable": {
                  "type": "boolean",
                  "description": "Tenant scopeable."
                }
              },
              "required": [
                "code",
                "category",
                "description",
                "tenant_scopeable"
              ]
            },
            "description": "Capabilities."
          }
        },
        "required": [
          "capabilities"
        ]
      },
      "getAdminTenantByTenantIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "name": {
            "type": "string",
            "description": "Display name."
          },
          "description": {
            "type": "string",
            "description": "Human-readable description."
          },
          "is_active": {
            "type": "boolean",
            "description": "Is active."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "write_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Last write time in ISO 8601 format."
          },
          "user_count": {
            "type": "integer",
            "description": "User count."
          },
          "group_count": {
            "type": "integer",
            "description": "Group count."
          },
          "users": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                }
              },
              "required": [
                "id",
                "username"
              ]
            },
            "description": "Users."
          },
          "groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                }
              },
              "required": [
                "id",
                "name"
              ]
            },
            "description": "Groups."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "is_active",
          "create_date",
          "write_date",
          "user_count",
          "group_count"
        ]
      },
      "deleteAdminTenantPayload": {
        "type": "object",
        "properties": {
          "tenant_id": {
            "description": "Tenant id identifier.",
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "tenant_id"
        ]
      },
      "getAdminTenantResult": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "tenants": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                },
                "description": {
                  "type": "string",
                  "description": "Human-readable description."
                },
                "is_active": {
                  "type": "boolean",
                  "description": "Is active."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "user_count": {
                  "type": "integer",
                  "description": "User count."
                },
                "group_count": {
                  "type": "integer",
                  "description": "Group count."
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "username": {
                        "type": "string",
                        "description": "Account username, normally including the configured domain."
                      }
                    },
                    "required": [
                      "id",
                      "username"
                    ]
                  },
                  "description": "Users."
                },
                "groups": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name."
                      }
                    },
                    "required": [
                      "id",
                      "name"
                    ]
                  },
                  "description": "Groups."
                }
              },
              "required": [
                "id",
                "name",
                "description",
                "is_active",
                "create_date",
                "write_date",
                "user_count",
                "group_count"
              ]
            },
            "description": "Tenants."
          }
        },
        "required": [
          "count",
          "tenants"
        ]
      },
      "postAdminTenantPayload": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "description": {
            "description": "Human-readable description.",
            "type": "string"
          },
          "is_active": {
            "description": "Is active.",
            "type": "boolean"
          }
        },
        "required": [
          "name"
        ]
      },
      "putAdminTenantPayload": {
        "type": "object",
        "properties": {
          "tenant_id": {
            "description": "Tenant id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "description": {
            "description": "Human-readable description.",
            "type": "string"
          },
          "is_active": {
            "description": "Is active.",
            "type": "boolean"
          }
        },
        "required": [
          "tenant_id"
        ]
      },
      "getAdminAdministrativeRoleByRoleIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "name": {
            "type": "string",
            "description": "Display name."
          },
          "description": {
            "type": "string",
            "description": "Human-readable description."
          },
          "is_active": {
            "type": "boolean",
            "description": "Is active."
          },
          "is_system": {
            "type": "boolean",
            "description": "Is system."
          },
          "is_full_access": {
            "type": "boolean",
            "description": "Is full access."
          },
          "capabilities": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Capabilities."
          },
          "assignments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "role_id": {
                  "type": "string",
                  "description": "Role id identifier."
                },
                "role_name": {
                  "type": "string",
                  "description": "Role name."
                },
                "user_id": {
                  "type": "string",
                  "description": "User id identifier."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "is_global": {
                  "type": "boolean",
                  "description": "Is global."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "description": "Tenant ids."
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name."
                      }
                    },
                    "required": [
                      "id",
                      "name"
                    ]
                  },
                  "description": "Tenants."
                }
              },
              "required": [
                "id",
                "role_id",
                "role_name",
                "user_id",
                "username",
                "is_global",
                "tenant_ids",
                "tenants"
              ]
            },
            "description": "Assignments."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "is_active",
          "is_system",
          "is_full_access",
          "capabilities"
        ]
      },
      "getAdminAdministrativeRoleResult": {
        "type": "object",
        "properties": {
          "roles": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                },
                "description": {
                  "type": "string",
                  "description": "Human-readable description."
                },
                "is_active": {
                  "type": "boolean",
                  "description": "Is active."
                },
                "is_system": {
                  "type": "boolean",
                  "description": "Is system."
                },
                "is_full_access": {
                  "type": "boolean",
                  "description": "Is full access."
                },
                "capabilities": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Capabilities."
                },
                "assignments": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "role_id": {
                        "type": "string",
                        "description": "Role id identifier."
                      },
                      "role_name": {
                        "type": "string",
                        "description": "Role name."
                      },
                      "user_id": {
                        "type": "string",
                        "description": "User id identifier."
                      },
                      "username": {
                        "type": "string",
                        "description": "Account username, normally including the configured domain."
                      },
                      "is_global": {
                        "type": "boolean",
                        "description": "Is global."
                      },
                      "tenant_ids": {
                        "type": "array",
                        "items": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "description": "Tenant ids."
                      },
                      "tenants": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "description": "Id identifier.",
                              "type": "string"
                            },
                            "name": {
                              "description": "Display name.",
                              "type": "string"
                            }
                          },
                          "required": [
                            "id",
                            "name"
                          ]
                        },
                        "description": "Tenants."
                      }
                    },
                    "required": [
                      "id",
                      "role_id",
                      "role_name",
                      "user_id",
                      "username",
                      "is_global",
                      "tenant_ids",
                      "tenants"
                    ]
                  },
                  "description": "Assignments."
                }
              },
              "required": [
                "id",
                "name",
                "description",
                "is_active",
                "is_system",
                "is_full_access",
                "capabilities"
              ]
            },
            "description": "Roles."
          }
        },
        "required": [
          "roles"
        ]
      },
      "postAdminAdministrativeRolePayload": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Display name.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "description": {
            "description": "Human-readable description.",
            "type": "string"
          },
          "is_active": {
            "description": "Is active.",
            "type": "boolean"
          },
          "capabilities": {
            "description": "Capabilities.",
            "type": "array",
            "items": {
              "description": "Capabilities item.",
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          }
        },
        "required": [
          "name"
        ]
      },
      "getAdminAdministrativeRoleAssignmentByAssignmentIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "role_id": {
            "type": "string",
            "description": "Role id identifier."
          },
          "role_name": {
            "type": "string",
            "description": "Role name."
          },
          "user_id": {
            "type": "string",
            "description": "User id identifier."
          },
          "username": {
            "type": "string",
            "description": "Account username, normally including the configured domain."
          },
          "is_global": {
            "type": "boolean",
            "description": "Is global."
          },
          "tenant_ids": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Tenant ids."
          },
          "tenants": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                }
              },
              "required": [
                "id",
                "name"
              ]
            },
            "description": "Tenants."
          }
        },
        "required": [
          "id",
          "role_id",
          "role_name",
          "user_id",
          "username",
          "is_global",
          "tenant_ids",
          "tenants"
        ]
      },
      "getAdminAdministrativeRoleAssignmentResult": {
        "type": "object",
        "properties": {
          "assignments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "role_id": {
                  "type": "string",
                  "description": "Role id identifier."
                },
                "role_name": {
                  "type": "string",
                  "description": "Role name."
                },
                "user_id": {
                  "type": "string",
                  "description": "User id identifier."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "is_global": {
                  "type": "boolean",
                  "description": "Is global."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "description": "Tenant ids."
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name."
                      }
                    },
                    "required": [
                      "id",
                      "name"
                    ]
                  },
                  "description": "Tenants."
                }
              },
              "required": [
                "id",
                "role_id",
                "role_name",
                "user_id",
                "username",
                "is_global",
                "tenant_ids",
                "tenants"
              ]
            },
            "description": "Assignments."
          }
        },
        "required": [
          "assignments"
        ]
      },
      "CreateAdministrativeRoleAssignment": {
        "type": "object",
        "properties": {
          "assignment_id": {
            "description": "Assignment id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "role_id": {
            "description": "Role id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "description": "User id identifier.",
            "type": "string",
            "format": "uuid"
          },
          "is_global": {
            "description": "Is global.",
            "type": "boolean"
          },
          "tenant_ids": {
            "description": "Tenant ids.",
            "type": "array",
            "items": {
              "description": "Tenant ids item.",
              "type": "string",
              "format": "uuid"
            }
          }
        },
        "x-psono-validation-errors": [
          "ADMINISTRATIVE_ROLE_ASSIGNMENT_ALREADY_EXISTS",
          "DUPLICATE_TENANT",
          "GLOBAL_ASSIGNMENT_HAS_TENANTS",
          "NO_PERMISSION_OR_NOT_EXIST",
          "ROLE_AND_USER_REQUIRED",
          "ROLE_REQUIRES_GLOBAL_SCOPE",
          "TENANT_NOT_EXIST",
          "TENANT_REQUIRED"
        ],
        "required": [
          "role_id",
          "user_id"
        ],
        "description": "Set is_global=true without tenant_ids, or provide a nonempty tenant_ids list for a tenant-scoped role. Global-only capabilities require global scope."
      },
      "getAdminUserByUserIdResultEnterprise": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "username": {
            "type": "string",
            "description": "Account username, normally including the configured domain."
          },
          "server_secret_exists": {
            "type": "boolean",
            "description": "Server secret exists."
          },
          "is_managed": {
            "type": "boolean",
            "description": "Is managed."
          },
          "admin_recovery_exists": {
            "type": "boolean",
            "description": "Admin recovery exists."
          },
          "db_secret_exists": {
            "type": "boolean",
            "description": "Db secret exists."
          },
          "email": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "example": ""
              }
            ],
            "description": "Email address."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "last_login": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Last login."
          },
          "public_key": {
            "type": "string",
            "description": "Hex-encoded public key."
          },
          "is_active": {
            "type": "boolean",
            "description": "Is active."
          },
          "is_email_active": {
            "type": "boolean",
            "description": "Is email active."
          },
          "is_superuser": {
            "type": "boolean",
            "description": "Is superuser."
          },
          "is_staff": {
            "type": "boolean",
            "description": "Is staff."
          },
          "require_password_change": {
            "type": "boolean",
            "description": "Require password change."
          },
          "language": {
            "type": "string",
            "description": "Language."
          },
          "authentication": {
            "type": "string",
            "description": "Authentication."
          },
          "duos": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                }
              },
              "required": [
                "id",
                "title",
                "create_date",
                "active"
              ]
            },
            "description": "Duos."
          },
          "google_authenticators": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                }
              },
              "required": [
                "id",
                "title",
                "create_date",
                "active"
              ]
            },
            "description": "Google authenticators."
          },
          "yubikey_otps": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                }
              },
              "required": [
                "id",
                "title",
                "create_date",
                "active"
              ]
            },
            "description": "Yubikey otps."
          },
          "webauthns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                }
              },
              "required": [
                "id",
                "title",
                "create_date",
                "active"
              ]
            },
            "description": "Webauthns."
          },
          "ivalts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "mobile": {
                  "type": "string",
                  "description": "Mobile."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                }
              },
              "required": [
                "id",
                "mobile",
                "create_date",
                "active"
              ]
            },
            "description": "Ivalts."
          },
          "link_shares": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "public_title": {
                  "type": "string",
                  "description": "Public title."
                },
                "allowed_reads": {
                  "type": "integer",
                  "description": "Allowed reads."
                },
                "valid_till": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Expiration time in ISO 8601 format."
                },
                "has_passphrase": {
                  "type": "boolean",
                  "description": "Has passphrase."
                }
              },
              "required": [
                "id",
                "create_date",
                "public_title",
                "allowed_reads",
                "valid_till",
                "has_passphrase"
              ]
            },
            "description": "Link shares."
          },
          "share_rights": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "grant": {
                  "type": "boolean",
                  "description": "Whether the recipient may grant access to others."
                },
                "accepted": {
                  "type": [
                    "boolean",
                    "null"
                  ],
                  "description": "Whether the invitation/right has been accepted."
                },
                "share_id": {
                  "type": "string",
                  "description": "Share id identifier."
                }
              },
              "required": [
                "id",
                "create_date",
                "read",
                "write",
                "grant",
                "accepted",
                "share_id"
              ]
            },
            "description": "Share rights."
          },
          "tenant_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Tenant ids."
          },
          "memberships": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "accepted": {
                  "type": [
                    "boolean",
                    "null"
                  ],
                  "description": "Whether the invitation/right has been accepted."
                },
                "admin": {
                  "type": "boolean",
                  "description": "Admin."
                },
                "group_id": {
                  "type": "string",
                  "description": "Group id identifier."
                },
                "group_name": {
                  "type": "string",
                  "description": "Group name."
                },
                "share_admin": {
                  "type": "boolean",
                  "description": "Share admin."
                }
              },
              "required": [
                "id",
                "create_date",
                "accepted",
                "admin",
                "group_id",
                "group_name",
                "share_admin"
              ]
            },
            "description": "Memberships."
          },
          "recovery_codes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                }
              },
              "required": [
                "id",
                "create_date"
              ]
            },
            "description": "Recovery codes."
          },
          "emergency_codes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "description": {
                  "type": "string",
                  "description": "Human-readable description."
                },
                "activation_delay": {
                  "type": "integer",
                  "description": "Activation delay."
                }
              },
              "required": [
                "id",
                "create_date",
                "description",
                "activation_delay"
              ]
            },
            "description": "Emergency codes."
          },
          "sessions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "valid_till": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Expiration time in ISO 8601 format."
                },
                "device_description": {
                  "type": "string",
                  "description": "Human-readable description of the client device."
                },
                "device_fingerprint": {
                  "type": "string",
                  "description": "Client device/session fingerprint used by device protection."
                }
              },
              "required": [
                "id",
                "create_date",
                "active",
                "valid_till",
                "device_description",
                "device_fingerprint"
              ]
            },
            "description": "Sessions."
          }
        },
        "required": [
          "id",
          "username",
          "server_secret_exists",
          "is_managed",
          "admin_recovery_exists",
          "db_secret_exists",
          "email",
          "create_date",
          "last_login",
          "public_key",
          "is_active",
          "is_email_active",
          "is_superuser",
          "is_staff",
          "require_password_change",
          "language",
          "authentication",
          "duos",
          "google_authenticators",
          "yubikey_otps",
          "webauthns",
          "ivalts",
          "link_shares",
          "share_rights",
          "tenant_ids"
        ]
      },
      "getAdminUserResultEnterprise": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "users": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "last_login": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last login."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "roles": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "user"
                  },
                  "description": "Roles."
                },
                "is_active": {
                  "type": "boolean",
                  "description": "Is active."
                },
                "is_email_active": {
                  "type": "boolean",
                  "description": "Is email active."
                },
                "duo_enabled": {
                  "type": "boolean",
                  "description": "Duo enabled."
                },
                "google_authenticator_enabled": {
                  "type": "boolean",
                  "description": "Google authenticator enabled."
                },
                "webauthn_enabled": {
                  "type": "boolean",
                  "description": "Webauthn enabled."
                },
                "yubikey_otp_enabled": {
                  "type": "boolean",
                  "description": "Yubikey otp enabled."
                },
                "require_password_change": {
                  "type": "boolean",
                  "description": "Require password change."
                },
                "recovery_code_exist": {
                  "type": "boolean",
                  "description": "Recovery code exist."
                },
                "emergency_code_exist": {
                  "type": "boolean",
                  "description": "Emergency code exist."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Tenant ids."
                }
              },
              "required": [
                "id",
                "create_date",
                "last_login",
                "username",
                "roles",
                "is_active",
                "is_email_active",
                "duo_enabled",
                "google_authenticator_enabled",
                "webauthn_enabled",
                "yubikey_otp_enabled",
                "require_password_change",
                "recovery_code_exist",
                "emergency_code_exist",
                "tenant_ids"
              ]
            },
            "description": "Users."
          }
        },
        "required": [
          "count",
          "users"
        ]
      },
      "getAdminSecurityReportBySecurityReportIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "username": {
            "type": "string",
            "description": "Account username, normally including the configured domain."
          },
          "recovery_code_exists": {
            "type": "boolean",
            "description": "Recovery code exists."
          },
          "two_factor_exists": {
            "type": "boolean",
            "description": "Two factor exists."
          },
          "website_password_count": {
            "type": "integer",
            "description": "Website password count."
          },
          "breached_password_count": {
            "type": "integer",
            "description": "Breached password count."
          },
          "duplicate_password_count": {
            "type": "integer",
            "description": "Duplicate password count."
          },
          "check_haveibeenpwned": {
            "type": "boolean",
            "description": "Check haveibeenpwned."
          },
          "master_password_breached": {
            "type": "boolean",
            "description": "Master password breached."
          },
          "master_password_duplicate": {
            "type": "boolean",
            "description": "Master password duplicate."
          },
          "master_password_length": {
            "type": "integer",
            "description": "Master password length."
          },
          "master_password_variation_count": {
            "type": "integer",
            "description": "Master password variation count."
          },
          "entries": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                },
                "type": {
                  "type": "string",
                  "description": "Type."
                },
                "create_age": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Create age."
                },
                "write_age": {
                  "anyOf": [
                    {
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "Write age."
                },
                "master_password": {
                  "type": "boolean",
                  "description": "Master password."
                },
                "breached": {
                  "type": "boolean",
                  "description": "Breached."
                },
                "duplicate": {
                  "type": "boolean",
                  "description": "Duplicate."
                },
                "password_length": {
                  "type": "integer",
                  "description": "Password length."
                },
                "variation_count": {
                  "type": "integer",
                  "description": "Variation count."
                }
              },
              "required": [
                "id",
                "name",
                "type",
                "create_age",
                "write_age",
                "master_password",
                "breached",
                "duplicate",
                "password_length",
                "variation_count"
              ]
            },
            "description": "Entries."
          }
        },
        "required": [
          "id",
          "create_date",
          "username",
          "recovery_code_exists",
          "two_factor_exists",
          "website_password_count",
          "breached_password_count",
          "duplicate_password_count",
          "check_haveibeenpwned",
          "master_password_breached",
          "master_password_duplicate",
          "master_password_length",
          "master_password_variation_count",
          "entries"
        ]
      },
      "getAdminSecurityReportResult": {
        "type": "object",
        "properties": {
          "security_reports": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "recovery_code_exists": {
                  "type": "boolean",
                  "description": "Recovery code exists."
                },
                "two_factor_exists": {
                  "type": "boolean",
                  "description": "Two factor exists."
                },
                "website_password_count": {
                  "type": "integer",
                  "description": "Website password count."
                },
                "breached_password_count": {
                  "type": "integer",
                  "description": "Breached password count."
                },
                "duplicate_password_count": {
                  "type": "integer",
                  "description": "Duplicate password count."
                },
                "check_haveibeenpwned": {
                  "type": "boolean",
                  "description": "Check haveibeenpwned."
                },
                "master_password_breached": {
                  "type": "boolean",
                  "description": "Master password breached."
                },
                "master_password_duplicate": {
                  "type": "boolean",
                  "description": "Master password duplicate."
                },
                "master_password_length": {
                  "type": "integer",
                  "description": "Master password length."
                },
                "master_password_variation_count": {
                  "type": "integer",
                  "description": "Master password variation count."
                }
              },
              "required": [
                "id",
                "create_date",
                "username",
                "recovery_code_exists",
                "two_factor_exists",
                "website_password_count",
                "breached_password_count",
                "duplicate_password_count",
                "check_haveibeenpwned",
                "master_password_breached",
                "master_password_duplicate",
                "master_password_length",
                "master_password_variation_count"
              ]
            },
            "description": "Security reports."
          },
          "user_count": {
            "type": "integer",
            "description": "User count."
          },
          "users_missing_reports": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                }
              },
              "required": [
                "id",
                "create_date",
                "username"
              ]
            },
            "description": "Users missing reports."
          }
        },
        "required": [
          "security_reports",
          "user_count",
          "users_missing_reports"
        ]
      },
      "getAdminGroupByGroupIdResultEnterprise": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "name": {
            "type": "string",
            "description": "Display name."
          },
          "is_managed": {
            "type": "boolean",
            "description": "Is managed."
          },
          "admin_recovery_exists": {
            "type": "boolean",
            "description": "Admin recovery exists."
          },
          "db_secret_exists": {
            "type": "boolean",
            "description": "Db secret exists."
          },
          "forced_membership": {
            "type": "boolean",
            "description": "Forced membership."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "public_key": {
            "type": "string",
            "description": "Hex-encoded public key."
          },
          "group_user_secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "user_id": {
                  "type": "string",
                  "description": "User id identifier."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                }
              },
              "required": [
                "id",
                "create_date",
                "user_id",
                "username"
              ]
            },
            "description": "Group user secrets."
          },
          "own_group_user_secret": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Id identifier."
              },
              "secret_key": {
                "type": "string",
                "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
              },
              "secret_key_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for secret key."
              },
              "secret_key_type": {
                "type": "string",
                "description": "Secret key type."
              },
              "private_key": {
                "type": "string",
                "description": "Encrypted private key; never send an unencrypted vault private key here."
              },
              "private_key_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for private key."
              },
              "private_key_type": {
                "type": "string",
                "description": "Private key type."
              }
            },
            "required": [
              "id",
              "secret_key",
              "secret_key_nonce",
              "secret_key_type",
              "private_key",
              "private_key_nonce",
              "private_key_type"
            ],
            "description": "Own group user secret."
          },
          "share_rights": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "grant": {
                  "type": "boolean",
                  "description": "Whether the recipient may grant access to others."
                },
                "share_id": {
                  "type": "string",
                  "description": "Share id identifier."
                },
                "share_title": {
                  "type": "string",
                  "description": "Share title."
                },
                "share_type": {
                  "type": "string",
                  "description": "Share type."
                },
                "share_title_encrypted": {
                  "type": "string",
                  "description": "Share title encrypted."
                },
                "share_title_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for share title."
                },
                "share_type_encrypted": {
                  "type": "string",
                  "description": "Share type encrypted."
                },
                "share_type_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for share type."
                }
              },
              "required": [
                "id",
                "create_date",
                "read",
                "write",
                "grant",
                "share_id",
                "share_title",
                "share_type",
                "share_title_encrypted",
                "share_title_nonce",
                "share_type_encrypted",
                "share_type_nonce"
              ]
            },
            "description": "Share rights."
          },
          "ldap_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "ldap_group_map_id": {
                  "type": "string",
                  "description": "Ldap group map id identifier."
                },
                "ldap_group_id": {
                  "type": "string",
                  "description": "Ldap group id identifier."
                },
                "group_admin": {
                  "type": "boolean",
                  "description": "Group admin."
                },
                "share_admin": {
                  "type": "boolean",
                  "description": "Share admin."
                }
              },
              "required": [
                "ldap_group_map_id",
                "ldap_group_id",
                "group_admin",
                "share_admin"
              ]
            },
            "description": "Ldap groups."
          },
          "saml_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "saml_group_map_id": {
                  "type": "string",
                  "description": "Saml group map id identifier."
                },
                "saml_group_id": {
                  "type": "string",
                  "description": "Saml group id identifier."
                },
                "group_admin": {
                  "type": "boolean",
                  "description": "Group admin."
                },
                "share_admin": {
                  "type": "boolean",
                  "description": "Share admin."
                }
              },
              "required": [
                "saml_group_map_id",
                "saml_group_id",
                "group_admin",
                "share_admin"
              ]
            },
            "description": "Saml groups."
          },
          "oidc_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "oidc_group_map_id": {
                  "type": "string",
                  "description": "Oidc group map id identifier."
                },
                "oidc_group_id": {
                  "type": "string",
                  "description": "Oidc group id identifier."
                },
                "group_admin": {
                  "type": "boolean",
                  "description": "Group admin."
                },
                "share_admin": {
                  "type": "boolean",
                  "description": "Share admin."
                }
              },
              "required": [
                "oidc_group_map_id",
                "oidc_group_id",
                "group_admin",
                "share_admin"
              ]
            },
            "description": "Oidc groups."
          },
          "scim_groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "scim_group_map_id": {
                  "type": "string",
                  "description": "Scim group map id identifier."
                },
                "scim_group_id": {
                  "type": "string",
                  "description": "Scim group id identifier."
                },
                "group_admin": {
                  "type": "boolean",
                  "description": "Group admin."
                },
                "share_admin": {
                  "type": "boolean",
                  "description": "Share admin."
                }
              },
              "required": [
                "scim_group_map_id",
                "scim_group_id",
                "group_admin",
                "share_admin"
              ]
            },
            "description": "Scim groups."
          },
          "tenant_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Tenant ids."
          },
          "memberships": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "accepted": {
                  "type": [
                    "boolean",
                    "null"
                  ],
                  "description": "Whether the invitation/right has been accepted."
                },
                "admin": {
                  "type": "boolean",
                  "description": "Admin."
                },
                "share_admin": {
                  "type": "boolean",
                  "description": "Share admin."
                },
                "user_id": {
                  "type": "string",
                  "description": "User id identifier."
                },
                "username": {
                  "type": "string",
                  "description": "Account username, normally including the configured domain."
                },
                "private_key_is_null": {
                  "type": "boolean",
                  "description": "Private key is null."
                },
                "secret_key_is_null": {
                  "type": "boolean",
                  "description": "Secret key is null."
                }
              },
              "required": [
                "id",
                "create_date",
                "accepted",
                "admin",
                "share_admin",
                "user_id",
                "username",
                "private_key_is_null",
                "secret_key_is_null"
              ]
            },
            "description": "Memberships."
          }
        },
        "required": [
          "id",
          "name",
          "is_managed",
          "admin_recovery_exists",
          "db_secret_exists",
          "forced_membership",
          "create_date",
          "public_key",
          "group_user_secrets",
          "own_group_user_secret",
          "share_rights",
          "ldap_groups",
          "saml_groups",
          "oidc_groups",
          "scim_groups",
          "tenant_ids"
        ]
      },
      "getAdminGroupResultEnterprise": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "name": {
                  "type": "string",
                  "description": "Display name."
                },
                "member_count": {
                  "type": "integer",
                  "description": "Member count."
                },
                "is_managed": {
                  "type": "boolean",
                  "description": "Is managed."
                },
                "has_active_user_key_copies": {
                  "type": "boolean",
                  "description": "Has active user key copies."
                },
                "admin_recovery_exists": {
                  "type": "boolean",
                  "description": "Admin recovery exists."
                },
                "tenant_ids": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Tenant ids."
                }
              },
              "required": [
                "id",
                "create_date",
                "name",
                "member_count",
                "is_managed",
                "has_active_user_key_copies",
                "admin_recovery_exists",
                "tenant_ids"
              ]
            },
            "description": "Groups."
          }
        },
        "required": [
          "count",
          "groups"
        ]
      },
      "getAdminFileserverClusterByClusterIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "write_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Last write time in ISO 8601 format."
          },
          "title": {
            "type": "string",
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
          },
          "file_size_limit": {
            "type": "integer",
            "description": "File size limit."
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "cluster_id": {
                  "type": "string",
                  "description": "Cluster id identifier."
                },
                "cluster_title": {
                  "type": "string",
                  "description": "Cluster title."
                },
                "shard_id": {
                  "type": "string",
                  "description": "Shard id identifier."
                },
                "shard_title": {
                  "type": "string",
                  "description": "Shard title."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "delete_capability": {
                  "type": "boolean",
                  "description": "Delete capability."
                },
                "allow_link_shares": {
                  "type": "boolean",
                  "description": "Allow link shares."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "cluster_id",
                "cluster_title",
                "shard_id",
                "shard_title",
                "read",
                "write",
                "delete_capability",
                "allow_link_shares"
              ]
            },
            "description": "Links."
          },
          "fileservers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "create_ip": {
                  "type": "string",
                  "description": "Create ip."
                },
                "cluster_id": {
                  "type": "string",
                  "description": "Cluster id identifier."
                },
                "cluster_title": {
                  "type": "string",
                  "description": "Cluster title."
                },
                "public_key": {
                  "type": "string",
                  "description": "Hex-encoded public key."
                },
                "url": {
                  "type": "string",
                  "description": "Url."
                },
                "version": {
                  "type": "string",
                  "description": "Version."
                },
                "hostname": {
                  "type": "string",
                  "description": "Hostname."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "delete_capability": {
                  "type": "boolean",
                  "description": "Delete capability."
                },
                "allow_link_shares": {
                  "type": "boolean",
                  "description": "Allow link shares."
                },
                "valid_till": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Expiration time in ISO 8601 format."
                },
                "alive": {
                  "type": "boolean",
                  "description": "Alive."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "create_ip",
                "cluster_id",
                "cluster_title",
                "public_key",
                "url",
                "version",
                "hostname",
                "read",
                "write",
                "delete_capability",
                "allow_link_shares",
                "valid_till",
                "alive"
              ]
            },
            "description": "Fileservers."
          }
        },
        "required": [
          "id",
          "create_date",
          "write_date",
          "title",
          "file_size_limit",
          "links",
          "fileservers"
        ]
      },
      "getAdminFileserverClusterResult": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "clusters": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "file_size_limit": {
                  "type": "integer",
                  "description": "File size limit."
                },
                "shard_count": {
                  "type": "integer",
                  "description": "Shard count."
                },
                "member_count": {
                  "type": "integer",
                  "description": "Member count."
                },
                "live_member_count": {
                  "type": "integer",
                  "description": "Live member count."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "title",
                "file_size_limit",
                "shard_count",
                "member_count",
                "live_member_count"
              ]
            },
            "description": "Clusters."
          }
        },
        "required": [
          "count",
          "clusters"
        ]
      },
      "getAdminFileserverShardByShardIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "write_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Last write time in ISO 8601 format."
          },
          "title": {
            "type": "string",
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
          },
          "description": {
            "type": "string",
            "description": "Human-readable description."
          },
          "active": {
            "type": "boolean",
            "description": "Whether the resource or account is active."
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "cluster_id": {
                  "type": "string",
                  "description": "Cluster id identifier."
                },
                "cluster_title": {
                  "type": "string",
                  "description": "Cluster title."
                },
                "shard_id": {
                  "type": "string",
                  "description": "Shard id identifier."
                },
                "shard_title": {
                  "type": "string",
                  "description": "Shard title."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "delete_capability": {
                  "type": "boolean",
                  "description": "Delete capability."
                },
                "allow_link_shares": {
                  "type": "boolean",
                  "description": "Allow link shares."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "cluster_id",
                "cluster_title",
                "shard_id",
                "shard_title",
                "read",
                "write",
                "delete_capability",
                "allow_link_shares"
              ]
            },
            "description": "Links."
          }
        },
        "required": [
          "id",
          "create_date",
          "write_date",
          "title",
          "description",
          "active",
          "links"
        ]
      },
      "getAdminFileserverShardResult": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "shards": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "description": {
                  "type": "string",
                  "description": "Human-readable description."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "cluster_count": {
                  "type": "integer",
                  "description": "Cluster count."
                },
                "member_count": {
                  "type": "integer",
                  "description": "Member count."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "title",
                "description",
                "active",
                "cluster_count",
                "member_count"
              ]
            },
            "description": "Shards."
          }
        },
        "required": [
          "count",
          "shards"
        ]
      },
      "getAdminFileserverByFileserverIdResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "write_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Last write time in ISO 8601 format."
          },
          "create_ip": {
            "type": "string",
            "description": "Create ip."
          },
          "cluster_id": {
            "type": "string",
            "description": "Cluster id identifier."
          },
          "cluster_title": {
            "type": "string",
            "description": "Cluster title."
          },
          "public_key": {
            "type": "string",
            "description": "Hex-encoded public key."
          },
          "url": {
            "type": "string",
            "description": "Url."
          },
          "version": {
            "type": "string",
            "description": "Version."
          },
          "hostname": {
            "type": "string",
            "description": "Hostname."
          },
          "read": {
            "type": "boolean",
            "description": "Whether read access is granted."
          },
          "write": {
            "type": "boolean",
            "description": "Whether write access is granted."
          },
          "delete_capability": {
            "type": "boolean",
            "description": "Delete capability."
          },
          "allow_link_shares": {
            "type": "boolean",
            "description": "Allow link shares."
          },
          "valid_till": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Expiration time in ISO 8601 format."
          },
          "alive": {
            "type": "boolean",
            "description": "Alive."
          },
          "shards": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "shard_id": {
                  "type": "string",
                  "description": "Shard id identifier."
                },
                "shard_title": {
                  "type": "string",
                  "description": "Shard title."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "delete_capability": {
                  "type": "boolean",
                  "description": "Delete capability."
                },
                "allow_link_shares": {
                  "type": "boolean",
                  "description": "Allow link shares."
                },
                "ip_read_whitelist": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Ip read whitelist."
                },
                "ip_read_blacklist": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Ip read blacklist."
                },
                "ip_write_whitelist": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Ip write whitelist."
                },
                "ip_write_blacklist": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Ip write blacklist."
                }
              },
              "required": [
                "id",
                "shard_id",
                "shard_title",
                "read",
                "write",
                "delete_capability",
                "allow_link_shares",
                "ip_read_whitelist",
                "ip_read_blacklist",
                "ip_write_whitelist",
                "ip_write_blacklist"
              ]
            },
            "description": "Shards."
          }
        },
        "required": [
          "id",
          "create_date",
          "write_date",
          "create_ip",
          "cluster_id",
          "cluster_title",
          "public_key",
          "url",
          "version",
          "hostname",
          "read",
          "write",
          "delete_capability",
          "allow_link_shares",
          "valid_till",
          "alive"
        ]
      },
      "getAdminFileserverResult": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "fileservers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "create_ip": {
                  "type": "string",
                  "description": "Create ip."
                },
                "cluster_id": {
                  "type": "string",
                  "description": "Cluster id identifier."
                },
                "cluster_title": {
                  "type": "string",
                  "description": "Cluster title."
                },
                "public_key": {
                  "type": "string",
                  "description": "Hex-encoded public key."
                },
                "url": {
                  "type": "string",
                  "description": "Url."
                },
                "version": {
                  "type": "string",
                  "description": "Version."
                },
                "hostname": {
                  "type": "string",
                  "description": "Hostname."
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether read access is granted."
                },
                "write": {
                  "type": "boolean",
                  "description": "Whether write access is granted."
                },
                "delete_capability": {
                  "type": "boolean",
                  "description": "Delete capability."
                },
                "allow_link_shares": {
                  "type": "boolean",
                  "description": "Allow link shares."
                },
                "valid_till": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Expiration time in ISO 8601 format."
                },
                "alive": {
                  "type": "boolean",
                  "description": "Alive."
                },
                "shards": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Id identifier."
                      },
                      "shard_id": {
                        "type": "string",
                        "description": "Shard id identifier."
                      },
                      "shard_title": {
                        "type": "string",
                        "description": "Shard title."
                      },
                      "read": {
                        "type": "boolean",
                        "description": "Whether read access is granted."
                      },
                      "write": {
                        "type": "boolean",
                        "description": "Whether write access is granted."
                      },
                      "delete_capability": {
                        "type": "boolean",
                        "description": "Delete capability."
                      },
                      "allow_link_shares": {
                        "type": "boolean",
                        "description": "Allow link shares."
                      },
                      "ip_read_whitelist": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Ip read whitelist."
                      },
                      "ip_read_blacklist": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Ip read blacklist."
                      },
                      "ip_write_whitelist": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Ip write whitelist."
                      },
                      "ip_write_blacklist": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Ip write blacklist."
                      }
                    },
                    "required": [
                      "id",
                      "shard_id",
                      "shard_title",
                      "read",
                      "write",
                      "delete_capability",
                      "allow_link_shares",
                      "ip_read_whitelist",
                      "ip_read_blacklist",
                      "ip_write_whitelist",
                      "ip_write_blacklist"
                    ]
                  },
                  "description": "Shards."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "create_ip",
                "cluster_id",
                "cluster_title",
                "public_key",
                "url",
                "version",
                "hostname",
                "read",
                "write",
                "delete_capability",
                "allow_link_shares",
                "valid_till",
                "alive"
              ]
            },
            "description": "Fileservers."
          }
        },
        "required": [
          "count",
          "fileservers"
        ]
      },
      "getAdminPolicyByPolicyIdResultEnterprise": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "title": {
            "type": "string",
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
          },
          "priority": {
            "type": "integer",
            "description": "Priority."
          },
          "config": {
            "type": "object",
            "additionalProperties": true,
            "description": "Config."
          },
          "policy_group_mappings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": "string",
                  "description": "Creation time in ISO 8601 format."
                },
                "group_name": {
                  "type": "string",
                  "description": "Group name."
                }
              },
              "required": [
                "id",
                "create_date",
                "group_name"
              ]
            },
            "description": "Policy group mappings."
          },
          "policy_user_mappings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": "string",
                  "description": "Creation time in ISO 8601 format."
                },
                "user_username": {
                  "type": "string",
                  "description": "User username."
                }
              },
              "required": [
                "id",
                "create_date",
                "user_username"
              ]
            },
            "description": "Policy user mappings."
          },
          "default_values": {
            "type": "object",
            "additionalProperties": true,
            "description": "Effective server defaults keyed by setting name. Value types follow the configuration setting (booleans, durations, strings, or lists)."
          }
        },
        "required": [
          "id",
          "title",
          "priority",
          "config",
          "policy_group_mappings",
          "policy_user_mappings",
          "default_values"
        ]
      },
      "getAdminPolicyResultEnterprise": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "policies": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "priority": {
                  "type": "integer",
                  "description": "Priority."
                },
                "create_date": {
                  "type": "string",
                  "description": "Creation time in ISO 8601 format."
                }
              },
              "required": [
                "id",
                "title",
                "priority",
                "create_date"
              ]
            },
            "description": "Policies."
          }
        },
        "required": [
          "count",
          "policies"
        ]
      },
      "getAdminGatewayClusterByClusterIdResultEnterprise": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "write_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Last write time in ISO 8601 format."
          },
          "title": {
            "type": "string",
            "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
          },
          "allow_all": {
            "type": "boolean",
            "description": "Allow all."
          },
          "gateway_cluster_user_mappings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "mapping_id": {
                  "type": "string",
                  "description": "Mapping id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "user_username": {
                  "type": "string",
                  "description": "User username."
                }
              },
              "required": [
                "id",
                "mapping_id",
                "create_date",
                "user_username"
              ]
            },
            "description": "Gateway cluster user mappings."
          },
          "gateway_cluster_group_mappings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "mapping_id": {
                  "type": "string",
                  "description": "Mapping id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "group_name": {
                  "type": "string",
                  "description": "Group name."
                }
              },
              "required": [
                "id",
                "mapping_id",
                "create_date",
                "group_name"
              ]
            },
            "description": "Gateway cluster group mappings."
          },
          "gateways": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "create_ip": {
                  "type": "string",
                  "description": "Create ip."
                },
                "cluster_id": {
                  "type": "string",
                  "description": "Cluster id identifier."
                },
                "cluster_title": {
                  "type": "string",
                  "description": "Cluster title."
                },
                "public_key": {
                  "type": "string",
                  "description": "Hex-encoded public key."
                },
                "url": {
                  "type": "string",
                  "description": "Url."
                },
                "version": {
                  "type": "string",
                  "description": "Version."
                },
                "hostname": {
                  "type": "string",
                  "description": "Hostname."
                },
                "valid_till": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Expiration time in ISO 8601 format."
                },
                "alive": {
                  "type": "boolean",
                  "description": "Alive."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "create_ip",
                "cluster_id",
                "cluster_title",
                "public_key",
                "url",
                "version",
                "hostname",
                "valid_till",
                "alive"
              ]
            },
            "description": "Gateways."
          }
        },
        "required": [
          "id",
          "create_date",
          "write_date",
          "title",
          "allow_all",
          "gateway_cluster_user_mappings",
          "gateway_cluster_group_mappings",
          "gateways"
        ]
      },
      "getAdminGatewayClusterResultEnterprise": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "clusters": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                },
                "allow_all": {
                  "type": "boolean",
                  "description": "Allow all."
                },
                "member_count": {
                  "type": "integer",
                  "description": "Member count."
                },
                "user_mapping_count": {
                  "type": "integer",
                  "description": "User mapping count."
                },
                "group_mapping_count": {
                  "type": "integer",
                  "description": "Group mapping count."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "title",
                "allow_all",
                "member_count",
                "user_mapping_count",
                "group_mapping_count"
              ]
            },
            "description": "Clusters."
          }
        },
        "required": [
          "count",
          "clusters"
        ]
      },
      "getAdminGatewayByGatewayIdResultEnterprise": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "create_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Creation time in ISO 8601 format."
          },
          "write_date": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Last write time in ISO 8601 format."
          },
          "create_ip": {
            "type": "string",
            "description": "Create ip."
          },
          "cluster_id": {
            "type": "string",
            "description": "Cluster id identifier."
          },
          "cluster_title": {
            "type": "string",
            "description": "Cluster title."
          },
          "public_key": {
            "type": "string",
            "description": "Hex-encoded public key."
          },
          "url": {
            "type": "string",
            "description": "Url."
          },
          "version": {
            "type": "string",
            "description": "Version."
          },
          "hostname": {
            "type": "string",
            "description": "Hostname."
          },
          "valid_till": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Expiration time in ISO 8601 format."
          },
          "alive": {
            "type": "boolean",
            "description": "Alive."
          }
        },
        "required": [
          "id",
          "create_date",
          "write_date",
          "create_ip",
          "cluster_id",
          "cluster_title",
          "public_key",
          "url",
          "version",
          "hostname",
          "valid_till",
          "alive"
        ]
      },
      "getAdminGatewayResultEnterprise": {
        "type": "object",
        "properties": {
          "count": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of records requested/returned; see the operation pagination rules."
          },
          "gateways": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "create_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Creation time in ISO 8601 format."
                },
                "write_date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Last write time in ISO 8601 format."
                },
                "create_ip": {
                  "type": "string",
                  "description": "Create ip."
                },
                "cluster_id": {
                  "type": "string",
                  "description": "Cluster id identifier."
                },
                "cluster_title": {
                  "type": "string",
                  "description": "Cluster title."
                },
                "public_key": {
                  "type": "string",
                  "description": "Hex-encoded public key."
                },
                "url": {
                  "type": "string",
                  "description": "Url."
                },
                "version": {
                  "type": "string",
                  "description": "Version."
                },
                "hostname": {
                  "type": "string",
                  "description": "Hostname."
                },
                "valid_till": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "Expiration time in ISO 8601 format."
                },
                "alive": {
                  "type": "boolean",
                  "description": "Alive."
                }
              },
              "required": [
                "id",
                "create_date",
                "write_date",
                "create_ip",
                "cluster_id",
                "cluster_title",
                "public_key",
                "url",
                "version",
                "hostname",
                "valid_till",
                "alive"
              ]
            },
            "description": "Gateways."
          }
        },
        "required": [
          "count",
          "gateways"
        ]
      },
      "UploadTransferTicket": {
        "type": "object",
        "properties": {
          "hash_checksum": {
            "type": "string",
            "description": "Blake2b chunk checksum in hex."
          },
          "chunk_position": {
            "type": "integer",
            "description": "Chunk position."
          }
        },
        "required": [
          "hash_checksum",
          "chunk_position"
        ]
      },
      "DownloadTransferTicket": {
        "type": "object",
        "properties": {
          "hash_checksum": {
            "type": "string",
            "description": "Blake2b chunk checksum in hex."
          }
        },
        "required": [
          "hash_checksum"
        ]
      },
      "EnterprisePendingJobs": {
        "type": "object",
        "properties": {
          "memberships_missing_group_secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "group_id": {
                  "type": "string",
                  "description": "Group id identifier."
                },
                "public_key": {
                  "type": "string",
                  "description": "Hex-encoded public key."
                },
                "secret_key": {
                  "type": "string",
                  "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
                },
                "secret_key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for secret key."
                },
                "secret_key_type": {
                  "type": "string",
                  "description": "Secret key type."
                },
                "private_key": {
                  "type": "string",
                  "description": "Encrypted private key; never send an unencrypted vault private key here."
                },
                "private_key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for private key."
                },
                "private_key_type": {
                  "type": "string",
                  "description": "Private key type."
                },
                "missing_user_membership_id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Missing user membership id identifier."
                },
                "missing_user_user_id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Missing user user id identifier."
                },
                "missing_user_public_key": {
                  "type": "string",
                  "description": "Missing user public key."
                }
              }
            },
            "description": "Memberships missing group secrets."
          },
          "staff_missing_group_secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "group_id": {
                  "type": "string",
                  "description": "Group id identifier."
                },
                "public_key": {
                  "type": "string",
                  "description": "Hex-encoded public key."
                },
                "secret_key": {
                  "type": "string",
                  "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
                },
                "secret_key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for secret key."
                },
                "secret_key_type": {
                  "type": "string",
                  "description": "Secret key type."
                },
                "private_key": {
                  "type": "string",
                  "description": "Encrypted private key; never send an unencrypted vault private key here."
                },
                "private_key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for private key."
                },
                "private_key_type": {
                  "type": "string",
                  "description": "Private key type."
                },
                "missing_user_user_id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Missing user user id identifier."
                },
                "missing_user_public_key": {
                  "type": "string",
                  "description": "Missing user public key."
                }
              }
            },
            "description": "Staff missing group secrets."
          },
          "users_missing_admin_secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {}
            },
            "description": "Users missing admin secrets."
          },
          "groups_missing_admin_secrets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "group_id": {
                  "type": "string",
                  "description": "Group id identifier."
                },
                "public_key": {
                  "type": "string",
                  "description": "Hex-encoded public key."
                },
                "secret_key": {
                  "type": "string",
                  "description": "Symmetric key material, wrapped/encrypted as specified by this operation."
                },
                "secret_key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for secret key."
                },
                "secret_key_type": {
                  "type": "string",
                  "description": "Secret key type."
                },
                "private_key": {
                  "type": "string",
                  "description": "Encrypted private key; never send an unencrypted vault private key here."
                },
                "private_key_nonce": {
                  "type": "string",
                  "description": "Hex-encoded nonce for private key."
                },
                "private_key_type": {
                  "type": "string",
                  "description": "Private key type."
                }
              }
            },
            "description": "Groups missing admin secrets."
          }
        }
      },
      "SamlLoginInfoPayload": {
        "type": "object",
        "properties": {
          "saml_token_id": {
            "type": "string",
            "description": "One-time token returned by the identity-provider browser exchange.",
            "format": "uuid"
          },
          "device_fingerprint": {
            "type": "string",
            "description": "Client device/session fingerprint."
          },
          "device_description": {
            "type": "string",
            "description": "Client device description."
          },
          "device_time": {
            "type": "string",
            "description": "Client time used for replay protection.",
            "format": "date-time"
          },
          "client_type": {
            "type": "string",
            "description": "Client type."
          }
        },
        "required": [
          "saml_token_id"
        ]
      },
      "SamlSessionDetails": {
        "type": "object",
        "properties": {
          "user_validator": {
            "type": "string",
            "description": "Encrypted user-validator challenge used for token activation."
          },
          "user_validator_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for user validator."
          },
          "token": {
            "type": "string",
            "description": "Authentication token returned by the indicated exchange."
          },
          "session_key": {
            "type": "string",
            "description": "Session identifier/key distinct from the symmetric session encryption key."
          },
          "required_multifactors": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "ivalt_2fa"
            },
            "description": "Required multifactors."
          },
          "session_secret_key": {
            "type": "string",
            "description": "Session encryption key, encrypted/wrapped in login exchanges as described by the protocol."
          },
          "password": {
            "type": [
              "string",
              "null"
            ],
            "description": "Password value for the operation; password and authkey are different credentials."
          },
          "user": {
            "type": "object",
            "properties": {
              "username": {
                "type": "string",
                "description": "Account username, normally including the configured domain."
              },
              "language": {
                "type": "string",
                "description": "Language."
              },
              "authentication": {
                "type": "string",
                "description": "Authentication."
              },
              "public_key": {
                "type": "string",
                "description": "Hex-encoded public key."
              },
              "private_key": {
                "type": "string",
                "description": "Encrypted private key; never send an unencrypted vault private key here."
              },
              "private_key_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for private key."
              },
              "user_sauce": {
                "type": "string",
                "description": "User sauce."
              },
              "policies": {
                "type": "object",
                "additionalProperties": true,
                "description": "Policies."
              },
              "hashing_algorithm": {
                "type": "string",
                "description": "Hashing algorithm."
              },
              "hashing_parameters": {
                "type": "object",
                "additionalProperties": true,
                "description": "Hashing parameters."
              }
            },
            "required": [
              "username",
              "language",
              "authentication",
              "public_key",
              "private_key",
              "private_key_nonce",
              "user_sauce",
              "policies",
              "hashing_algorithm",
              "hashing_parameters"
            ],
            "description": "User."
          }
        },
        "required": [
          "user_validator",
          "user_validator_nonce",
          "token",
          "session_key",
          "required_multifactors",
          "session_secret_key",
          "password",
          "user"
        ]
      },
      "SamlLoginResultEnterprise": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "description": "Ephemeral Box ciphertext containing the session details, not vault content."
          },
          "data_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce."
          },
          "server_session_public_key": {
            "type": "string",
            "description": "Server session public key."
          }
        },
        "required": [
          "data",
          "data_nonce",
          "server_session_public_key"
        ]
      },
      "SamlAssertionForm": {
        "type": "object",
        "properties": {
          "SAMLResponse": {
            "type": "string",
            "description": "Base64-encoded signed SAML response."
          },
          "RelayState": {
            "type": "string",
            "description": "Allowed client return URL supplied by the browser flow."
          }
        },
        "required": [
          "SAMLResponse"
        ]
      },
      "OidcLoginInfoPayload": {
        "type": "object",
        "properties": {
          "oidc_token_id": {
            "type": "string",
            "description": "One-time token returned by the identity-provider browser exchange.",
            "format": "uuid"
          },
          "device_fingerprint": {
            "type": "string",
            "description": "Client device/session fingerprint."
          },
          "device_description": {
            "type": "string",
            "description": "Client device description."
          },
          "device_time": {
            "type": "string",
            "description": "Client time used for replay protection.",
            "format": "date-time"
          },
          "client_type": {
            "type": "string",
            "description": "Client type."
          }
        },
        "required": [
          "oidc_token_id"
        ]
      },
      "OidcSessionDetails": {
        "type": "object",
        "properties": {
          "user_validator": {
            "type": "string",
            "description": "Encrypted user-validator challenge used for token activation."
          },
          "user_validator_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for user validator."
          },
          "token": {
            "type": "string",
            "description": "Authentication token returned by the indicated exchange."
          },
          "session_key": {
            "type": "string",
            "description": "Session identifier/key distinct from the symmetric session encryption key."
          },
          "required_multifactors": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "ivalt_2fa"
            },
            "description": "Required multifactors."
          },
          "session_secret_key": {
            "type": "string",
            "description": "Session encryption key, encrypted/wrapped in login exchanges as described by the protocol."
          },
          "password": {
            "type": [
              "string",
              "null"
            ],
            "description": "Password value for the operation; password and authkey are different credentials."
          },
          "user": {
            "type": "object",
            "properties": {
              "username": {
                "type": "string",
                "description": "Account username, normally including the configured domain."
              },
              "language": {
                "type": "string",
                "description": "Language."
              },
              "authentication": {
                "type": "string",
                "description": "Authentication."
              },
              "public_key": {
                "type": "string",
                "description": "Hex-encoded public key."
              },
              "private_key": {
                "type": "string",
                "description": "Encrypted private key; never send an unencrypted vault private key here."
              },
              "private_key_nonce": {
                "type": "string",
                "description": "Hex-encoded nonce for private key."
              },
              "user_sauce": {
                "type": "string",
                "description": "User sauce."
              },
              "policies": {
                "type": "object",
                "additionalProperties": true,
                "description": "Policies."
              },
              "hashing_algorithm": {
                "type": "string",
                "description": "Hashing algorithm."
              },
              "hashing_parameters": {
                "type": "object",
                "additionalProperties": true,
                "description": "Hashing parameters."
              }
            },
            "required": [
              "username",
              "language",
              "authentication",
              "public_key",
              "private_key",
              "private_key_nonce",
              "user_sauce",
              "policies",
              "hashing_algorithm",
              "hashing_parameters"
            ],
            "description": "User."
          }
        },
        "required": [
          "user_validator",
          "user_validator_nonce",
          "token",
          "session_key",
          "required_multifactors",
          "session_secret_key",
          "password",
          "user"
        ]
      },
      "OidcLoginResultEnterprise": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "description": "Ephemeral Box ciphertext containing the session details, not vault content."
          },
          "data_nonce": {
            "type": "string",
            "description": "Hex-encoded nonce for the encrypted content, separate from the transport nonce."
          },
          "server_session_public_key": {
            "type": "string",
            "description": "Server session public key."
          }
        },
        "required": [
          "data",
          "data_nonce",
          "server_session_public_key"
        ]
      },
      "OidcBackchannelLogoutForm": {
        "type": "object",
        "properties": {
          "logout_token": {
            "type": "string",
            "description": "Signed OpenID Connect logout JWT, verified using the provider configuration."
          }
        },
        "required": [
          "logout_token"
        ]
      },
      "getScim20ByScimProviderIdUsersResultEnterprise": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "totalResults": {
            "type": "integer",
            "description": "Total results."
          },
          "Resources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "schemas": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "urn:ietf:params:scim:schemas:core:2.0:User"
                  },
                  "description": "SCIM schema URNs identifying this resource/message."
                },
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "externalId": {
                  "type": "string",
                  "description": "External id identifier."
                },
                "meta": {
                  "type": "object",
                  "properties": {
                    "resourceType": {
                      "type": "string",
                      "example": "User",
                      "description": "Resource type."
                    },
                    "created": {
                      "type": "string",
                      "description": "Created."
                    },
                    "lastModified": {
                      "type": "string",
                      "description": "Last modified."
                    }
                  },
                  "required": [
                    "resourceType",
                    "created",
                    "lastModified"
                  ],
                  "description": "Meta."
                },
                "userName": {
                  "type": "string",
                  "description": "User name."
                },
                "displayName": {
                  "type": "string",
                  "description": "Display name."
                },
                "active": {
                  "type": "boolean",
                  "description": "Whether the resource or account is active."
                },
                "emails": {
                  "description": "Emails.",
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ScimEmailValue"
                  }
                }
              },
              "required": [
                "schemas",
                "id",
                "externalId",
                "meta",
                "userName",
                "displayName",
                "active",
                "emails"
              ]
            },
            "description": "Resources."
          },
          "startIndex": {
            "type": "integer",
            "description": "One-based SCIM pagination offset."
          },
          "itemsPerPage": {
            "type": "integer",
            "description": "Items per page."
          }
        },
        "required": [
          "schemas",
          "totalResults",
          "Resources",
          "startIndex",
          "itemsPerPage"
        ]
      },
      "getScim20ByScimProviderIdUsersByUserIdResultEnterprise": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "urn:ietf:params:scim:schemas:core:2.0:User"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "externalId": {
            "type": "string",
            "description": "External id identifier."
          },
          "meta": {
            "type": "object",
            "properties": {
              "resourceType": {
                "type": "string",
                "example": "User",
                "description": "Resource type."
              },
              "created": {
                "type": "string",
                "description": "Created."
              },
              "lastModified": {
                "type": "string",
                "description": "Last modified."
              }
            },
            "required": [
              "resourceType",
              "created",
              "lastModified"
            ],
            "description": "Meta."
          },
          "userName": {
            "type": "string",
            "description": "User name."
          },
          "displayName": {
            "type": "string",
            "description": "Display name."
          },
          "active": {
            "type": "boolean",
            "description": "Whether the resource or account is active."
          },
          "emails": {
            "description": "Emails.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScimEmailValue"
            }
          }
        },
        "required": [
          "schemas",
          "id",
          "externalId",
          "meta",
          "userName",
          "displayName",
          "active",
          "emails"
        ]
      },
      "getScim20ByScimProviderIdGroupsResultEnterprise": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "totalResults": {
            "type": "integer",
            "description": "Total results."
          },
          "Resources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "schemas": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "urn:ietf:params:scim:schemas:core:2.0:Group"
                  },
                  "description": "SCIM schema URNs identifying this resource/message."
                },
                "id": {
                  "type": "string",
                  "description": "Id identifier."
                },
                "meta": {
                  "type": "object",
                  "properties": {
                    "resourceType": {
                      "type": "string",
                      "example": "Group",
                      "description": "Resource type."
                    },
                    "created": {
                      "type": "string",
                      "description": "Created."
                    },
                    "lastModified": {
                      "type": "string",
                      "description": "Last modified."
                    }
                  },
                  "required": [
                    "resourceType",
                    "created",
                    "lastModified"
                  ],
                  "description": "Meta."
                },
                "displayName": {
                  "type": "string",
                  "description": "Display name."
                }
              },
              "required": [
                "schemas",
                "id",
                "meta",
                "displayName"
              ]
            },
            "description": "Resources."
          },
          "startIndex": {
            "type": "integer",
            "description": "One-based SCIM pagination offset."
          },
          "itemsPerPage": {
            "type": "integer",
            "description": "Items per page."
          }
        },
        "required": [
          "schemas",
          "totalResults",
          "Resources",
          "startIndex",
          "itemsPerPage"
        ]
      },
      "getScim20ByScimProviderIdGroupsByScimGroupIdResultEnterprise": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "urn:ietf:params:scim:schemas:core:2.0:Group"
            },
            "description": "SCIM schema URNs identifying this resource/message."
          },
          "id": {
            "type": "string",
            "description": "Id identifier."
          },
          "meta": {
            "type": "object",
            "properties": {
              "resourceType": {
                "type": "string",
                "example": "Group",
                "description": "Resource type."
              },
              "created": {
                "type": "string",
                "description": "Created."
              },
              "lastModified": {
                "type": "string",
                "description": "Last modified."
              }
            },
            "required": [
              "resourceType",
              "created",
              "lastModified"
            ],
            "description": "Meta."
          },
          "displayName": {
            "type": "string",
            "description": "Display name."
          }
        },
        "required": [
          "schemas",
          "id",
          "meta",
          "displayName"
        ]
      },
      "AvailableGatewayClusters": {
        "type": "object",
        "properties": {
          "clusters": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Id identifier."
                },
                "title": {
                  "type": "string",
                  "description": "Title or display label. For vault/share titles, provide the encrypted value with title_nonce."
                }
              },
              "required": [
                "id",
                "title"
              ]
            },
            "description": "Clusters."
          }
        },
        "required": [
          "clusters"
        ]
      }
    }
  },
  "x-psono-edition": "EE"
}
