Notifications on tool credential expiration
Summarize
Summary of Notifications on Tool Credential Expiration
This feature provides timely notifications to users regarding the expiration of tool credentials, specifically for GitHub tools using basic authentication. It helps ensure that users with the appropriate roles can update credentials in a timely manner to prevent data loss.
Show less
Key Features
- Expiration Alerts: Notifications are sent upon expiration of tool credentials and proactively before expiration for GitHub tools.
- Universal Task Creation: A universal task is assigned to users with the
sndevops.toolownerandsndevops.adminroles, notifying them through various channels. - Notification Methods: Alerts are delivered via the notification bell icon, email, and displayed as an open task on the workspace home page.
- Banner Notifications: A banner message appears on the tool record for any user with access when credentials expire.
- Proactive Notifications Settings: Customize the number of days prior to expiration for proactive notifications, defaulting to 3 days.
Key Outcomes
By utilizing these notifications, users can effectively manage tool credentials, ensuring they remain connected and functional. When credentials expire, a maximum wait time of one hour is expected for notifications to be sent. Users can easily update their credentials via links provided in notifications, restoring connectivity and data flow.
Notifications are sent to tool users on expiration of tool credentials to alert them. Notifications are also sent proactively before the expiration of tool credentials for GitHub tools created with basic authentication. This enables tool users with the sn_devops.tool_owner or sn_devops.admin roles to update the tool credentials and prevent any loss of data.
A universal task is created and assigned to users with the sn_devops.tool_owner role who are part of any user group specified in the Maintained by field, and any user with the sn_devops.admin role. They will be notified of the universal task through notification (in the bell icon), email, and an open task in the workspace home page.
Notifications are also displayed in the tool record in the form of a banner message to any user with access to the tool when the tool credentials expire. But the credentials can be updated only by users with the sn_devops.tool_owner or sn_devops.admin role.
The credentials expiration check happens in the system every one hour. If your tool credentials have expired, it might take a maximum of one hour for the system to send notifications.
For GitHub tools created with basic auth, notifications are also sent proactively before the expiration of tool credentials. Apart from the universal task and banner notification, a field message is also displayed in the case of
proactive expiration notifications. You can set the number of days before which expiration notifications must be sent in the Number of days before tool credential expiry to assign a universal task and notify (if
applicable) property. By default, it is set to 3 days. To stop sending proactive notifications, select 0 as the value for this property.
If you want to stop sending notifications for expired credentials after expiry, disable the Assign a universal task and notify to update tool credentials when expired property. For more information, see DevOps Change Velocity properties.
The following types of notifications are sent:
- Universal task
- A universal task is created and notifications are sent to users with the sn_devops.tool_owner role who are part of any user group specified in the Maintained by field, and any user with the sn_devops.admin
role.
- Banner message
- A banner message is displayed on the tool record to all users with access to the tool record.
- Field message
- A field message is displayed on the Credentials expiration
field in the tool record for a GitHub tool created with basic auth.
When the credentials of your tool expire, the tool gets disconnected. You can select the Update credentials link in the notifications, and update your tool credentials. After the credentials are updated, connect to the tool again to start receiving data. For information on updating tool credentials, see Update third-party tool credentials in DevOps Change Velocity.