Key Value UI
From the Key Value page of the SBS portal, you can create, view, and update arbitrary key-value pairs scoped to the current account, application, and tenant. Key-value pairs are useful for storing small pieces of configuration data or application-specific metadata.
Access
You can access the Key Value page of the portal as follows:
- Sign in to the SBS Portal. During the sign-in process, you will be prompted to select the account, app, and tenant where you are entitled to sign in.
- Click Key Value in the left-hand side menu.
View key-value entries
The Key Value page displays all existing entries in a grid with the following columns:
| Column | Description |
|---|---|
| Key | The unique identifier of the entry. |
| Created At | The date and time when the entry was created. |
| Updated At | The date and time when the entry was last updated. |
To view the full details of an entry, click its row in the grid. A dialog opens with the following fields:
| Field | Description |
|---|---|
| Key | The unique identifier of the entry. |
| Value | The value stored under this key. |
| Author ID | The identifier of the author who created or last updated the entry. |
| Author Name | The display name of the author. |
| Author Email | The email address of the author. |
| Author Profile | Additional profile information about the author. |
| Created At | The date and time when the entry was created. |
| Updated At | The date and time when the entry was last updated. |
Click Close to dismiss the dialog.
You can also use the Search box at the top of the grid to filter entries by key, and click any column header to sort by that column. Use the Export to CSV button to download all entries as a CSV file.
Create a key-value entry
To create a new key-value entry:
- Click + in the upper-right corner of the grid.
- Fill in the fields and then click Create.
| Field | Description |
|---|---|
| Key | Mandatory. The unique identifier for the new entry. |
| Value | The value to store under this key. |
| Author ID | The identifier of the author creating the entry. |
| Author Name | The display name of the author. |
| Author Email | The email address of the author. |
| Author Profile | Additional profile information about the author. |
Delete a key-value entry
Deleting key-value entries is not available through the portal UI. To delete an entry, use the Key Value service API.
Update a key-value entry
To update an existing entry:
- Click the edit button next to the entry in the grid.
- Modify the fields as needed, and then click Save.
| Field | Description |
|---|---|
| Value | The value stored under this key. |
| Author ID | The identifier of the author updating the entry. |
| Author Name | The display name of the author. |
| Author Email | The email address of the author. |
| Author Profile | Additional profile information about the author. |