Notifications, Calendars, and Tags¶
Mytoken provides a comprehensive notification system that keeps users informed about important events related to their tokens and account activity. This page explains how notifications work, how calendars can be used to subscribe to token events, and how tags help organize your tokens.
Notifications¶
Summary
Notifications alert you about security events, token activities, and system changes through various channels like email.
Notifications are created for specific mytokens or user-wide, allowing you to stay informed about what's happening with your tokens. Each notification is assigned a management code, which allows you to manage the notification (update settings, delete it) without needing to authenticate with a mytoken.
Notification Types¶
Mytoken supports different notification delivery methods:
- Email (
mail): Send notifications via email to your registered email address - WebSocket (
ws): Real-time notifications via WebSocket connections (planned)
Notification Classes¶
Notifications are categorized into classes that define which events trigger notifications. The classes form a hierarchical structure where subscribing to a parent class includes all child classes.
Security Classes¶
| Class | Description |
|---|---|
security |
All security-related events (parent class) |
security:ips |
Usage from previously unknown IP addresses |
security:blocked_usages |
Blocked usage attempts (parent class) |
security:blocked_usages:capabilities |
Blocked due to insufficient capabilities |
security:blocked_usages: restrictions |
Blocked due to restrictions violations |
security:revoked |
Usage attempts of revoked tokens (user-wide only) |
Token Lifecycle Classes¶
| Class | Description |
|---|---|
AT_creations |
Access token creation events |
subtoken_creations |
Mytoken subtoken creation events |
expiration |
Notifications before token expiration |
rt_failure |
Refresh token failure events |
System Classes¶
| Class | Description |
|---|---|
setting_changes |
Changes to user settings (calendar creation/deletion, email changes, SSH key additions, grant enabling/disabling) |
Managing Notifications¶
You can list and manage all notifications for your account in the web interface. It is also possible to manage a notification from the link included in notification mails.
Adding Tokens to Notifications
A single notification can monitor multiple tokens. You can add additional mytokens to an existing notification in the web interface. This is useful when you want to receive consolidated notifications for multiple tokens.
Signle Calendar Event Entry (ICS Invite)¶
The ics_invite notification type is specifically for expiration notifications and works similarly to calendars.
When you create an ics_invite notification, you receive a calendar event invitation via email for token expiration
events. This provides a convenient way to add expiration dates directly to your calendar application without manually
subscribing to a calendar feed.
Calendars¶
Summary
Calendars provide ICS feed subscriptions for token expirations, allowing you to be notified when mytokens expire from your calendar applications.
Calendars are a special type of notification that creates an ICS feed containing expiration events for your tokens. You can subscribe to this feed using any calendar application that supports ICS feeds (e.g., Google Calendar, Outlook, Apple Calendar).
Creating Calendars¶
When creating a calendar, you can specify:
- Description: A descriptive name for the calendar
- Tags: Tags to associate with the calendar for filtering
Each calendar has a unique ID and an ICS path that you can use to subscribe to the feed.
Calendar Subscriptions¶
Tokens can be added to calendars in two ways:
- Direct subscription: Add a specific mytoken directly to a calendar
- Tag-based subscription: If a tag is associated with both a mytoken and a calendar, the mytoken is automatically included in the calendar
This dual approach allows you to either manually manage calendar contents or use tags for automatic inclusion.
Tags¶
Summary
Tags are user-defined labels for organizing mytokens, notifications, and calendars with custom colors for visual identification.
Tags provide a powerful way to categorize and organize your mytokens. They can be used across notifications and calendars to filter and group related items.
Tags can be applied to:
- Mytokens: Organize tokens by project, environment, or purpose
- Notifications: Filter which tokens trigger notifications
- Calendars: Include all tokens with certain tags in a calendar
Tag Inheritance
When applying a tag to a mytoken, you can choose to include children. This means that any subtokens created from the tagged parent token will inherit the tag automatically. This is particularly useful for maintaining consistent organization across related tokens.
How it All Comes Together¶
The three features work together seamlessly: Putting tags on notifications, calendars, and mytokens allows you to manage them easily. There is no need to put individual mytokens into calendars or notifications, since this can be done more easy and consistent with tags. Just put the same tag on a mytoken and calendar / notification, and the mytoken will automatically be included in the calendar / notification.
It is also possible to put multiple tags on mytokens, calendars, and notifications.