Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
horizon 1.1.3 documentation
Logo

Horizon

  • Data.Horizon

High-level design

  • Entities
  • Role Permissions

Backend

  • Install & run backend
  • Architecture
  • Configuration
    • Database settings
    • Logging settings
    • Setup monitoring
    • CORS settings
    • Serving static files
    • OpenAPI settings
    • Enabling debug
  • Auth Providers
    • Dummy Auth provider
    • LDAP Auth provider
    • LDAP Cached Auth provider
    • Custom Auth provider
  • OpenAPI specification
  • Scripts
    • Manage Admins

Client

  • Install client
  • Sync client
  • Auth
  • Schemas
    • Namespace-related schemas
    • Namespace history-related schemas
    • HWM-related schemas
    • HWM history-related schemas
    • Permissions-related schemas
    • User-related schemas
    • Ping-related schemas
    • Pagination-related schemas
  • Exceptions

Development

  • Changelog
    • 1.1.3 (2025-10-29)
    • 1.1.2 (2025-04-07)
    • 1.1.1 (2025-01-28)
    • 1.0.2 (2024-11-21)
    • 1.0.1 (2024-06-27)
    • 1.0.0 (2024-06-10)
    • 0.2.1 (2024-05-29)
    • 0.2.0 (2024-05-15)
    • 0.1.3 (2024-05-02)
    • 0.1.2 (2024-04-02)
    • 0.1.1 (2024-03-27)
    • 0.0.13 (2024-02-13)
    • 0.0.12 (2024-01-24)
    • 0.0.11 (2024-01-22)
    • 0.0.10 (2024-01-22)
    • 0.0.9 (2024-01-19)
    • 0.0.8 (2024-01-18)
  • Contributing Guide
  • Security
Back to top
View this page

Permissions-related schemas¶

pydantic model horizon.commons.schemas.v1.permission.PermissionResponseItemV1¶

Represents a single permission entry in a response, linking a user with their role within a namespace.

field username: str [Required]¶
field role: NamespaceUserRole [Required]¶
pydantic model horizon.commons.schemas.v1.permission.PermissionsResponseV1¶

Wraps a list of permission entries for a namespace, returned by the GET endpoint.

field permissions: List[PermissionResponseItemV1] [Required]¶
pydantic model horizon.commons.schemas.v1.permission.PermissionUpdateRequestItemV1¶

Represents a single permission entry in a request, specifying a desired role for a user within a namespace.

field username: str [Required]¶
field role: NamespaceUserRole | None = None¶

The role to be assigned to the user within the namespace. A value of None indicates that the permission should be removed.

pydantic model horizon.commons.schemas.v1.permission.PermissionsUpdateRequestV1¶

Wraps a list of permission modification requests for a namespace, used by the PATCH endpoint.

field permissions: List[PermissionUpdateRequestItemV1] [Required]¶

A list of modifications to the namespace’s permissions. Each entry specifies a user and the role they should have or be removed from.

Next
User-related schemas
Previous
HWM history-related schemas
Copyright © 2023-2025 MTS PJSC
Made with Sphinx and @pradyunsg's Furo
Last updated on Mar 28, 2025
On this page
  • Permissions-related schemas
    • PermissionResponseItemV1
      • PermissionResponseItemV1.username
      • PermissionResponseItemV1.role
    • PermissionsResponseV1
      • PermissionsResponseV1.permissions
    • PermissionUpdateRequestItemV1
      • PermissionUpdateRequestItemV1.username
      • PermissionUpdateRequestItemV1.role
    • PermissionsUpdateRequestV1
      • PermissionsUpdateRequestV1.permissions