Skip to content

More obvious Namespace description #477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2025
Merged

More obvious Namespace description #477

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions source/components/nethsm/administration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1020,7 +1020,9 @@ Add a user account to the NetHSM.
Each user account has a *Role*, which needs to be specified.
Please refer to chapter `Roles <administration.html#roles>`__ to learn more about *Roles*.

Optionally, a user can be assigned to a `Namespace <administration.html#namespaces>`__.
Optionally, a user can be assigned to a `Namespace <administration.html#namespaces>`__. By default, the Namespace is inherited from the user that adds the new user.
Only users without a Namespace can choose a different Namespace for new users.
The Namespace is used as a prefix for the user name, for example `namespace~user`. Therefore, the same user name can be used in several Namespaces.

.. note::
The user ID must be alphanumeric.
Expand Down Expand Up @@ -1068,10 +1070,6 @@ A user account can be added as follows.

Information about the `/users/{UserID}` endpoint, to create a user with specifying the user ID, can be found in the `API documentation <https://nethsmdemo.nitrokey.com/api_docs/index.html#/default/PUT_users-UserID>`__.

By default, the Namespace is inherited from the user that adds the new user.
Only users without a Namespace can choose a different Namespace for new users.
The Namespace is used as a prefix for the user name, for example `namespace~user`. Therefore, the same user name can be used in several Namespaces.

Delete User
~~~~~~~~~~~

Expand Down Expand Up @@ -1109,6 +1107,8 @@ List Users

List the users on the NetHSM.

Users within a Namespace can only see users in the same Namespace.

The list can be retrieved as follows.

.. tabs::
Expand Down Expand Up @@ -1140,8 +1140,6 @@ The list can be retrieved as follows.

Information about the `/users/{UserID}` endpoint can be found in the `API documentation <https://nethsmdemo.nitrokey.com/api_docs/index.html#/default/GET_users-UserID>`__.

Users within a Namespace can only see users in the same Namespace.

User Passphrase
~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -1185,7 +1183,7 @@ Namespaces
Similarly to the concept of partitions, NetHSM supports the more flexible *Namespaces* which group keys, administrators, and users on a NetHSM into separate subsets.
Users can only see and use keys in the same Namespace and can only see users in the same Namespace.
It is not possible to see users and to see and use keys of other Namespaces.
When a new user is created, it inherits the Namespace of the user that created it.
When a new user is created, it inherits the Namespace of the user that created it. Users can belong to one Namespace only but not to more.
The available storage capacity is shared between all Namespaces.
An practically unlimited amount of Namespaces can be used without requiring additional licenses.

Expand Down