@3sixty/node 0.0.0-stage → 0.20.0-next.0

package/docs/commands/tenant-create.md

@@ -0,0 +1,55 @@
+# tenant-create
+
+Create a tenant with associated api key.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```text
+tenant-create: Create a tenant with associated api key
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+tenant-id: (string, hex(32), optional)
+The tenant ID to add. If not provided a random tenant id will be generated.
+
+api-key: (string, hex(32), optional)
+The API key to associate with the tenant id. If not provided, a random key will be generated.
+
+organization-id: (string, did, required)
+The organization DID to associate with the tenant.
+
+public-origin: (string, url, optional)
+The public URL origin for the tenant e.g. https://example.com:1234
+
+label: (string, optional)
+A descriptive label for the tenant.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+output-json: (string, optional)
+Path to a .json file to store the command output.
+
+output-env: (string, optional)
+Path to a .env file to store the command output.
+
+output-env-prefix: (string, optional)
+Prefix to use for variables in the output .env file.
+
+Example: tenant-create --tenant-id="0011..aabb" --api-key="aabb..0099" --organization-id="did:iota:..." --label="My Tenant" --public-origin="https://example.com:1234"
+```
+
+## Examples
+
+Create the node tenant for an organisation:
+
+```shell
+3sixty-node tenant-create --load-env="organization-identity.env" --organization-id=!ORGANIZATION_DID --label="Node" --output-json="node-tenant.json" --output-env="node-tenant.env" --output-env-prefix=node
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/tenant-get.md

@@ -0,0 +1,34 @@
+# tenant-get
+
+Get the full configuration record for a single tenant.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```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"
+```
+
+## Examples
+
+Get the full record for a tenant:
+
+```shell
+3sixty-node tenant-get --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/tenant-import.md

@@ -0,0 +1,46 @@
+# tenant-import
+
+Import a tenant with associated api key.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```text
+tenant-import: Import a tenant with associated api key
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+tenant-id: (string, hex(32), required)
+The tenant ID to import.
+
+api-key: (string, hex(32), required)
+The API key to associate with the tenant id.
+
+organization-id: (string, did, required)
+The organization DID to associate with the tenant.
+
+label: (string, optional)
+A descriptive label for the tenant.
+
+public-origin: (string, url, optional)
+The public URL origin for the tenant e.g. https://example.com:1234
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: tenant-import --tenant-id="0011..aabb" --api-key="aabb..0099" --organization-id="did:iota:..." --label="My Tenant" --public-origin="https://example.com:1234"
+```
+
+## Examples
+
+Import an existing tenant:
+
+```shell
+3sixty-node tenant-import --load-env="node-tenant.env,organization-identity.env" --tenant-id=!NODE_TENANT_ID --api-key=!NODE_API_KEY --organization-id=!ORGANIZATION_DID --label="Node" --public-origin="https://api.example.com"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/tenant-list-by-org.md

@@ -0,0 +1,34 @@
+# tenant-list-by-org
+
+List all tenants associated with a given organization DID.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```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:..."
+```
+
+## Examples
+
+List the tenants for an organisation:
+
+```shell
+3sixty-node tenant-list-by-org --load-env="organization-identity.env" --org-id=!ORGANIZATION_DID
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/tenant-list.md

@@ -0,0 +1,31 @@
+# tenant-list
+
+List all tenants.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```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
+```
+
+## Examples
+
+List all tenants:
+
+```shell
+3sixty-node tenant-list
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/tenant-org-alias-remove.md

@@ -0,0 +1,39 @@
+# tenant-org-alias-remove
+
+Remove an alias from the tenant organization ID legacy list.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```text
+tenant-org-alias-remove: Remove an alias from the tenant organization ID legacy list
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+tenant-id: (string, hex(32), required)
+The tenant ID to update.
+
+alias: (string, did, required)
+The organization DID alias to remove from the legacy list.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Deprecated aliases: remove-tenant-org-alias
+
+Example: tenant-org-alias-remove --tenant-id="0011..aabb" --alias="did:iota:..."
+```
+
+## Examples
+
+Remove a stale organisation alias from a tenant:
+
+```shell
+3sixty-node tenant-org-alias-remove --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID --alias=!OLD_ORGANIZATION_DID
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/tenant-org-id-set.md

