← Back to documentation

Settings Guide

Use the settings tabs to manage account access, organization roles, and notifications.

6 min read

Use Settings to manage the account identity, the security, the organization access, and the notifications.

Purpose#

Use this guide to:

  • Change the profile name.
  • Change the sign-in email address.
  • Change the password, or set a first password.
  • Connect or remove a provider sign-in.
  • Activate or rename an organization.
  • Understand the organization roles.
  • Change the notification preferences.

Before you start#

  • A signed-in account.
  • You must have the OWNER role or the ADMIN role to rename an organization or to manage the users.
  • The VIEWER role gives read-only access to the organization resources. A viewer can see the shared resources. A viewer cannot change the organization configuration, the endpoints, the targets, the users, or the delivery configuration.

Procedure#

1. Profile tab#

  1. Enter a display name.
  2. Select Save name.

Rules:

  • You must enter a name.

2. Email tab#

  1. Enter the new sign-in email address.
  2. Select Send confirmation link.
  3. Open the email link and select the confirmation action.

While the change is pending, you can:

  • Resend
  • Cancel pending email change

3. Security tab#

The Sign-in methods list shows each method that you can use to sign in. The first row is Email and password. The other rows are the providers Google, Apple, and Microsoft. A provider row shows only when PayloadRelay offers that provider, or when your account has it connected already.

An account can have a password and one account of each provider. You can sign in with each method in the list.

To connect a provider sign-in:

  1. In the row of the provider, select Connect.
  2. For Google, select the Google button that shows in the row.
  3. Sign in to the provider account.
  4. If the Sign in again step shows, enter the Current password. Then select Continue. As an alternative, authenticate again with a connected provider.
  5. Make sure that PayloadRelay shows Sign-in method connected.

To remove a provider sign-in:

  1. In the row of the provider, select Remove.
  2. Read the Remove {Provider} sign-in dialog. Then select Remove.
  3. If the Sign in again step shows, sign in again with the password or with a connected provider.
  4. Make sure that PayloadRelay shows Sign-in method removed.

Rules:

  • A connection and a removal need a sign-in in the last 10 minutes. If the sign-in is older, PayloadRelay shows the Sign in again step.
  • You cannot remove the only sign-in method of the account. Set a password or connect a different provider first.
  • A provider account can belong to one PayloadRelay account only. If a different PayloadRelay account uses it, remove it from that account first.
  • To use a different account of the same provider, remove the connected account first. Then connect the new account.
  • After a removal, you cannot sign in with that provider. PayloadRelay signs out your other sessions. The current session continues.
  • PayloadRelay sends a security email for each connection and each removal.
  • PayloadRelay never connects a provider sign-in because of a matching email address. You can connect a provider sign-in only in this tab, or when you accept an invitation with that provider.

The password form is below the list:

  • Change password needs the current password and a new password of 15 to 128 Unicode characters. You can use spaces and passphrases. PayloadRelay rejects a common password and a compromised password.
  • If your account has no password, the form is Set password. Authenticate again with a connected provider. Then enter the new password. As an alternative, use Forgot your password? on the sign-in page.

4. Organization tab#

The behavior depends on the mode and the role:

  • Personal mode: to activate an organization, give it a name. Team organizations are available during the Team trial and on the Team plan, the Scale plan, and an eligible custom plan. Sandbox and Solo stay single-user.
  • Organization mode as an owner or an admin: rename the organization and open the member management.
  • Organization mode as a member or a viewer: see the organization details only. A viewer also has read-only access in the complete app.

The organization roles are:

  • Owner (OWNER): can administer the organization and transfer the ownership.
  • Admin (ADMIN): can administer the organization configuration and the members.
  • Member (can edit) (USER): can manage the delivery configuration, but not the organization members.
  • Viewer (read-only) (VIEWER): has read-only access.

The member limit comes from the plan. Sandbox and Solo permit 1 active member. The Team trial and Team permit 5. Scale permits an unlimited number of members. For a custom plan, the agreement of the organization sets the member limit.

You cannot change the role of the owner directly, and you cannot remove the owner directly. To change the owner, use Transfer ownership in the member management. The new owner must be an active Admin or Member (can edit). The current owner must approve the transfer by email. After the approval, the old owner becomes an Admin, and the new owner becomes the Owner.

A removed member becomes inactive. You can restore that member in the same organization. To reactivate the existing account, invite the same email address again. The member receives the invited role, and sets a new password or accepts with a provider. PayloadRelay removes the old password and the old provider sign-ins of that account.

5. Notifications tab#

Manage these items:

  • The warning for an enabled endpoint with no destinations
  • The security notifications and the account-change notifications
  • The product updates

An administrator manages the organization quota alerts in Billing. PayloadRelay sends them to the billing contact at 80% usage and at 100% usage.

Expected result#

  • The profile, email, and security changes stay after a page reload.
  • The organization actions agree with the permissions of your role.
  • The personal notification changes save with no validation error.

Common issues and fixes#

  • The save control is disabled: make sure that a field changed and that all the necessary values are present.
  • The password update failed: make sure that the current password and the minimum length are correct.
  • Remove is disabled for a provider: that provider is the only sign-in method of the account. Set a password or connect a different provider first.
  • Connect is not present for a provider: PayloadRelay does not offer that provider now.
  • A connection fails with "Another PayloadRelay account uses this {Provider} account. Remove it from that account first.": sign in to the other account. Remove the provider there. Then connect it again.
  • A connection fails with "The connection request expired. Start again.": select Connect again.
  • The organization rename is blocked: the name can be in use already.
← Back to documentation