Skip to content
Contact Support
  • There are no suggestions because the search field is empty.

🏰  Gating: Restrict Access to Your World

Password, Authentication, Email Guestlist, Open/Close, or SAML Single Sign-On.

As an owner of the world, you can restrict access to your world by:

*To implement employee-only SAML SSO / Okta contact us at support@topia.io

 

Password

When you add a password, users must enter the password to access your world. With this method, you will set a single password for the world that is used by all participants - think of it as the secret-code.

Note: Anyone who has the password to your world could share it with others. Once in your world, both owners and admins have access to remove ("ban") users from the space. Learn more about banning here.

Demonstration of how to set a password for a Topia world.

 

To Add a Password:
  1. Log in to your world
  2. Click the World Settings settings icon in the left sidebar to open the World Settings drawer
  3. Click Authentication
  4. On the Authentication page, click the toggle under Require Password. When turned on, the toggle will show a check mark highlighted in blue
  5. In the field for World Password enter a password
  6. Collapse the page by clicking the close closeLeft icon in the top right corner or close both the page and drawer by clicking on the x in the World Settings drawer.

Now users will need to enter the password before they can access your world

 

 

Authentication

When you enable this option, only users who have signed into Topia will be able to access your world. Users can authenticate using their email address or using a social account.

If you ban someone from your world, they will not be able to re-enter using an authentication method that is linked to the same email address. 

Settings Require Authentication

 

To Require Authentication:
  1. Log in to your world
  2. Click the World Settings settings icon in the left sidebar to open the World Settings drawer
  3. Click Authentication
  4. On the Authentication page, click the toggle under Require Authentication. When turned on, the toggle will show a check mark highlighted in blue.
  5. Collapse the page by clicking the close closeLeft icon in the top right corner or close both the page and drawer by clicking on the x in the World Settings drawer.
Now users will need to login to a Topia account before they can access your world.

 

 

Approved Guestlist

For more advanced gating, you can restrict access to your world to a list of approved guests. This will prevent anyone who is not on your guestlist from entering your world.

A .gif demonstrating how to use the guestlist functionality in Topia.

 

To Add an Approved Guestlist:
  1. Log in to your world
  2. Click the World Settings settings icon in the left sidebar to open the World Settings drawer
  3. Click Approved Guestlist
  4. You can upload a guestlist (via .csv) or add emails individually,
  5. Then click one of the following options:

    • Replace Guestlist: This option will clear your existing list and replace it with the list that you just uploaded

    • Add to Guestlist: This option will add the information from your upload to your whitelist and also keep the existing list intact

  6. At the top of the page, turn your guestlist on by selecting one of the options from the dropdown
    • On - only users on guestlist can enter - this option will only allow users who are on the guestlist to enter the world. 
    • On - Users on Guestlist bypass usergroup - anyone who is a part of the user group associated with the world or is a user on the guestlist can enter.
  7. Your current guestlist will be listed at the bottom of the page. From here you can also individually add or remove users from the list.

  8. Collapse the page by clicking the closeLeft icon in the top right corner or close the page and drawer by clicking on the x in the drawer

 

 

Bulk Upload an Approved Guestlist

If you'd prefer to upload an approved guestlist in bulk you can do this with a .csv file. Create your guestlist in a speadsheet using the follow structure and download your spreadsheet as a CSV.

[email address] [first name] [last name] [display name]

Note: Do not include column headings in your CSV file.

 

Requirements for Bulk Upload

  • Email is required.
    • Use the email address associated with the user's Topia account.
    • If the user does not have a Topia account, instruct them to create an account using the email address you've included in the guestlist.
  • First Name and Last Name are optional.
    • We recommend including First and/or Last Name to make it easier to manage your guestlist.
  • Display Name is optional unless you want to prevent users from choosing their own display name.

 

Guestlist Display Name

When a guestlist is enabled, you can prevent a guest from entering a custom Display Name and instead force a pre-defined Display Name.

To Force a Pre-Defined Display Name:
  1. ​Enter your Topia world
  2. Click the World Settings settings icon in the left sidebar to open the World Settings drawer and under Access choose Approved Guestlist
  3. On the Approved Guestlist page, upload your list by clicking Choose File. This must include a Display Name and be a .csv file. Follow the CSV structure guidelines above.
  4. Then click one of the following options:
    • Replace Guestlist: This option will clear your existing list and replace it with the list that you just uploaded.
    • Add to Guestlist: This option will add the information from your upload to your whitelist and also keep the existing list intact.
  5. Click the toggle under Guestlist and the toggle under Require Guestlist Display Name. When turned on, the toggle will show a check mark highlighted in blue
  6. Collapse the page by clicking the close closeLeft icon in the top right corner or close both the page and drawer by clicking on the x in the World Settings drawer.

 

Editing the Guestlist

You can easily add or remove a guest from the guestlist by following these simple steps:

Add a User to the Guestlist
  1. Enter your Topia world
  2. Click the World Settings settings icon in the left sidebar to open the World Settings drawer and under Access choose Approved Guestlist
  3. On the Approved Guestlist page, under Add Email to Guestlist, enter the user's info (Email Address, Display Name (optional), First Name, Last Name) and click the Add Email to Guestlist button
  4. Collapse the page by clicking the close closeLeft icon in the top right corner or close both the page and drawer by clicking on the x in the World Settings drawer.

 

Remove a User from the Guestlist
  1. Enter your Topia world
  2. Click the World Settings settings icon in the left sidebar to open the World Settings drawer and under Access choose Approved Guestlist
  3. On the Approved Guestlist page, at the bottom under Guestlist, find or search for the person you would like to remove and click the remove remove icon under Actions
  4. Collapse the page by clicking the close closeLeft icon in the top right corner or close both the page and drawer by clicking on the x in the World Settings drawer.

 

 

Closing your world

When you close your world, all users (excluding admins) will be removed from the world and unable to reenter until you open the world again. You can close your world at any time using the Close World setting or by scheduling your world to open and close on a recurring basis.

Open and close your world immediately
  1. Enter your Topia world.
  2. Click the World Settings settings icon in the left sidebar to open the World Settings drawer and choose Open/Close World.
  3. In the Settings section, click the Close World toggle and choose confirm that you want to open or close your world.
    • If you're closing your world (switching Close World to on), all users (excluding admins) will be removed from the world and unable to reenter until you open the world again. Admins will still be able to enter your world.
    • If you're opening your world (switching Close World to off), users will be able to enter your world again.

 

Set up an open and close world schedule
  1. Enter your Topia world
  2. Click the World Settings settings icon in the left sidebar to open the World Settings drawer and choose Open/Close World.
  3. In the Scheduler section, click the plus plus button to add a new row.
  4. In the new row, choose an Open time, Close time, and the Days of the week that you want your world to open and close every week.
    • Note: All times are scheduled in the device timezone you're using to edit the schedule.
    • Note: All users (excluding admins) will be removed from the world when a scheduled time closes your world.

Your world will now open and close every week on the days and times you selected. If you want to turn off the recurring schedule, turn the Scheduler toggle to off.

Sep-06-2024 15-40-19

 

SAML Single Sign-On (SSO)

This enables the platform to delegate authentication to a company or organization's identity provider, allowing for secure access to a world. This option is available for an additional implementation fee. To enable SSO authentication for your account, contact us at support@topia.io.