@@ -0,0 +1,39 @@
+# tenant-org-id-set
+
+Set the organization ID for a tenant.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```text
+tenant-org-id-set: Set the organization ID for a 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 update.
+
+organization-id: (string, did, required)
+The organization DID to set as the tenant organization ID.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Deprecated aliases: set-tenant-org-id
+
+Example: tenant-org-id-set --tenant-id="0011..aabb" --organization-id="did:iota:..."
+```
+
+## Examples
+
+Associate an organisation with the node tenant:
+
+```shell
+3sixty-node tenant-org-id-set --load-env="node-tenant.env,organization-identity.env" --tenant-id=!NODE_TENANT_ID --organization-id=!ORGANIZATION_DID
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/tenant-remove.md

@@ -0,0 +1,34 @@
+# tenant-remove
+
+Remove a tenant.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```text
+tenant-remove: Remove a 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 remove.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: tenant-remove --tenant-id="0011..aabb"
+```
+
+## Examples
+
+Remove a tenant:
+
+```shell
+3sixty-node tenant-remove --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/tenant-update.md

@@ -0,0 +1,46 @@
+# tenant-update
+
+Update a tenant with associated api key.
+
+## Tenancy
+
+Multi-tenant mode only. In single-tenant mode the command fails because the tenant admin component is not registered.
+
+## Usage
+
+```text
+tenant-update: Update a tenant with associated api key
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+tenant-id: (string, hex(32), required)
+The tenant ID to update.
+
+api-key: (string, hex(32), optional)
+The API key to associate with the tenant id.
+
+organization-id: (string, did, optional)
+The organization DID to associate with the tenant.
+
+label: (string, optional)
+A descriptive label for the tenant.
+
+public-origin: (string, url, optional)
+The public URL origin for the tenant e.g. https://example.com:1234
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: tenant-update --tenant-id="0011..aabb" --api-key="aabb..0099" --label="My Tenant" --public-origin="https://example.com:1234"
+```
+
+## Examples
+
+Update the label of a tenant:
+
+```shell
+3sixty-node tenant-update --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID --label="New Label"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/user-create.md

@@ -0,0 +1,73 @@
+# user-create
+
+Create a user.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode. In multi-tenant mode `--tenant-id` is required, in single-tenant mode it must not be supplied.
+
+## Usage
+
+```text
+user-create: Create a user
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+user-identity: (string, DID, required)
+The DID to associate the user with.
+
+organization-identity: (string, DID, required)
+The organization DID to associate the user with.
+
+tenant-id: (string, hex(32), optional)
+The tenant ID to associate the user with (multi-tenant mode only).
+
+email: (string, email, required)
+The email address of the user.
+
+password: (string, optional)
+The password for the user.
+
+scope: (string, optional)
+List of scopes to associate with the user, comma separated.
+
+given-name: (string, optional)
+The given name of the user.
+
+family-name: (string, optional)
+The family name of the user.
+
+overwrite-mode: (string, default: 'skip', optional, options: [skip, overwrite, error])
+The mode to use when a user with the same identity already exists.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+output-json: (string, optional)
+Path to a .json file to store the command output.
+
+output-env: (string, optional)
+Path to a .env file to store the command output.
+
+output-env-prefix: (string, optional)
+Prefix to use for variables in the output .env file.
+
+Example: user-create --user-identity="did:iota:...." --organization-identity="did:iota:...." --email="bob@examples.com" --password="pass1234" --scope="tenant-admin" --givenName="Bob" --familyName="Smith"
+```
+
+## Examples
+
+Create a user in single-tenant mode:
+
+```shell
+3sixty-node user-create --load-env="organization-identity.env,admin-user-identity.env" --user-identity=!ADMIN_USER_DID --organization-identity=!ORGANIZATION_DID --email="admin@node" --given-name="Node" --family-name="Admin" --scope="user-admin" --output-json="user-account-admin.json" --output-env="user-account-admin.env" --output-env-prefix=admin
+```
+
+Create a user in multi-tenant mode:
+
+```shell
+3sixty-node user-create --load-env="organization-identity.env,admin-user-identity.env,node-tenant.env" --user-identity=!ADMIN_USER_DID --organization-identity=!ORGANIZATION_DID --tenant-id=!NODE_TENANT_ID --email="admin@tenant" --scope="tenant-admin,user-admin" --output-json="user-account-admin.json"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/user-get.md

