TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-15 01:57:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: screenshots and text improvements (#912)

Browse Source 
* additional content

* even more content
This commit is contained in:
Florian Forster
2020-10-28 10:15:05 +01:00
committed by GitHub
parent e686268e81
commit 9e2b3d10fe
30 changed files with 312 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
site/docs/administrate/01-console.en.md
View File

@@ -6,24 +6,62 @@ title: Console
Console is the ZITADEL Graphical User Interface.
#### ZITADEL Users
**Users** can manage some information on their own.
- profile information
- credentials
- external logins
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_user_entry.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_user_entry.png" itemprop="thumbnail" alt="User Entry" />
</a>
<figcaption itemprop="caption description">User Entry</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_user_personal_information.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_user_personal_information.png" itemprop="thumbnail" alt="User Personal Information" />
</a>
<figcaption itemprop="caption description">User Personal Information</figcaption>
</figure>
</div>
#### ZITADEL Organisation Owners
Users (**org owners**) who manage organisations do this also with Console.
- Organisation settings (policies, domains, idp's)
- Organisation settings (policies, domains, idps)
- Manage users
- Manage projects, clients and roles
- Give access to users
#### ZITADEL Administrators
For the **IAM Administrators** there is also a section in Console solely intended to manage the system.
- Check failed events
- Reset read models
- Define system policies
- Manage system settings and policies
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_admin_entry.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_admin_entry.png" itemprop="thumbnail" alt="Adminstrator Entry" />
</a>
<figcaption itemprop="caption description">Adminstrator Entry</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_admin_system.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_admin_system.png" itemprop="thumbnail" alt="System Administration" />
</a>
<figcaption itemprop="caption description">System Administration</figcaption>
</figure>
</div>
> ZITADEL does display a banner to warn the administrator that his account has elevated privileges!
### Technologies

17
site/docs/administrate/02-organisations.en.md
View File

@@ -107,6 +107,23 @@ Congratulations your are done! You can check this by visiting [https://console.z
> This only works when the [user](administrate#Users) is member of this [organisation](administrate#Organisations)
### Manage Organisation ZITADEL Roles
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_org_manage_roles_1.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_org_manage_roles_1.png" itemprop="thumbnail" alt="Manage ZITADEL Roles 1" />
</a>
<figcaption itemprop="caption description">Manage ZITADEL Roles 1</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_org_manage_roles_2.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_org_manage_roles_2.png" itemprop="thumbnail" alt="Manage ZITADEL Roles 2" />
</a>
<figcaption itemprop="caption description">Manage ZITADEL Roles 2</figcaption>
</figure>
</div>
### Audit organisation changes
All changes to the organisation are displayed on the organisation menu within [ZITADEL Console](https://console.zitadel.ch/org) organisation menu. Located on the right hand side under "activity".

25
site/docs/administrate/03-projects.en.md
View File

@@ -29,7 +29,9 @@ To achieve this the owner of a project can grant (some could say delegate) certa
After granting that organisation it can manage on its own which user has what roles.
This feature is especially useful for service providers, because they are able to establish a great self-service culture for their business customers.
**Authorizations**
**Authorizations**
> TODO, Link to authorizations
#### Project vs. granted Project
@@ -75,6 +77,27 @@ Create a new project with a name which explains what's the intended use of this
> Screenshot here
### Manage Project Authorisations
> Screenshot here
### Manage Project ZITADEL Roles
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_project_manage_roles_1.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_project_manage_roles_1.png" itemprop="thumbnail" alt="Manage ZITADEL Roles 1" />
</a>
<figcaption itemprop="caption description">Manage ZITADEL Roles 1</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_project_manage_roles_2.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_project_manage_roles_2.png" itemprop="thumbnail" alt="Manage ZITADEL Roles 2" />
</a>
<figcaption itemprop="caption description">Manage ZITADEL Roles 2</figcaption>
</figure>
</div>
### Audit project changes
> Screenshot here

25
site/docs/administrate/06-users.en.md
View File

@@ -51,8 +51,6 @@ Image 1: User List Search
</figure>
</div>
Image 2: User List
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_user_create_form.png" itemprop="contentUrl" data-size="1920x1080">
@@ -62,8 +60,6 @@ Image 2: User List
</figure>
</div>
Image 3: User Create Form
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_user_create_done.png" itemprop="contentUrl" data-size="1920x1080">
@@ -73,8 +69,6 @@ Image 3: User Create Form
</figure>
</div>
Image 4: User Create Done
#### Set Password
> Screenshot here
@@ -83,10 +77,27 @@ Image 4: User Create Done
> Screenshot here
### Authorizations
### Manage User Authorisations
> Screenshot here
### Manage User ZITADEL Roles
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_user_manage_roles_1.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_user_manage_roles_1.png" itemprop="thumbnail" alt="Manage ZITADEL Roles 1" />
</a>
<figcaption itemprop="caption description">Manage ZITADEL Roles 1</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_user_manage_roles_2.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_user_manage_roles_2.png" itemprop="thumbnail" alt="Manage ZITADEL Roles 2" />
</a>
<figcaption itemprop="caption description">Manage ZITADEL Roles 2</figcaption>
</figure>
</div>
### Audit user changes
> Screenshot here

5
site/docs/administrate/09-authorisations.de.md Normal file
View File

@@ -0,0 +1,5 @@
---
title: Autorisierungen
---
> This Language is not yet translated. Please consult the English version.

42
site/docs/administrate/09-authorisations.en.md Normal file
View File

@@ -0,0 +1,42 @@
---
title: Authorisations
---
### What are Authorisations
**ZITADEL** thinks of authorisations as resource who clearly defines which user has what roles. Authorisations are also called "user grant".
### Manage Authorisations
You can grant Roles directly on a project. Or, if the user is in your organisation, by apply in the roles to the user directly.
Additionaly you can use the authorization menu item to search for a user and project.
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_authz_overview.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_authz_overview.png" itemprop="thumbnail" alt="Manage Authorisations Overview" />
</a>
<figcaption itemprop="caption description">Manage Authorisations Overview</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_authz_add_1.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_authz_add_1.png" itemprop="thumbnail" alt="Manage Authorisations 1" />
</a>
<figcaption itemprop="caption description">Manage Authorisations 1</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_authz_add_2.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_authz_add_2.png" itemprop="thumbnail" alt="Manage Authorisations 2" />
</a>
<figcaption itemprop="caption description">Manage Authorisations 2</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_authz_add_3.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_authz_add_3.png" itemprop="thumbnail" alt="Manage Authorisations 3" />
</a>
<figcaption itemprop="caption description">Manage Authorisations 3</figcaption>
</figure>
</div>
- [Manage Project Authorisations](administrate#Manage_Project_Authorisations)
- [Manage User Authorisations](administrate#Manage_User_Authorisations)

5
site/docs/administrate/70-zitadelroles.de.md Normal file
View File

@@ -0,0 +1,5 @@
---
title: ZITADEL Rollen
---
> This Language is not yet translated. Please consult the English version.

49
site/docs/administrate/70-zitadelroles.en.md Normal file
View File

@@ -0,0 +1,49 @@
---
title: ZITADEL Roles
---
### ZITADEL's Roles
**ZITADEL's** own role model is built around the IAM resources. The roles have some hierarchies to them. For example a IAM_OWNER can view and edit every resource of the system. ORG_OWNERS can only manage their resources included within their organisation. This includes projects, clients, users, and so on.
#### System Roles
IAM_OWNER
IAM_OWNER_VIEWER
#### Organisation Roles
ORG_OWNER
ORG_OWNER_VIEWER
ORG_USER_PERMISSION_EDITOR
ORG_PROJECT_PERMISSION_EDITOR
ORG_PROJECT_CREATOR
#### Owned Project Roles
PROJECT_OWNER
PROJECT_OWNER_VIEWER
PROJECT_OWNER_GLOBAL
PROJECT_OWNER_VIEWER_GLOBAL
#### Granted Project Roles
PROJECT_GRANT_OWNER
PROJECT_GRANT_OWNER_VIEWER
### Manage ZITADEL Roles
You can grant ZITADEL Roles directly on a resource like organisation or project. Or, if the user is in your organisation, by applying in the roles to the user directly.
- [Manage Organisation ZITADEL Roles](administrate#Manage_Organisation_ZITADEL_Roles)
- [Manage Project ZITADEL Roles](administrate#Manage_Organisation_ZITADEL_Roles)
- [Manage User ZITADEL Roles](administrate#Manage_Organisation_ZITADEL_Roles)

17
site/docs/administrate/90-system.en.md
View File

@@ -23,7 +23,22 @@ There is even a possibility to regenerate a read model.
> When a read model is regenerated it might take up some time to be fully operational again
> Depending on the model which is regenerated this might have a operational impact for the end-users
> Screenshot here
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_iam_admin_views.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_iam_admin_views.png" itemprop="thumbnail" alt="IAM View Management" />
</a>
<figcaption itemprop="caption description">IAM View Management</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="img/console_iam_admin_failed.png" itemprop="contentUrl" data-size="1920x1080">
<img src="img/console_iam_admin_failed.png" itemprop="thumbnail" alt="IAM Failed Events" />
</a>
<figcaption itemprop="caption description">IAM Failed Events</figcaption>
</figure>
</div>
> Additional infos to the architecture of ZITADEL is located in [Architecture Docs](documentation#Architecture)
### Secret Handling