Manage entity Domains
A Domain in IXO represents the on-chain identity record (DID Document) of a Digital Entity, providing management capabilities for verification methods, services, and access controls. Each Digital Entity is anchored by its Domain, which forms a core component of its Digital Twin implementation. Managing Domain settings allows you to configure how your Digital Entity interacts with other participants and services on the IXO network.
The IXO ID (IID) Module provides a comprehensive set of methods for managing a Domain’s properties on IXO blockchains. Each Domain has a unique identifier that resolves to a W3C-standard DID Document following the IXO ID Method specification. IIDs are IXO’s implementation of the W3C DID standard, extending it with specific features for cross-chain identity and interoperability in the Interchain ecosystem while maintaining full compatibility with the DID specification.
Key differences from standard DIDs:
Before managing Domain settings, ensure you have:
The following sections outline the key operations you can perform on your Domain’s IID Document.
Document Updates
Document updates allow you to modify multiple properties of your Domain’s IID Document in a single transaction.
When to use: When you need to make multiple changes to your Domain document at once, such as updating verification methods, controllers, and services simultaneously.
Important considerations:
Verification Methods
Verification methods define the cryptographic keys and proofs your Domain can use for authentication, authorization, and secure communication.
When to use: Add verification methods when you need to enable specific cryptographic operations for your Domain, such as digital signatures or key exchange.
Important considerations:
Services
Services allow your Domain to expose functionality to other entities. Each service has an ID, type, and endpoint.
When to use: Add services when you want to expose APIs, messaging endpoints, or other functionality through your Domain.
Important considerations:
Controllers & Resources
Controllers determine who can modify the Domain’s IID Document, while linked resources and accorded rights define what resources and rights are associated with the Domain.
When to use: Add controllers when delegating management permissions, and add resources or rights when declaring assets or capabilities associated with your Domain.
Important considerations:
Context & Deactivation
Context provides semantic meaning to your Domain document, while deactivation allows you to temporarily disable your Domain.
When to use: Add context to improve interoperability with systems that understand specific vocabularies. Deactivate a Domain when you want to temporarily suspend its operations.
Important considerations:
Following these steps will help you effectively manage your Domain settings on IXO blockchains.
Update Document Structure
Update your Domain’s IID Document structure by:
Manage Verification
Handle verification methods and relationships:
Service Management
Configure and manage Domain services:
Access Control
Manage Domain access and permissions:
Each step in the process above corresponds to specific API calls in the IXO SDK. Expand the accordions above to see the code examples for each operation, or follow the detailed guides below for common domain management tasks.
Create the Domain IID Document
First, initialize a basic Domain document with a controller:
Add Service Endpoints
Add service endpoints to make your Domain functional:
Set Up Verification Methods
Add verification methods to enable authentication:
Retrieve Current Controllers
First, get the current list of controllers:
Add New Controller
Add a new controller to the Domain:
Update Verification Relationships
Ensure the new controller has appropriate verification relationships:
Transaction Failed: Unauthorized
Invalid Verification Method
Verification methods must follow W3C DID specifications.
Solution: Ensure your verification method has all required fields and follows the correct format.
Service Endpoint Unreachable
Services added to your Domain should be operational.
Solution: Verify that your service endpoint is publicly accessible before adding it to your Domain.
Learn about the IXO identity system and how Domains fit into the broader identity framework.
Explore different verification method types and their cryptographic properties.
Discover standard service types and how to implement custom services for your Domain.
Review the W3C standard that defines the Decentralized Identifier specification.
Access comprehensive API documentation for the IXO SDK.
See real-world examples of Domains in action with sample code.
Manage entity Domains
A Domain in IXO represents the on-chain identity record (DID Document) of a Digital Entity, providing management capabilities for verification methods, services, and access controls. Each Digital Entity is anchored by its Domain, which forms a core component of its Digital Twin implementation. Managing Domain settings allows you to configure how your Digital Entity interacts with other participants and services on the IXO network.
The IXO ID (IID) Module provides a comprehensive set of methods for managing a Domain’s properties on IXO blockchains. Each Domain has a unique identifier that resolves to a W3C-standard DID Document following the IXO ID Method specification. IIDs are IXO’s implementation of the W3C DID standard, extending it with specific features for cross-chain identity and interoperability in the Interchain ecosystem while maintaining full compatibility with the DID specification.
Key differences from standard DIDs:
Before managing Domain settings, ensure you have:
The following sections outline the key operations you can perform on your Domain’s IID Document.
Document Updates
Document updates allow you to modify multiple properties of your Domain’s IID Document in a single transaction.
When to use: When you need to make multiple changes to your Domain document at once, such as updating verification methods, controllers, and services simultaneously.
Important considerations:
Verification Methods
Verification methods define the cryptographic keys and proofs your Domain can use for authentication, authorization, and secure communication.
When to use: Add verification methods when you need to enable specific cryptographic operations for your Domain, such as digital signatures or key exchange.
Important considerations:
Services
Services allow your Domain to expose functionality to other entities. Each service has an ID, type, and endpoint.
When to use: Add services when you want to expose APIs, messaging endpoints, or other functionality through your Domain.
Important considerations:
Controllers & Resources
Controllers determine who can modify the Domain’s IID Document, while linked resources and accorded rights define what resources and rights are associated with the Domain.
When to use: Add controllers when delegating management permissions, and add resources or rights when declaring assets or capabilities associated with your Domain.
Important considerations:
Context & Deactivation
Context provides semantic meaning to your Domain document, while deactivation allows you to temporarily disable your Domain.
When to use: Add context to improve interoperability with systems that understand specific vocabularies. Deactivate a Domain when you want to temporarily suspend its operations.
Important considerations:
Following these steps will help you effectively manage your Domain settings on IXO blockchains.
Update Document Structure
Update your Domain’s IID Document structure by:
Manage Verification
Handle verification methods and relationships:
Service Management
Configure and manage Domain services:
Access Control
Manage Domain access and permissions:
Each step in the process above corresponds to specific API calls in the IXO SDK. Expand the accordions above to see the code examples for each operation, or follow the detailed guides below for common domain management tasks.
Create the Domain IID Document
First, initialize a basic Domain document with a controller:
Add Service Endpoints
Add service endpoints to make your Domain functional:
Set Up Verification Methods
Add verification methods to enable authentication:
Retrieve Current Controllers
First, get the current list of controllers:
Add New Controller
Add a new controller to the Domain:
Update Verification Relationships
Ensure the new controller has appropriate verification relationships:
Transaction Failed: Unauthorized
Invalid Verification Method
Verification methods must follow W3C DID specifications.
Solution: Ensure your verification method has all required fields and follows the correct format.
Service Endpoint Unreachable
Services added to your Domain should be operational.
Solution: Verify that your service endpoint is publicly accessible before adding it to your Domain.
Learn about the IXO identity system and how Domains fit into the broader identity framework.
Explore different verification method types and their cryptographic properties.
Discover standard service types and how to implement custom services for your Domain.
Review the W3C standard that defines the Decentralized Identifier specification.
Access comprehensive API documentation for the IXO SDK.
See real-world examples of Domains in action with sample code.