Skip to content

Permissions-related schemas

PermissionResponseItemV1

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

Parameters:

  • username

    (str) –

    The username of the user

  • role

    (NamespaceUserRole) –

    The role to be assigned to the user within the namespace

PermissionsResponseV1

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

Parameters:

PermissionUpdateRequestItemV1

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

Parameters:

  • username

    (str) –

    The username of the user

  • role

    (NamespaceUserRole | None, default: None ) –

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

PermissionsUpdateRequestV1

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

Parameters:

  • permissions

    (list[PermissionUpdateRequestItemV1]) –

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