RESTKDocs

Account & Profile

Manage your personal profile, account settings, and authentication preferences.

5 min read

Your RESTK profile contains your personal information, authentication settings, and organization memberships. Manage your account details and preferences from the profile settings.

Quick Start

Open Profile Settings

Click your profile avatar in the top bar and select Profile or Account Settings.

Update Information

Edit your display name or other profile details.

Save Changes

Changes save automatically as you make them.


Accessing Profile Settings

Click your profile avatar or initials in the top-right corner of the app, then select Profile or Account Settings.

The profile modal opens showing your account information.


Profile Information

Display Name

Your full name as it appears throughout the app.

To edit:

  1. Click Edit next to your name
  2. Type your new name
  3. Click Save

Changes appear immediately and sync across all your devices.

Required Field

Your display name cannot be empty. Enter at least one character.

Email Address

Your email address is shown but cannot be changed directly.

Why it's read-only:

  • Email is used for authentication
  • Changing email requires verification
  • Prevents account takeover

Profile Picture

Your profile displays an initial-based avatar using the first letter of your name, color-themed to match your account.


Authentication

Sign-In Method

The profile shows which authentication method you used to create your account.

Supported providers:

ProviderDescription
Email & PasswordStandard email and password authentication
GoogleSign in with your Google account
GitHubSign in with your GitHub account
Magic LinkPasswordless email link authentication

Provider Display

You'll see:

  • Provider logo or icon
  • "Signed in with [Provider]" label
  • "Connected" status indicator

Password Management

For Email & Password users:

  • Password section appears in profile settings
  • You can change your password from this section

For OAuth users (Google, GitHub):

  • No password section shown
  • Password managed by the authentication provider

Organization Memberships

View all organizations you belong to in the Organizations section.

What you'll see:

DetailDescription
Organization NameName of each organization
Your RoleYour role in the organization (Owner, Admin, Member)
Role BadgeColor-coded badge showing your role

Leaving an Organization

Find Organization

Locate the organization in your memberships list.

Click Leave

Click Leave Organization button.

Confirm

Confirm that you want to leave.

What happens:

  • You lose access to the organization
  • You lose access to all organization workspaces
  • Content you created remains in the organization

Owners Cannot Leave

If you're the organization Owner, you must transfer ownership before leaving.


Account Information

Account Creation Date

See when you created your RESTK account.

Shown in the account details section.

Device ID

A truncated device identifier for troubleshooting.

Helpful when contacting support about device-specific issues.


Profile Editing

Edit Mode

Click Edit

Click the Edit button next to any editable field.

Make Changes

Update the field as needed.

Save or Cancel

Click Save to keep changes or Cancel to revert.

Visual indicators:

  • Edit button changes to Save/Cancel buttons
  • Field becomes editable with text input
  • Footer bar appears with action buttons

Auto-Save

Some changes save automatically without requiring a Save button:

  • Simple toggles
  • Preference changes

Other changes require explicit saving:

  • Name changes

Privacy & Security

Data Privacy

Profile data is private:

  • Only you can see your full profile
  • Other users see only your display name
  • Email is never shared with other users

Secure Storage

Your data is protected:

  • Profile synced securely across devices
  • Authentication managed by trusted providers
  • No sensitive data exposed in the UI

Authentication Security

Security features:

  • OAuth providers (Google, GitHub) manage passwords securely
  • Email & Password accounts use secure hashing
  • Session tokens expire appropriately

Theme & Preferences

The app supports light and dark mode. Theme customization and accent color preferences are planned for a future release.


Keyboard Shortcuts

While in profile settings:

ShortcutAction
EscClose profile modal
Cmd+SSave changes (when editing)
Cmd+EnterSave changes (when editing)

Troubleshooting

Cannot Save Name

Cause: Name field is empty

Solution: Enter at least one character for your name

Changes Not Appearing

Cause: Not connected to the internet

Solution:

  • Check your internet connection
  • Changes save locally and will sync when online

Wrong Profile Picture

Cause: Using initial-based avatar (custom pictures not yet available)

Solution: Custom profile pictures coming in a future update

Cannot Change Email

Cause: Email change requires verification (not yet implemented)

Solution: Contact support if you need to change your email address


Best Practices

  1. Use Your Real Name - Makes it easier for team members to identify you
  2. Keep Email Accessible - Used for important notifications and account recovery
  3. Review Organizations - Regularly check which organizations you're part of
  4. Update Profile Promptly - Keep your information current for better team collaboration

Future Enhancements

Planned features for profile management:

Coming Soon:

  • Custom profile picture upload
  • Email address change with verification
  • Two-factor authentication
  • Active sessions management
  • Connected accounts management
  • Account deletion option

Next Steps