Skip to content

Commit

Permalink
Add docs for Organisation an key import
Browse files Browse the repository at this point in the history
  • Loading branch information
niondir committed Aug 30, 2024
1 parent 575f87f commit 33e5039
Show file tree
Hide file tree
Showing 11 changed files with 70 additions and 4 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/platform/organisation/img/button-import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/platform/organisation/img/import-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/platform/organisation/img/users-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 32 additions & 2 deletions docs/platform/organisation/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@
---
draft: true
draft: false
---

# Organisation (TODO)
# Organisation

:::info[Required roles]
* **org-admin**
:::

The Organisation page allows to manage Organisation related settings like Name, Logo, Users, etc.

![organisation-page.png](img/organisation-page.png)

## Settings

Manage the Name, Logo and other organisation related settings.

## wMbus Keys

See: [wMbus Keys](wmbus-keys)

## Users

Manage Users and Roles inside the organisation.

![users-page.png](img/users-page.png)

### Roles

| Role | Rights | Comment |
|--------------|---------------------------------------------------------------------------------------------------|-----------------------------------------------------|
| admin | Global Platform Admin<br/>Can access all Organisations. | Admin users can only seen by other platform admins. |
| org&#x2011;admin | Organisation Admin<br/>Can edit all Organisation related data including Devices and Integrations. | |
| device&#x2011;admin | Device Admin<br/>Can edit all Device related data inside the Organisation. | |
40 changes: 38 additions & 2 deletions docs/platform/organisation/wmbus-keys.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@
---
draft: true
draft: false
---

# wMbus Keys (TODO)
# wMbus Keys

:::info[Required roles]
* **org-admin**
:::

## Import

![img.png](img/button-import.png)

Allows to import Keys from CSV. The page offers compatible examples to be used as template for the import.

![img.png](img/import-dialog.png)


### Import via Key Exchange Platform

You do need an account in the Exchange Plattform, see: https://exchange-platform.app/

![sonexa-meine-firma.png](img/sonexa-meine-firma.png)


Generate a new Token

![button-generate-api-token.png](img/button-generate-api-token.png)

Add a Label and select "Device API"

![dialog-api-token.png](img%2Fdialog-api-token.png)

The Token will appear in the table, copy the token for usage in the Lobaro Platform.

![table-api-authentication.png](img%2Ftable-api-authentication.png)

Enter the Token in the Lobaro Platform under `Organisation → wMbus Keys → Import → Key Exchange Platform`:

![dialog-import-key-exchange.png](img%2Fdialog-import-key-exchange.png)

0 comments on commit 33e5039

Please sign in to comment.