Skip to content

Commit 48f0373

Browse files
fix: Renaming (#92)
Signed-off-by: Bassam Riman <bassam.riman@iohk.io>
1 parent d660e9f commit 48f0373

26 files changed

+144
-145
lines changed

documentation/docs/atala-prism/getting-help.md

-6
This file was deleted.

documentation/docs/atala-prism/overview.md

-11
This file was deleted.

documentation/docs/atala-prism/prism-cloud-agent/did-management.md

-22
This file was deleted.

documentation/docs/concepts/multi-tenancy.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44

55
### Purpose
66

7-
Multi-tenancy is a fundamental capability of the PRISM toolset designed to provide secure and efficient identity and credential management for diverse users, identities, and organizations. It enables the platform to serve multiple tenants while ensuring the logical isolation of their assets.
7+
Multi-tenancy is a fundamental capability of the Identus toolset designed to provide secure and efficient identity and credential management for diverse users, identities, and organizations. It enables the platform to serve multiple tenants while ensuring the logical isolation of their assets.
88

99
### Key Benefits
1010

11-
- **Scalability**: PRISM's multi-tenancy support allows the platform to scale effortlessly to accommodate growing users, entities, and organizations.
11+
- **Scalability**: Identus' multi-tenancy support allows the platform to scale effortlessly to accommodate growing users, entities, and organizations.
1212
- **Resource Efficiency**: It optimizes resource utilization by enabling the sharing of infrastructure components, enhancing cost-effectiveness.
1313
- **Data Isolation**: Multi-tenancy ensures that the data, such as DIDs (Decentralized Identifiers), connections, VCs (Verifiable Credentials), keys, and more, of one tenant is completely isolated from others, preserving data privacy and security.
1414
- **Enhanced Collaboration**: Shared wallets enable collaboration between entities while maintaining data segregation.
1515
- **Granular Control**: Administrators control the resources and permissions assigned to each entity.
1616

1717
## Roles in multi-tenancy
1818

19-
Multi-tenancy permits multiple users or systems to use the PRISM Cloud Agent within a shared instance, enhancing resource utilization while preserving each tenant's and their resources' separation. Understanding different roles in multi-tenancy is essential for the secure and efficient operation of the Cloud Agent.
19+
Multi-tenancy permits multiple users or systems to use the Cloud Agent within a shared instance, enhancing resource utilization while preserving each tenant's and their resources' separation. Understanding different roles in multi-tenancy is essential for the secure and efficient operation of the Cloud Agent.
2020

2121
### Administrator
2222

@@ -30,27 +30,27 @@ Tenants are the users or systems engaged in everyday interactions. They have rep
3030

3131
### Wallet
3232

33-
A wallet is a central component of PRISM's multi-tenancy model. It serves as the container for storing and managing a tenant's digital assets, including DIDs, connections, VCs, keys, and more. Wallets are logically isolated to ensure that the data associated with one entity remains separate and secure from others.
33+
A wallet is a central component of Identus' multi-tenancy model. It serves as the container for storing and managing a tenant's digital assets, including DIDs, connections, VCs, keys, and more. Wallets are logically isolated to ensure that the data associated with one entity remains separate and secure from others.
3434

3535
### Entity
3636

37-
An entity represents a user or any other identity within the PRISM platform. Each entity owns a Wallet, making it the primary entity for managing and interacting with its digital credentials and assets. Entities can also share wallets, enabling collaborative use of resources.
37+
An entity represents a user or any other identity within the Identus platform. Each entity owns a Wallet, making it the primary entity for managing and interacting with its digital credentials and assets. Entities can also share wallets, enabling collaborative use of resources.
3838

3939
### Authentication Method
4040

4141
Each entity is associated with an Authentication Method, which serves as a secure means of verifying the identity and access rights of the entity. This method ensures the entity's identity is authenticated during interactions with the platform, enhancing security.
4242

4343
### Logical Isolation
44-
Logical Isolation is a core principle of PRISM's multi-tenancy model. It ensures that one entity's digital assets, transactions, and data are logically separated from others, maintaining the highest data privacy and security level.
44+
Logical Isolation is a core principle of Identus' multi-tenancy model. It ensures that one entity's digital assets, transactions, and data are logically separated from others, maintaining the highest data privacy and security level.
4545

4646
### Shared Wallets
47-
PRISM's multi-tenancy capabilities allow for the sharing of wallets among multiple entities. This feature facilitates collaborative work and resource sharing while preserving data isolation within the shared wallet. The entity can own only one wallet. Sharing it with other entities is possible, but multiple entities cannot own it.
47+
Identus' multi-tenancy capabilities allow for the sharing of wallets among multiple entities. This feature facilitates collaborative work and resource sharing while preserving data isolation within the shared wallet. The entity can own only one wallet. Sharing it with other entities is possible, but multiple entities cannot own it.
4848

4949
### Tenant Management
50-
Tenant Management is the process of onboarding, provisioning, and managing entities and wallets within the PRISM platform. Administrators can configure each entity's permissions, resources, and access control, ensuring efficient and secure multi-tenancy operations.
50+
Tenant Management is the process of onboarding, provisioning, and managing entities and wallets within the Identus platform. Administrators can configure each entity's permissions, resources, and access control, ensuring efficient and secure multi-tenancy operations.
5151

5252
### DIDComm Connections
53-
DIDComm Connections are the secure communication channels between peers within the SSI ecosystem. PRISM's multi-tenancy model ensures that the connections of one entity are logically isolated from those of other entities, preserving data privacy and security. Based on the DID-Peer of the message recipient, the corresponding wallet processes the message.
53+
DIDComm Connections are the secure communication channels between peers within the SSI ecosystem. Identus' multi-tenancy model ensures that the connections of one entity are logically isolated from those of other entities, preserving data privacy and security. Based on the DID-Peer of the message recipient, the corresponding wallet processes the message.
5454

5555
### Webhook Notifications
5656
Webhook notifications enable users to receive alerts for specific events in the system. There are two types of webhook notifications:
@@ -59,15 +59,15 @@ Webhook notifications enable users to receive alerts for specific events in the
5959

6060
## Relation Diagram
6161

62-
The following diagram illustrates the relationship between the key components of PRISM's multi-tenancy model.
62+
The following diagram illustrates the relationship between the key components of Identus' multi-tenancy model.
6363

6464

6565
```mermaid
6666
graph TB;
6767
Tenant(Tenant) --> |Represented by| Entity
6868
Tenant --> |Authenticates by| AuthMethod(Authentication Method)
6969
70-
subgraph PRISM Platform
70+
subgraph Identus Platform
7171
Wallet(Wallet) -->|Contains| DIDs(DIDs )
7272
Wallet(Wallet) -->|Contains| VCs(Verifiable Credentials)
7373
Wallet(Wallet) -->|Contains| VSSchemas(VC Schemas)

documentation/docs/atala-prism/prism-cloud-agent/authentication.md renamed to documentation/docs/identus/cloud-agent/authentication.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ resource.
77
Authentication and authorization are critical to any identity management system, ensuring only authorized
88
users can access the system and its resources.
99

10-
PRISM Cloud Agent provides the following authentication and authorization methods to ensure that the identity of the
10+
Cloud Agent provides the following authentication and authorization methods to ensure that the identity of the
1111
entity is verified and authenticated during interactions with the platform:
1212

1313
- apikey authentication with internal IAM service
@@ -16,7 +16,7 @@ entity is verified and authenticated during interactions with the platform:
1616

1717
## Default Entity and Wallet
1818

19-
The PRISM Cloud Agent uses the Default Entity and the Default Wallet for all interactions with the Agent over the REST API and DIDComm in the single-tenant mode.
19+
The Cloud Agent uses the Default Entity and the Default Wallet for all interactions with the Agent over the REST API and DIDComm in the single-tenant mode.
2020
A Default Entity is an entity with the id `00000000-0000-0000-0000-000000000000`, and a Default Wallet is a wallet with the id `00000000-0000-0000-0000-000000000000`.
2121

2222

@@ -108,7 +108,7 @@ processes.
108108
Keycloak supports various identity protocols, including OAuth 2.0 and OpenID Connect, making it a versatile solution for
109109
securing modern web applications.
110110

111-
The PRISM Cloud Agent utilizes the following Keycloak features:
111+
The Cloud Agent utilizes the following Keycloak features:
112112

113113
- Authentication with JWT Token with a configured flow according to
114114
the [ADR](https://staging-docs.atalaprism.io/adrs/adr/20230527-use-keycloak-and-jwt-tokens-for-authentication-and-authorisation-to-facilitate-multitenancy-in-cloud-agent/)

documentation/docs/atala-prism/prism-cloud-agent/building-blocks.md renamed to documentation/docs/identus/cloud-agent/building-blocks.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Building Blocks
22

3-
Atala PRISM is a toolset for implementing decentralized identity and consists of several core building blocks. These building blocks are modular components that can be easily combined and configured to meet various use cases and product requirements. By abstracting these fundamental components into modular building blocks, Atala PRISM allows for rapid development and deployment of new features and capabilities for its [Cloud Agents](/docs/concepts/glossary#cloud-agent).
3+
Identus is a toolset for implementing decentralized identity and consists of several core building blocks. These building blocks are modular components that can be easily combined and configured to meet various use cases and product requirements. By abstracting these fundamental components into modular building blocks, Identus allows for rapid development and deployment of new features and capabilities for its [Cloud Agents](/docs/concepts/glossary#cloud-agent).
44

55
This modular architecture also provides excellent flexibility and customization options, as different building blocks can be combined in various ways to fit specific use case requirements. However, in the future, some unique use cases may arise that require designing and developing new building blocks. The Atala team continuously improves and expands the suite's capabilities to meet its users' evolving needs.
66

7-
Below is a brief overview of the current building blocks of Atala PRISM:
7+
Below is a brief overview of the current building blocks of Identus:
88

99
**Building Block**|**Definition**|**Code Name**
1010
:-----:|:-----:|:-----:
@@ -14,7 +14,7 @@ Cryptography|A set of cryptographic primitives that ensure the integrity, authen
1414
[DIDComm](/docs/concepts/glossary#didcomm) V2|A set of secure, standards-based communications protocols to establish and manage trusted, peer-to-peer connections and interactions between DIDs in a transport-agnostic and interoperable manner.|Mercury
1515

1616
## Apollo - Cryptography Module
17-
Apollo is one of the building blocks of Atala PRISM. It is a suite of cryptographic primitives ensuring data security during storage and handling. Cryptographic primitives are mathematical algorithms and protocols that form the foundation for secure communication and data protection.
17+
Apollo is one of the building blocks of Identus. It is a suite of cryptographic primitives ensuring data security during storage and handling. Cryptographic primitives are mathematical algorithms and protocols that form the foundation for secure communication and data protection.
1818

1919
The primary purpose of Apollo is to provide data integrity, authenticity, and confidentiality, which are essential components of secure information systems. Apollo ensures that tampering, unauthorized access, and other security threats do not compromise the protection of user data, giving users confidence in its security.
2020

@@ -24,11 +24,11 @@ For authenticity, Apollo uses digital signatures to authenticate the identity of
2424

2525
Finally, for confidentiality, Apollo uses encryption algorithms to protect sensitive data from unauthorized access and exposure. This feature helps ensure that sensitive information remains confidential and protected against cyber-attacks and data breaches.
2626

27-
Overall, the Apollo building block is an essential component of Atala PRISM, providing a secure and reliable means of protecting data stored and processed within the platform.
27+
Overall, the Apollo building block is an essential component of Identus, providing a secure and reliable means of protecting data stored and processed within the platform.
2828

2929
## Castor - DID Module
3030

31-
Castor is a building block of Atala PRISM that provides a set of DID operations, allowing users to create, manage, and resolve DIDs.
31+
Castor is a building block of Identus that provides a set of DID operations, allowing users to create, manage, and resolve DIDs.
3232

3333
A [DID Document](/docs/concepts/glossary#did-document) is a JSON-LD document that contains information about a DID. It includes information such as the public keys associated with the DID, the authentication mechanisms, and linked services. Castor consists of a resolver that resolves a DID to its associated DID Document. The lookup service allows users to retrieve the DID Document for a given DID.
3434

@@ -38,7 +38,7 @@ Castor gives users complete control over their DIDs, including creating new DIDs
3838

3939
## Pollux - Verifiable Credential Module
4040

41-
Pollux is a building block of Atala PRISM that provides a set of operations for managing and verifying verifiable credentials (VCs). This building block is a vital aspect of the [self-sovereign identity](/docs/concepts/glossary#self-sovereign-identity) paradigm. With Pollux, users can issue, manage, and verify VCs in a privacy-preserving manner. Pollux ensures that users can share their credentials with others while maintaining control over their personal information and protecting it from unauthorized access and exposure.
41+
Pollux is a building block of Identus that provides a set of operations for managing and verifying verifiable credentials (VCs). This building block is a vital aspect of the [self-sovereign identity](/docs/concepts/glossary#self-sovereign-identity) paradigm. With Pollux, users can issue, manage, and verify VCs in a privacy-preserving manner. Pollux ensures that users can share their credentials with others while maintaining control over their personal information and protecting it from unauthorized access and exposure.
4242

4343
In terms of issuing credentials, Pollux provides the necessary functions to create and issue VCs, including the ability to specify the type of credential, the attributes it represents, and the trusted party attesting to the credentials.
4444

@@ -48,6 +48,6 @@ Finally, for verifying credentials, Pollux provides the tools to check a given c
4848

4949
## Mercury - DIDComm Module
5050

51-
Mercury is a building block of Atala PRISM that provides a set of secure, standards-based communication protocols and infrastructure for establishing and managing trusted, peer-to-peer connections between decentralized identifiers. DIDs allow their owners to manage their identity and interact with others in a privacy-preserving manner.
51+
Mercury is a building block of Identus that provides a set of secure, standards-based communication protocols and infrastructure for establishing and managing trusted, peer-to-peer connections between decentralized identifiers. DIDs allow their owners to manage their identity and interact with others in a privacy-preserving manner.
5252

5353
Additionally, using standards-based protocols ensures that the communication between DIDs is interoperable, meaning that different systems and platforms can communicate seamlessly.

0 commit comments

Comments
 (0)