@twin.org/node 0.9.1-next.3 → 0.9.1-next.4

package/dist/locales/en.json

@@ -1,9 +1,9 @@
 {
 	"error": {
 		"node": {
-			"nodeIdentityNotSet": "The node identity is enabled in config but is not set, please set it using the \"node-set-identity\" CLI command.",
-			"nodeOrganizationIdNotSet": "The node organization is not set, please set it using the \"set-node-org-id\".",
-			"tenantsWithoutOrganizationId": "The following tenants have no organization ID assigned. Use the \"set-tenant-org-id\" command to assign one before starting the node: {tenantIds}",
+			"nodeIdentityNotSet": "The node identity is enabled in config but is not set, please set it using the \"node-identity-set\" CLI command.",
+			"nodeOrganizationIdNotSet": "The node organization is not set, please set it using the \"node-org-id-set\".",
+			"tenantsWithoutOrganizationId": "The following tenants have no organization ID assigned. Use the \"tenant-org-id-set\" command to assign one before starting the node: {tenantIds}",
 			"storageFileRootNotSet": "{storageFileRoot} is not set, the server will not start without it, please set it in the shell or create a .env file",
 			"extensionLoadingError": "Failed to load extension \"{extension}\"",
 			"insecureProtocol": "Cannot load extension from insecure protocol: {protocol}. Only HTTPS is allowed for remote extensions.",
@@ -18,7 +18,7 @@
 		},
 		"bootstrapLegacy": {
 			"noFeaturesEnabled": "No features are enabled in legacy bootstrap mode, at least one feature must be enabled.",
-			"organizationNotSet": "The organisation identity has not been set. Run \"set-node-org-id\"."
+			"organizationNotSet": "The organisation identity has not been set. Run \"node-org-id-set\"."
 		},
 		"identityCreate": {
 			"invalidMnemonic": "The mnemonic is invalid, it should be 24 words from the standard wordlist.",
@@ -49,17 +49,27 @@
 			"userAlreadyExists": "The user with ID already exists and overwriteMode is set to \"error\".",
 			"tenantIdRequired": "The tenant ID is required when multi-tenancy is enabled."
 		},
+		"userGet": {
+			"tenantIdRequired": "The tenant ID is required when multi-tenancy is enabled."
+		},
 		"userUpdate": {
 			"tenantIdRequired": "The tenant ID is required when multi-tenancy is enabled."
 		},
+		"orgUsersList": {
+			"orgDidRequired": "The organization DID is required in multi-tenant mode. Provide --org-did or switch to single-tenant mode."
+		},
 		"vaultKeyCreate": {
 			"vaultKeyAlreadyExists": "The vault key with ID already exists and overwriteMode is set to \"error\"."
 		},
-		"nodeSetIdentity": {
+		"nodeIdentitySet": {
 			"identityNotFound": "The identity with DID \"{notFoundId}\" was not found in the system."
 		},
-		"setNodeOrgId": {
-			"notAvailableInMultiTenantMode": "The set-node-org-id command is not available in multi-tenant mode, use set-tenant-org-id instead."
+		"nodeOrgIdGet": {
+			"notAvailableInMultiTenantMode": "The node-org-id-get command is not available in multi-tenant mode, use tenant-org-id-set instead.",
+			"nodeOrganizationIdNotSet": "The node organization ID is not set. Use \"node-org-id-set\" to set it first."
+		},
+		"nodeOrgIdSet": {
+			"notAvailableInMultiTenantMode": "The node-org-id-set command is not available in multi-tenant mode, use tenant-org-id-set instead."
 		},
 		"applyOrganizationIdToTenant": {
 			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
@@ -68,6 +78,21 @@
 			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command.",
 			"aliasNotFound": "The alias \"{alias}\" was not found in the tenant organization legacy list."
 		},
+		"tenantList": {
+			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
+		},
+		"tenantGet": {
+			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
+		},
+		"tenantListByOrg": {
+			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
+		},
+		"nodeIdentityGet": {
+			"nodeIdentityNotSet": "The node identity is not set. Use \"node-identity-set\" to set it first."
+		},
+		"identityResolve": {
+			"identityNotFound": "The identity \"{identity}\" was not found."
+		},
 		"entityStorageAuthenticationService": {
 			"loginFailed": "Login failed",
 			"userNotFound": "The user with the specified e-mail could not be found",
@@ -353,7 +378,10 @@
 		},
 		"entityStorageHelper": {
 			"sortNotIndexed": "The property \"{property}\" is not indexed and cannot be used for sorting",
-			"propertyNotInSchema": "The property \"{property}\" does not exist in the schema and cannot be used for projection"
+			"propertyNotInSchema": "The property \"{property}\" does not exist in the schema and cannot be used for projection",
+			"unknownPropertyInConditionProperty": "The property \"{property}\" is not a recognised schema property and cannot be used as a condition property",
+			"unknownPropertyInConditions": "The property \"{property}\" is not a recognised schema property and cannot be used in conditions",
+			"invalidConditionPropertyPath": "The property \"{property}\" has an invalid path: the root must be an object or array type, segments must not exceed 128 characters, and must not contain SQL metacharacters or control characters"
 		},
 		"migrationHelper": {
 			"migrateSchemaFailed": "Migration failed for schema \"{schemaName}\".",
@@ -1433,11 +1461,13 @@
 		"cli": {
 			"commands": {
 				"command": "Command",
+				"deprecatedAlias": "\"{alias}\" is a deprecated alias, please use \"{command}\" instead.",
 				"help": {
 					"description": "Display help information about CLI commands",
 					"labels": {
 						"commands": "All the commands available are listed below, for more information use the --help option with a specific command.",
 						"example": "Example",
+						"aliases": "Deprecated aliases",
 						"optional": "optional",
 						"required": "required",
 						"default": "default",
@@ -1682,9 +1712,9 @@
 						"publicKeyHex": "Public Key Hex"
 					}
 				},
-				"node-set-identity": {
+				"node-identity-set": {
 					"description": "Set the node identity",
-					"example": "node-set-identity --identity=\"did:iota...\"",
+					"example": "node-identity-set --identity=\"did:iota...\"",
 					"params": {
 						"env-prefix": {
 							"description": "Prefix to use for standard .env files e.g. TWIN_."
@@ -1808,6 +1838,31 @@
 						"updated": "Updated tenant"
 					}
 				},
+				"user-get": {
+					"description": "Get a user by email address",
+					"example": "user-get --email=\"bob@example.com\"",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"email": {
+							"description": "The email address of the user to retrieve."
+						},
+						"tenant-id": {
+							"description": "The tenant ID to retrieve the user from (multi-tenant mode only)."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"retrieving": "Retrieving user",
+						"email": "Email",
+						"identity": "Identity",
+						"organization": "Organization",
+						"scope": "Scope"
+					}
+				},
 				"user-create": {
 					"description": "Create a user",
 					"example": "user-create --user-identity=\"did:iota:....\" --organization-identity=\"did:iota:....\" --email=\"bob@examples.com\" --password=\"pass1234\" --scope=\"tenant-admin\" --givenName=\"Bob\" --familyName=\"Smith\"",
@@ -1950,9 +2005,24 @@
 						"publicKeyHex": "Public Key Hex"
 					}
 				},
-				"set-node-org-id": {
+				"node-org-id-get": {
+					"description": "Get the organization ID currently assigned to the node",
+					"example": "node-org-id-get",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"organizationId": "Organization ID"
+					}
+				},
+				"node-org-id-set": {
 					"description": "Set the node organization ID",
-					"example": "set-node-org-id --organization-id=\"did:iota:...\"",
+					"example": "node-org-id-set --organization-id=\"did:iota:...\"",
 					"params": {
 						"env-prefix": {
 							"description": "Prefix to use for standard .env files e.g. TWIN_."
@@ -1968,9 +2038,9 @@
 						"stored": "The node organization ID has been stored"
 					}
 				},
-				"set-tenant-org-id": {
+				"tenant-org-id-set": {
 					"description": "Set the organization ID for a tenant",
-					"example": "set-tenant-org-id --tenant-id=\"0011..aabb\" --organization-id=\"did:iota:...\"",
+					"example": "tenant-org-id-set --tenant-id=\"0011..aabb\" --organization-id=\"did:iota:...\"",
 					"params": {
 						"env-prefix": {
 							"description": "Prefix to use for standard .env files e.g. TWIN_."
@@ -2040,6 +2110,151 @@
 						"importing": "Importing key",
 						"imported": "Imported key"
 					}
+				},
+				"tenant-list": {
+					"description": "List all tenants",
+					"example": "tenant-list",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"listing": "Listing tenants",
+						"tenantId": "Tenant ID",
+						"apiKey": "API Key",
+						"organizationId": "Organization ID",
+						"label": "Label",
+						"count": "Total tenants"
+					}
+				},
+				"tenant-get": {
+					"description": "Get the full configuration record for a single tenant",
+					"example": "tenant-get --tenant-id=\"0011..aabb\"",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"tenant-id": {
+							"description": "The tenant ID to retrieve."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"retrieving": "Retrieving tenant",
+						"tenantId": "Tenant ID",
+						"apiKey": "API Key",
+						"organizationId": "Organization ID",
+						"label": "Label",
+						"publicOrigin": "Public Origin",
+						"dateCreated": "Date Created",
+						"dateModified": "Date Modified"
+					}
+				},
+				"tenant-list-by-org": {
+					"description": "List all tenants associated with a given organization DID",
+					"example": "tenant-list-by-org --org-id=\"did:iota:...\"",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"org-id": {
+							"description": "The organization DID to filter tenants by."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"listing": "Listing tenants for organization",
+						"tenantId": "Tenant ID",
+						"apiKey": "API Key",
+						"organizationId": "Organization ID",
+						"label": "Label",
+						"count": "Total tenants"
+					}
+				},
+				"node-identity-get": {
+					"description": "Get the identity currently assigned to the node",
+					"example": "node-identity-get",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"resolving": "Resolving node identity",
+						"did": "DID",
+						"verificationMethods": "Verification Methods"
+					}
+				},
+				"identity-list": {
+					"description": "List all identities held in custody by the node",
+					"example": "identity-list",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"listing": "Listing identities",
+						"did": "DID",
+						"controller": "Controller",
+						"count": "Total identities"
+					}
+				},
+				"identity-resolve": {
+					"description": "Resolve an identity DID to its full document",
+					"example": "identity-resolve --identity=\"did:iota:...\"",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"identity": {
+							"description": "The DID to resolve."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"resolving": "Resolving identity",
+						"did": "DID",
+						"verificationMethods": "Verification Methods"
+					}
+				},
+				"org-users-list": {
+					"description": "List all users belonging to an organization DID",
+					"example": "org-users-list --org-did=\"did:iota:...\"",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"org-did": {
+							"description": "The organization DID to list users for. Defaults to the node organization ID in single-tenant mode."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"listing": "Listing organization users",
+						"email": "Email",
+						"identity": "Identity",
+						"scope": "Scope",
+						"count": "Total users"
+					}
 				}
 			}
 		}

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.9.1-next.4](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.3...node-v0.9.1-next.4) (2026-07-01)
+
+
+### Features
+
+* additional cli commands ([#269](https://github.com/iotaledger/twin-node/issues/269)) ([c9e7c93](https://github.com/iotaledger/twin-node/commit/c9e7c939aedfceed9cbe501f2dc936e84289ed62))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/node-core bumped from 0.9.1-next.3 to 0.9.1-next.4
+
 ## [0.9.1-next.3](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.2...node-v0.9.1-next.3) (2026-06-30)
 
 

package/docs/usage.md

@@ -28,17 +28,26 @@ All the commands available are listed below, for more information use the --help
 bootstrap-legacy: Bootstrap in legacy mode for backwards compatibility, **will be deprecated in future versions**
 identity-create: Create an identity
 identity-import: Import an identity
+identity-list: List all identities held in custody by the node
+identity-resolve: Resolve an identity DID to its full document
 identity-verification-method-create: Create an identity verification method
 identity-verification-method-import: Import an identity verification method
 identity-verifiable-credential-create: Create a verifiable credential
-node-set-identity: Set the node identity
+node-identity-get: Get the identity currently assigned to the node
+node-identity-set: Set the node identity
+org-users-list: List all users belonging to an organization DID
 remove-tenant-org-alias: Remove an alias from the tenant organization ID legacy list
-set-node-org-id: Set the node organization ID
-set-tenant-org-id: Set the organization ID for a tenant
+node-org-id-get: Get the organization ID currently assigned to the node
+node-org-id-set: Set the node organization ID
+tenant-org-id-set: Set the organization ID for a tenant
 tenant-create: Create a tenant with associated api key
+tenant-get: Get the full configuration record for a single tenant
 tenant-import: Import a tenant with associated api key
+tenant-list: List all tenants
+tenant-list-by-org: List all tenants associated with a given organization DID
 tenant-update: Update a tenant with associated api key
 user-create: Create a user
+user-get: Get a user by email address
 user-update: Update a user
 vault-key-create: Create a vault key for an identity
 vault-key-import: Import a vault key for an identity
@@ -127,6 +136,150 @@ The tenant ID to set the created identity DID as the organization ID for (requir
 Example: identity-create --mnemonic="..." --fund-wallet=true
 ```
 
+## identity-list --help
+
+```text
+identity-list: List all identities held in custody by the node
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: identity-list
+```
+
+## identity-resolve --help
+
+```text
+identity-resolve: Resolve an identity DID to its full document
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+identity: (string, did, required)
+The DID to resolve.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: identity-resolve --identity="did:iota:..."
+```
+
+## node-identity-get --help
+
+```text
+node-identity-get: Get the identity currently assigned to the node
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: node-identity-get
+```
+
+## node-org-id-get --help
+
+```text
+node-org-id-get: Get the organization ID currently assigned to the node
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: node-org-id-get
+```
+
+## org-users-list --help
+
+```text
+org-users-list: List all users belonging to an organization DID
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+org-did: (string, did, optional)
+The organization DID to list users for. Defaults to the node organization ID in single-tenant mode.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: org-users-list --org-did="did:iota:..."
+```
+
+## user-get --help
+
+```text
+user-get: Get a user by email address
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+email: (string, email, required)
+The email address of the user to retrieve.
+
+tenant-id: (string, hex(32), optional)
+The tenant ID to retrieve the user from (multi-tenant mode only).
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: user-get --email="bob@example.com"
+```
+
+## tenant-get --help
+
+```text
+tenant-get: Get the full configuration record for a single tenant
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+tenant-id: (string, hex(32), required)
+The tenant ID to retrieve.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: tenant-get --tenant-id="0011..aabb"
+```
+
+## tenant-list --help
+
+```text
+tenant-list: List all tenants
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: tenant-list
+```
+
+## tenant-list-by-org --help
+
+```text
+tenant-list-by-org: List all tenants associated with a given organization DID
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+org-id: (string, did, required)
+The organization DID to filter tenants by.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: tenant-list-by-org --org-id="did:iota:..."
+```
+
 ## Example
 
 ### Bootstrap legacy (single command)
@@ -176,7 +329,7 @@ twin-node identity-verification-method-create --load-env="node-identity.env,orga
 ### Step 5 - Set the organisation identity on the node (single-tenant)
 
 ```shell
-twin-node set-node-org-id --load-env="organization-identity.env" --organization-id=!ORGANIZATION_DID
+twin-node node-org-id-set --load-env="organization-identity.env" --organization-id=!ORGANIZATION_DID
 ```
 
 ### Step 6 - Create the node tenant and associate the organisation (multi-tenant only)
@@ -186,7 +339,7 @@ twin-node tenant-create --load-env="node-identity.env" --label="Node" --output-j
 ```
 
 ```shell
-twin-node set-tenant-org-id --load-env="node-tenant.env,organization-identity.env" --tenant-id=!NODE_TENANT_ID --organization-id=!ORGANIZATION_DID
+twin-node tenant-org-id-set --load-env="node-tenant.env,organization-identity.env" --tenant-id=!NODE_TENANT_ID --organization-id=!ORGANIZATION_DID
 ```
 
 To import an existing tenant instead:
@@ -258,3 +411,85 @@ To update an existing user:
 ```shell
 twin-node user-update --load-env="organization-identity.env,admin-user-identity.env,node-tenant.env" --email="admin@node" --scope="tenant-admin,user-admin,foo"
 ```
+
+---
+
+## Inspection commands
+
+The following commands are read-only and can be run at any time to inspect the state of the node.
+
+### Get the node identity
+
+Resolves and displays the DID document currently assigned as the node identity:
+
+```shell
+twin-node node-identity-get
+```
+
+### Get the node organization ID
+
+Displays the organization DID currently assigned to the node (single-tenant only):
+
+```shell
+twin-node node-org-id-get
+```
+
+### Resolve an identity
+
+Resolve any DID to its full document, including its verification methods:
+
+```shell
+twin-node identity-resolve --identity="did:iota:..."
+```
+
+### List all identities
+
+List every identity held in custody by the node, showing each DID and its controller:
+
+```shell
+twin-node identity-list
+```
+
+### List all tenants (multi-tenant only)
+
+```shell
+twin-node tenant-list
+```
+
+### Get a single tenant (multi-tenant only)
+
+```shell
+twin-node tenant-get --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID
+```
+
+### List tenants for an organization (multi-tenant only)
+
+```shell
+twin-node tenant-list-by-org --load-env="organization-identity.env" --org-id=!ORGANIZATION_DID
+```
+
+### List users for an organization
+
+In single-tenant mode, `--org-did` can be omitted and the node organization ID is used automatically:
+
+```shell
+twin-node org-users-list
+```
+
+To list users for a specific organization:
+
+```shell
+twin-node org-users-list --load-env="organization-identity.env" --org-did=!ORGANIZATION_DID
+```
+
+### Get a single user
+
+```shell
+twin-node user-get --email="admin@node"
+```
+
+In multi-tenant mode supply the tenant ID:
+
+```shell
+twin-node user-get --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID --email="admin@node"
+```

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node",
-	"version": "0.9.1-next.3",
+	"version": "0.9.1-next.4",
 	"description": "TWIN Node serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/node-core": "0.9.1-next.3"
+		"@twin.org/node-core": "0.9.1-next.4"
 	},
 	"bugs": {
 		"url": "git+https://github.com/iotaledger/twin-node/issues"