Back to Zitadel

ZITADEL Administrators

apps/docs/content/guides/manage/console/administrators.mdx

5.0.0-base5.3 KB
Original Source

import AdministratorDescription from "../../../concepts/structure/_administrator_description.mdx"; import AddAdministrator from "./_add_administrator.mdx"; import PermissionTable from '@/components/PermissionTable'; import permissionData from "../../../../../../cmd/defaults.yaml";

<TerminologyUpdate newTerm="Administrators" oldTerms={["Members", "Memberships", "Managers"]} />

<AdministratorDescription components={props.components} name="AdministratorDescription" />

To configure administrators in ZITADEL, go to the resource where you like to add it (e.g., Instance, Organization, Project, GrantedProject). In the right part of the management console you can find ADMINISTRATORS in the details part. Here you have a list of the current administrators and can add a new one.

<AddAdministrator components={props.components} name="AddAdministrator" />

Roles

NameRoleDescription
Instance OwnerIAM_OWNERManage the Instance, manage all organizations with their content
Instance Owner ViewerIAM_OWNER_VIEWERView the Instance and view all organizations with their content
Instance Org ManagerIAM_ORG_MANAGERManage all organizations including their policies, projects and users
Instance User ManagerIAM_USER_MANAGERManage all users and their authorizations over all organizations
Instance Admin ImpersonatorIAM_ADMIN_IMPERSONATORAllow impersonation of admin and end users from all organizations
Instance ImpersonatorIAM_END_USER_IMPERSONATORAllow impersonation of end users from all organizations
Instance Login ClientIAM_LOGIN_CLIENTGet all permissions needed to implement your own Login UI.
Org OwnerORG_OWNERManage everything within an organization
Org Owner ViewerORG_OWNER_VIEWERView everything within an organization
Org User ManagerORG_USER_MANAGERManage users and their authorizations within an organization
Org User Permission EditorORG_USER_PERMISSION_EDITORManage user grants and view everything needed for this
Org Project Permission EditorORG_PROJECT_PERMISSION_EDITORGrant Projects to other organizations and view everything needed for this
Org Project CreatorORG_PROJECT_CREATORThis role is used for users in the global organization. They are allowed to create projects and manage them.
Org Admin ImpersonatorORG_ADMIN_IMPERSONATORAllow impersonation of admin and end users from the organization
Org ImpersonatorORG_END_USER_IMPERSONATORAllow impersonation of end users from the organization
Project OwnerPROJECT_OWNERManage everything within a project. This includes to grant users for the project.
Project Owner ViewerPROJECT_OWNER_VIEWERView everything within a project.
Project Owner GlobalPROJECT_OWNER_GLOBALSame as PROJECT_OWNER, but in the global organization.
Project Owner Viewer GlobalPROJECT_OWNER_VIEWER_GLOBALSame as PROJECT_OWNER_VIEWER, but in the global organization.
Project Grant OwnerPROJECT_GRANT_OWNERSame as PROJECT_OWNER but for a granted project.

Configure roles

If you run a self-hosted ZITADEL instance, you can define your custom roles by overwriting the defaults.yaml In the InternalAuthZ section you will find all the roles and which permissions they have.

Example:

bash
InternalAuthZ:
  RolePermissionMappings:
    - Role: "IAM_OWNER"
      Permissions:
        - "iam.read"
        - "iam.write"

Administrator Permission Matrix

This table is generated dynamically from our settings file.

<PermissionTable data={permissionData} />