Skip to main content

Users and access

This document was generated using AI assistance

Content may include inaccuracies, outdated information, or technical errors. Users are advised to cross-check critical information before implementation.

User accounts are stored in Keycloak, access to projects in Architeezy. An administrator creates the account; the project owner decides what that account can see.

Creating a user​

  1. Open Keycloak at the address in KEYCLOAK_URL - http://localhost:8181 in the default setup - and sign in with KEYCLOAK_ADMIN_USERNAME and KEYCLOAK_ADMIN_PASSWORD.
  2. Select Manage realms → Architeezy → Users.
  3. Click Add user, fill in the username and, if you use mail, the email address, then Create.
  4. Open the Credentials tab, click Set password, and give the account a password. Leave Temporary on if you want the user to choose their own at first sign-in.

Self-registration and password reset are switched off in the realm as delivered, so accounts are created this way. Turn either on under Realm settings → Login if you would rather let users sign up themselves.

First sign-in​

The first time an account signs in to Architeezy, the application creates a record for it:

  • A profile with a name taken from the account and a short identifier - the slug - derived from the username. Other people use the slug to grant access.
  • A personal scope named after the user, with the user as its owner. Projects created by that user go there by default.

Users find their own slug in the user menu, behind the avatar in the top-right corner: the first entry shows the slug and copies it to the clipboard when clicked.

Roles​

Access is granted per project. In a project a user holds one of three roles, or none at all:

  • Owner - full control of the project, including its membership.
  • Editor - may change the models and representations in the project.
  • Viewer - may open and read the project.
  • None - no role, and no access.

The same values apply to a scope, where they cover every project the scope contains.

Sharing a project​

Open the project menu and choose Members. The Project members dialog lists everyone who already has a role and lets an owner add more:

  1. Type the user's Slug in the field at the top.
  2. Pick a Role.
  3. Click Add.

The table has one column per role. To change somebody's access, select a different column in their row. Selecting None closes the project to them.

Membership requests​

A user who opens a project they have no access to sees a message telling them the project does not exist or is not available to them. The message carries a link to request membership. The same request can be sent with the Request membership button on the project, and withdrawn with Cancel membership request.

Owners see incoming requests in the user menu under Membership requests; the avatar carries a badge with the number of requests waiting. The dialog lists the project and the user for each request, lets the owner pick the role to grant - Viewer, Editor or Owner - and offers Approve and Reject.

Project list​

The start page separates My projects, where the signed-in user holds a role, from Public projects, which lists the projects visible without membership. Both lists can be searched by name.