The account section provides users with a centralized interface to manage their account settings. Users can customize their experience by configuring default workspace preferences, language settings, and notification preferences. Additionally, users can generate and manage personal key pairs for secure API and Python client interactions.
Accessing the account section
To access the Account section, log in to your account and navigate to the user avatar located in the top-right corner of the application. Click on your username and select "Account" from the dropdown menu.
The Default Workspace setting allows users to set a preferred workspace that will be automatically selected upon logging in. This streamlines the user experience by directing them to their preferred environment without manual selection.
- In the Account section, locate the "Default Workspace" dropdown.
- Choose the desired workspace from the available options.
- Click the "Save" to apply the changes.
Language settings enable users to customize the application's interface language to suit their preferences.
- Find the "Language" dropdown in the Account menu.
- Select the preferred language from the dropdown menu.
- Click "Save" to update the language settings.
Notification preferences empower users to manage how they receive notifications from the application. Users can opt to receive notifications via email, in-app messages, or both.
- Navigate to the "Notifications" section.
- Choose notification preferences based on your desired communication channels.The upper checkbox allows you to deselect all checkboxes
- Save the changes to update your notification settings.
The notification center serves as a centralized hub where users can conveniently view all notifications received on their account. This feature provides users with the ability to filter notifications based on event type and read status.
- Event Type: Filter notifications by selecting a specific event type from the available options. This helps users focus on notifications related to particular activities.
- Read Status: Filter notifications based on whether they have been read or are still unread. This feature aids in organizing and managing notifications efficiently.
Interacting with notifications
- Click a notification: this will route a user to the section in the product where the notification originated from (e.g., monitoring alert). After clicking a notification it will be marked with the
- Mark a notification as read: next to clicking the notification a notification can also be makred as
readby clicking the three dots at the right side of the notification that appear when hovering over it. Locate and click the Mark as read option. As an alternative all current unread notifications can be marked as read by clicking the Mark all as read button at the upper right corner of the notification center.
- Delete a notification: by clicking the three dots at the right side of the notification that appear when hovering over it a notification can be deleted. Locate and click the *Delete option.
The Notification Center supports various event types, each associated with a specific activity or update within the system. Common event types include:
- Configured alters: Notifications about alerts that have been triggered in your workspace
- Deployment change: Notifications about changes or updates to the user's deployments.
- Workspace changes: Notifications about changes or updates to the user's workspace.
- Repository changes: Notifications about changes or updates to the repositories in a user's workspace.
Understanding the event types helps users quickly identify the nature of each notification and prioritize their response accordingly.
Personal keys facilitate secure interactions with the Deeploy API and Python client. Users can generate, manage, and revoke key pairs as needed. Personal key is linked to your user authorisations on an account level.
Generating a new key pair
- Access the Create personal key section.
- Add a key name and optional valid until date
- Click + Add to generate a key pair
- Store the generated key pair (aspecially the secret key) securely. The key pair can be used for API and Python client authentication.
Be sure to save the secret key carefully as it will only be shown once
Delete a key pair
- In the Keys section, view the list of generated key pairs.
- Locate the key pair to be deleted.
- CLick the red bin to delete an existing key pair.
Using Key Pairs with the API and Python Client
Provide the public key when making API requests for authentication. For Python client interactions, use the private key for secure communication. Keep key pairs confidential and never share the private key.
Deleting personal keys cannot be undone