Account (Profile & Password)
The Profile and Password pages are personal account settings. They are available to every authenticated user regardless of their organization role — no Owner or Admin privileges are required.
Access requirements
Section titled “Access requirements”| Who can access | Scope |
|---|---|
| Any authenticated user | Own account only |
Profile
Section titled “Profile”Navigate to Settings → Profile (/settings/profile) to update your display name and notification preferences.
Fields
Section titled “Fields”| Field | Required | Constraints | Description |
|---|---|---|---|
| Display Name | No | Max 100 characters | The name shown in the Colony Cloud dashboard. Leave blank to use your GitHub username. |
| Pipeline failure alerts | — | Checkbox | Receive an email when a pipeline issue transitions to a failure state. |
| Weekly digest email | — | Checkbox | Receive a weekly summary of pipeline activity for your organization. |
| Method | Endpoint | Auth requirement |
|---|---|---|
GET | /api/account/profile | Any authenticated session |
PUT | /api/account/profile | Authenticated session with verified email |
GET /api/account/profile returns the current user’s profile including display name, email, avatar URL, email verification status, and notification preferences. Any authenticated session can read this endpoint.
PUT /api/account/profile accepts any combination of displayName, notificationPrefs, and email fields. Saving requires a verified email address.
Unsaved changes
Section titled “Unsaved changes”Navigating away from the Profile page with unsaved edits prompts a confirmation dialog — “You have unsaved profile changes. Are you sure you want to leave?” — before discarding your work.
Password
Section titled “Password”Navigate to Settings → Password (/settings/password) to change your account password.
Fields
Section titled “Fields”| Field | Required | Constraints | Description |
|---|---|---|---|
| Current Password | Yes | — | Your existing password. Required to authorize the change. |
| New Password | Yes | Min 12 characters; at least 2 character types (uppercase, lowercase, number, or symbol) | The new password to set on your account. |
| Confirm New Password | Yes | Must match New Password | Confirmation entry to prevent typos. |
| Method | Endpoint | Auth requirement |
|---|---|---|
PUT | /api/account/password | Authenticated session with verified email |
PUT /api/account/password accepts currentPassword and newPassword. The endpoint verifies the current password before applying the change and issues a refreshed session cookie so you remain logged in on the current device. Other active sessions are invalidated.
Unsaved changes
Section titled “Unsaved changes”Navigating away from the Password page with any field filled in prompts a confirmation dialog — “You have unsaved password changes. Are you sure you want to leave?” — before discarding your input.