@@ -0,0 +1,43 @@
+# user-get
+
+Get a user by email address.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode. In multi-tenant mode `--tenant-id` is required, in single-tenant mode it must not be supplied.
+
+## Usage
+
+```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"
+```
+
+## Examples
+
+Get a user in single-tenant mode:
+
+```shell
+3sixty-node user-get --email="admin@node"
+```
+
+Get a user in multi-tenant mode:
+
+```shell
+3sixty-node user-get --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID --email="admin@tenant"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/user-remove.md

@@ -0,0 +1,43 @@
+# user-remove
+
+Remove a user and their identity profile.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode. In multi-tenant mode `--tenant-id` is required, in single-tenant mode it must not be supplied.
+
+## Usage
+
+```text
+user-remove: Remove a user and their identity profile
+
+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 remove.
+
+tenant-id: (string, hex(32), optional)
+The tenant ID the user belongs to (multi-tenant mode only).
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: user-remove --email="user@example.com" --tenant-id="0011..aabb"
+```
+
+## Examples
+
+Remove a user and their identity profile in single-tenant mode:
+
+```shell
+3sixty-node user-remove --email="bob@example.com"
+```
+
+Remove a user in multi-tenant mode:
+
+```shell
+3sixty-node user-remove --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID --email="bob@example.com"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/user-update-password.md

@@ -0,0 +1,58 @@
+# user-update-password
+
+Update the password of a user.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode. In multi-tenant mode `--tenant-id` is required, in single-tenant mode it must not be supplied. The new password must satisfy the password policy of the authentication service.
+
+## Usage
+
+```text
+user-update-password: Update the password of a user
+
+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 update.
+
+password: (string, optional)
+The new password. If not provided a random password will be generated.
+
+current-password: (string, optional)
+The current password, verified before the change when provided.
+
+tenant-id: (string, hex(32), optional)
+The tenant ID the user belongs to (multi-tenant mode only).
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+output-json: (string, optional)
+Output the details of the password update to a JSON file.
+
+output-env: (string, optional)
+Output the details of the password update to an .env file.
+
+output-env-prefix: (string, optional)
+Prefix to use for variables in the output .env file.
+
+Example: user-update-password --email="user@example.com" --tenant-id="0011..aabb" --output-env="user-password.env"
+```
+
+## Examples
+
+Generate a new password for a user and store it in an .env file:
+
+```shell
+3sixty-node user-update-password --email="bob@example.com" --output-env="bob-password.env"
+```
+
+Set a specific password in multi-tenant mode, verifying the current password first:
+
+```shell
+3sixty-node user-update-password --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID --email="bob@example.com" --current-password="..." --password="..."
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.

package/docs/commands/user-update.md

@@ -0,0 +1,58 @@
+# user-update
+
+Update a user.
+
+## Tenancy
+
+Available in single-tenant and multi-tenant mode. In multi-tenant mode `--tenant-id` is required, in single-tenant mode it must not be supplied.
+
+## Usage
+
+```text
+user-update: Update a user
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+user-identity: (string, DID, optional)
+The DID to associate the user with.
+
+organization-identity: (string, DID, optional)
+The organization DID to associate the user with.
+
+tenant-id: (string, hex(32), optional)
+The tenant ID to associate the user with (multi-tenant mode only).
+
+email: (string, email, required)
+The email address of the user.
+
+scope: (string, optional)
+List of scopes to associate with the user, comma separated.
+
+given-name: (string, optional)
+The given name of the user.
+
+family-name: (string, optional)
+The family name of the user.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+Example: user-update --email="bob@examples.com" --user-identity="did:iota:...." --organization-identity="did:iota:...." --scope="tenant-admin" --givenName="Bob" --familyName="Smith"
+```
+
+## Examples
+
+Update the scope of a user in single-tenant mode:
+
+```shell
+3sixty-node user-update --email="admin@node" --scope="user-admin,foo"
+```
+
+Update a user in multi-tenant mode:
+
+```shell
+3sixty-node user-update --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID --email="admin@tenant" --given-name="Tenant" --family-name="Admin"
+```
+
+See the [usage guide](../usage.md) for running the node and the full list of commands.