Skip to content

Commit 1f8aac4

Browse files
uF4NouF4No
authored
fix: prividium updates and fixes (#488)
# Description - Removes mentions to Permissions API - Removes user docs as those are embedded in Prividium portals now - Redirects for deleted section - Adds admin and user management general doc (as replacement of previous) - Updates developer considerations doc ## Linked Issues N/A - Pending updates ## Additional context Customers referencing this pages that were outdated
1 parent b862ea9 commit 1f8aac4

15 files changed

+229
-648
lines changed

‎content/10.zk-stack/35.prividium/00.overview.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Administrators can:
3535
- Assign permissions for contracts and functions directly in the UI
3636
- Configure selective disclosure for public endpoints
3737

38-
Access control is enforced by the **Proxy RPC**, which validates user tokens against the **Permissions API** before any on-chain call is executed.
38+
Access control is enforced by the **Proxy RPC**, which validates user tokens against the **Prividium API** before any on-chain call is executed.
3939

4040
**Built-in Compliance:**
4141
Single sign-on with Okta, address-level identity binding, and fine-grained access policies are integrated out of the box.
@@ -72,7 +72,7 @@ To learn more about data availability in the ZK Stack, visit the [Validium page]
7272
Prividium™ enforces privacy and access control using built-in infrastructure within the ZK Stack.
7373

7474
- Users authenticate through **Okta SSO** or **Sign-in With Ethereum (SIWE)**.
75-
- All calls pass through the **Proxy RPC**, which checks the user’s token and permissions against the **Permissions API**.
75+
- All calls pass through the **Proxy RPC**, which checks the user’s token and permissions against the **Prividium API**.
7676
- Roles and permissions are defined in the **Admin Dashboard**, not static YAML files.
7777
- Access is controlled at the contract-function level, with optional restrictions based on function arguments.
7878
- Auditors and regulators can use **Selective Disclosure** to view approved on-chain data without accessing the private ledger.

‎content/10.zk-stack/35.prividium/02.features.md‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Only cryptographic commitments—state roots and STARK-based proofs—are submit
2929
## Fine-Grained Access Control
3030

3131
All interactions with the chain are routed through a Proxy RPC that enforces access policies managed in the Prividium™ Permissioning System.
32-
Administrators configure roles, users, and permissions through the Admin Dashboard, which stores policies dynamically in the Permissions API.
32+
Administrators configure roles, users, and permissions through the Admin Dashboard, which stores policies dynamically in the Prividium API.
3333
**Features:**
3434

3535
- Manage access using roles (e.g., Trader, Auditor, Admin) and assign them to users in the dashboard
@@ -40,7 +40,7 @@ Administrators configure roles, users, and permissions through the Admin Dashboa
4040
- Configure and update permissions without redeploying contracts or editing files
4141

4242
**Request Path:**
43-
Client → Proxy RPC (permission validation) → Permissions API (policy check) → Sequencer RPC
43+
Client → Proxy RPC (permission validation) → Prividium API (policy check) → Sequencer RPC
4444

4545
## Compliance & Audit Support
4646

@@ -74,10 +74,3 @@ With shared settlement and ZK proofs, institutions can move assets securely and
7474
all without consortium agreements, third-party bridges, or compromises to customization.
7575

7676
Daily operations remain private, but interoperability is opt-in and cryptographically verified.
77-
78-
---
79-
80-
### Next Step
81-
82-
See [Configure Prividium™](./config/authentication.md)
83-
for detailed steps on setting up authentication, users, roles, permissions, and selective disclosure.

‎content/10.zk-stack/35.prividium/05.architecture.md‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Architecture Overview
2+
title: Architecture
33
description: Understand how Prividium™ works under the hood.
44
---
55

@@ -56,17 +56,10 @@ These components work together to provide secure, verifiable, and customizable n
5656
### How Access Control Works
5757

5858
1. Users authenticate via **Okta SSO** or **Sign-in With Ethereum (SIWE)** in the **User Dashboard**.
59-
2. The **Proxy RPC** forwards their request and token to the **Permissions API**.
60-
3. The **Permissions API** verifies the user’s identity, role, and function-level rules.
59+
2. The **Proxy RPC** forwards their request and token to the **Prividium API**.
60+
3. The **Prividium API** verifies the user’s identity, role, and function-level rules.
6161
4. Authorized requests are sent to the **Sequencer RPC**, which executes transactions privately.
6262
5. State updates are committed to Ethereum through the **ZKsync Gateway**.
6363

6464
This design ensures that access control, compliance, and selective disclosure are built directly into the network stack,
6565
not managed through static configuration files.
66-
67-
---
68-
69-
### Next Step
70-
71-
See [Configure Prividium™](./config/authentication.md)
72-
for instructions on setting up authentication, users, roles, permissions, and selective disclosure.

‎content/10.zk-stack/35.prividium/20.proxy.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ all blockchain interactions before they reach the sequencer.
1010

1111
## How It Works
1212

13-
The Proxy RPC validates every request against the [Permissions API](/zk-stack/prividium/permissions-overview):
13+
The Proxy RPC validates every request against the [Prividium API](/zk-stack/prividium/permissions-overview):
1414

1515
1. User submits a transaction or query through the Proxy RPC
1616
2. Proxy validates the user's JWT and wallet address

‎content/10.zk-stack/35.prividium/25.administration-user-management.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: Administration and User Management
3+
description: Manage users and roles to control access to your Prividium™ chain.
4+
---
5+
6+
User management in Prividium™ controls who can access your network and what actions they can perform.
7+
The system combines **users** (individual identities) and **roles** (permission groups) to provide flexible, granular access control.
8+
Administrators configure both through the Admin Dashboard.
9+
10+
:display_partial{path="/zk-stack/prividium/_partials/_license-callout"}
11+
12+
## Admin Panel
13+
14+
The Admin Dashboard provides a user interface for permission management where administrators configure data access rules and monitor system access patterns.
15+
Only designated admins can access the Admin Dashboard to manage users, roles, and contract permissions.
16+
17+
The initial admin is defined when the Prividium™ API launches.
18+
To add more admins, the initial admin must manually grant other users the admin role.
19+
The admin status itself is a role that can be assigned to users.
20+
21+
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
22+
Keep at least two Admin users configured to prevent lockout scenarios.
23+
::
24+
25+
Through the Admin Dashboard, administrators can:
26+
27+
- **View and search users** including their emails, associated wallets, and assigned roles
28+
- **Add and remove users** to control network access
29+
- **Create and manage roles** to define access privileges
30+
- **Assign roles to users** to grant specific permissions
31+
- **Configure contract permissions** to control function-level access
32+
33+
## Users
34+
35+
Users represent individual identities that can authenticate and interact with your Prividium™ network.
36+
Each user can authenticate through an identity provider like Okta, a crypto wallet via SIWE (Sign-In With Ethereum), or both methods.
37+
38+
### Authentication Methods
39+
40+
Prividium™ supports three user types based on authentication:
41+
42+
| Type | Authentication | Managed From | Notes |
43+
|------|----------------|-------------|-------|
44+
| **OIDC user** | OAuth 2.0 (OIDC providers) | Admin Dashboard | Linked by subject ID |
45+
| **Wallet user** | SIWE | Admin Dashboard | Identified by wallet address |
46+
| **Hybrid user** | OAuth 2.0 (OIDC providers) or SIWE | Admin Dashboard | Can use either method to authenticate |
47+
48+
Hybrid users provide flexibility, allowing authentication through either corporate identity systems or crypto wallets depending on the context.
49+
50+
### User Capabilities
51+
52+
The Admin Dashboard provides comprehensive user management:
53+
54+
- **Create users** with email, subject ID, or wallet addresses
55+
- **Link multiple wallets** to a single user identity
56+
- **Assign roles** to define access permissions
57+
- **Edit user details** including authentication methods and role assignments
58+
- **Remove users** and revoke all associated access
59+
60+
All linked wallets inherit the same role-based permissions assigned to the user.
61+
Changes to user permissions take effect immediately, though users may need to refresh their session to see updated access.
62+
63+
## Roles
64+
65+
Roles define access levels by grouping permissions that determine which contracts and functions users can call through the Proxy API.
66+
Each role represents a set of privileges that can be assigned to one or more users.
67+
68+
### Role Management
69+
70+
Administrators create and manage roles through the Admin Dashboard:
71+
72+
- **Create roles** with descriptive names matching organizational structure
73+
- **Assign roles to users** to grant permissions
74+
- **Combine multiple roles** per user for flexible access control
75+
- **Update or delete roles** as deployment requirements evolve
76+
77+
A user's effective permissions are the combination of all permissions granted to their assigned roles.
78+
This allows fine-grained control while maintaining simplicity through role-based grouping.
79+
80+
### Common Role Patterns
81+
82+
| Role | Purpose | Typical Permissions |
83+
|------|----------|---------------------|
84+
| **Admin** | Full system management | Manage users, roles, permissions, and disclosure settings |
85+
| **Trader** | Execute transactions | Write access to token contracts and trading functions |
86+
| **Auditor** | Read-only observer | View contract data and public disclosures |
87+
| **Operator** | System maintenance | Read/write access to operational contracts only |
88+
89+
Customize role names and scopes to match your organization's workflow and security requirements.
90+
91+
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
92+
Roles cannot be deleted while assigned to active users. Reassign or remove those users first.
93+
::
94+
95+
## Access Control Flow
96+
97+
The user and role system integrates with Prividium's permission architecture:
98+
99+
1. **User authenticates** via Okta or wallet signature
100+
2. **System identifies user** and retrieves assigned roles
101+
3. **User calls contract function** through Proxy API
102+
4. **Prividium API checks** if user's roles permit the function call
103+
5. **Request proceeds or fails** based on permission evaluation
104+
105+
This architecture separates identity management (users) from access control (roles and permissions), enabling flexible security policies that adapt to
106+
changing requirements.

0 commit comments

Comments
 (0)