Skip to content

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.

Who can accessScope
Any authenticated userOwn account only

Navigate to Settings → Profile (/settings/profile) to update your display name and notification preferences.

FieldRequiredConstraintsDescription
Display NameNoMax 100 charactersThe name shown in the Colony Cloud dashboard. Leave blank to use your GitHub username.
Pipeline failure alertsCheckboxReceive an email when a pipeline issue transitions to a failure state.
Weekly digest emailCheckboxReceive a weekly summary of pipeline activity for your organization.
MethodEndpointAuth requirement
GET/api/account/profileAny authenticated session
PUT/api/account/profileAuthenticated 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.

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.

Navigate to Settings → Password (/settings/password) to change your account password.

FieldRequiredConstraintsDescription
Current PasswordYesYour existing password. Required to authorize the change.
New PasswordYesMin 12 characters; at least 2 character types (uppercase, lowercase, number, or symbol)The new password to set on your account.
Confirm New PasswordYesMust match New PasswordConfirmation entry to prevent typos.
MethodEndpointAuth requirement
PUT/api/account/passwordAuthenticated 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.

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.