# Generating user accounts

When you know the names and emails of your users, generating accounts for them is the best option because you do not need to wait for users to do anything before the accounts are created. This allows you to:

* Generate linked exam and assignment attempts
* Manage / correct details immediately
* Add them to secondary groups before notifying users, if needed

### ✋ Before you start

* Make sure you have a group set up you want to generate users into
* Check the content assigned to that group is correct as users will have access right away
* Decide on how to handle passwords (will you ask your users to reset or will you give them their passwords separately)
* Decide whether you want your users to get a welcome email or not.
* Check your portal's user attributes ([more here](/doc/portal-settings/data-management/attributes.md)), as you will need to include attributes marked as 'required at registration' on your import sheet
* If you're importing, get your import template from the group's import page. This will include your attribute headers.

### Generate single account

You can generate an account for a single user directly on the platform. Select the **Generate single account** button on the **Generate accounts** tab. This opens a modal where you can enter all values for the user. Once you have entered these details, scroll to the bottom of the modal and click **Generate account**.

You will get an error if you try to generate an account for an existing user with this method.

<figure><img src="/files/OOTJFl2KrL3x5xW0sUen" alt=""><figcaption></figcaption></figure>

### Generate via csv

You can generate multiple user accounts at once by entering their emails and names into a CSV and importing it on the **Generate Accounts** tab.

If there are existing users in the CSV who are not in the group, they will be added to the group. Their attributes will also be updated, as will those of existing users who are already in the group.

{% hint style="info" %}
You can use this method to bulk update existing users' attributes
{% endhint %}

**Fields for generating accounts**

`name` = required

`email` = required

`externalId` = optional. Can be used for something like a student ID

`language` = optional. See language codes below

<details>

<summary>Language codes</summary>

| Code  | Language                    |
| ----- | --------------------------- |
| en    | English                     |
| en-GB | English (United Kingdom)    |
| de-DE | German (Germany)            |
| el-GR | Greek (Greece)              |
| es-ES | Spanish (Spain)             |
| fr-FR | French (France)             |
| it-IT | Italian (Italy)             |
| nl-NL | Dutch (Netherlands)         |
| pt-BR | Portuguese (Brazil)         |
| pt-PT | Portuguese (Portugal)       |
| zh-CN | Chinese (Simplified, China) |
| nb-NO | Norwegian Bokmål (Norway)   |
| sl-SI | Slovenian (Slovenia)        |
| ar-SA | Arabic (Saudi Arabia)       |
| th-TH | Thai (Thailand)             |
| hr-HR | Croatian (Croatia)          |
| ru-RU | Russian (Russia)            |
| id-ID | Indonesian (Indonesia)      |
| lv-LV | Latvian (Latvia)            |
| et-EE | Estonian (Estonia)          |
| sq-AL | Albanian (Albania)          |
| cy-GB | Welsh (United Kingdom)      |
| vi-VN | Vietnamese (Vietnam)        |

</details>

`timezone` = optional. See format below

<details>

<summary>Time zones</summary>

| Time Zone ID           | UTC Offset |
| ---------------------- | ---------- |
| Africa/Abidjan         | UTC+00:00  |
| Africa/Accra           | UTC+00:00  |
| Africa/Addis\_Ababa    | UTC+03:00  |
| Africa/Algiers         | UTC+01:00  |
| Africa/Asmara          | UTC+03:00  |
| Africa/Bamako          | UTC+00:00  |
| Africa/Bangui          | UTC+01:00  |
| Africa/Banjul          | UTC+00:00  |
| Africa/Bissau          | UTC+00:00  |
| Africa/Blantyre        | UTC+02:00  |
| Africa/Brazzaville     | UTC+01:00  |
| Africa/Bujumbura       | UTC+02:00  |
| Africa/Cairo           | UTC+02:00  |
| Africa/Casablanca      | UTC+01:00  |
| Africa/Ceuta           | UTC+01:00  |
| Africa/Conakry         | UTC+00:00  |
| Africa/Dakar           | UTC+00:00  |
| Africa/Dar\_es\_Salaam | UTC+03:00  |
| Africa/Djibouti        | UTC+03:00  |
| Africa/Douala          | UTC+01:00  |
| Africa/El\_Aaiun       | UTC+01:00  |
| Africa/Freetown        | UTC+00:00  |
| Africa/Gaborone        | UTC+02:00  |
| Africa/Harare          | UTC+02:00  |
| Africa/Johannesburg    | UTC+02:00  |
| Africa/Juba            | UTC+02:00  |
| Africa/Kampala         | UTC+03:00  |
| Africa/Khartoum        | UTC+02:00  |
| Africa/Kigali          | UTC+02:00  |
| Africa/Kinshasa        | UTC+01:00  |
| Africa/Lagos           | UTC+01:00  |
| Africa/Libreville      | UTC+01:00  |
| Africa/Lome            | UTC+00:00  |
| Africa/Luanda          | UTC+01:00  |
| Africa/Lubumbashi      | UTC+02:00  |
| Africa/Lusaka          | UTC+02:00  |
| Africa/Malabo          | UTC+01:00  |
| Africa/Maputo          | UTC+02:00  |
| Africa/Maseru          | UTC+02:00  |
| Africa/Mbabane         | UTC+02:00  |
| Africa/Mogadishu       | UTC+03:00  |
| Africa/Monrovia        | UTC+00:00  |
| Africa/Nairobi         | UTC+03:00  |
| Africa/Ndjamena        | UTC+01:00  |
| Africa/Niamey          | UTC+01:00  |
| Africa/Nouakchott      | UTC+00:00  |
| Africa/Ouagadougou     | UTC+00:00  |
| Africa/Porto-Novo      | UTC+01:00  |
| Africa/Sao\_Tome       | UTC+00:00  |
| Africa/Tripoli         | UTC+02:00  |
| Africa/Tunis           | UTC+01:00  |
| Africa/Windhoek        | UTC+02:00  |

</details>

`extraTimeMultiplier` = optional. Used to give a user additional time on each attempt generated for them.

`password` = If you want to give these users a known password, include a password column in the CSV. Passwords must be at least 8 characters long, with at least one uppercase letter, one lowercase letter, and one number. If not provided or left blank, a password will be generated for the user and sent to you by email.

`attributes` = may be required on registration. If you have custom user attributes in your portal, you can add the ID of an attribute as a header in the CSV.

### **📧 Disable welcome emails**

For either option, welcome emails can be disabled. This is recommended if you are generating accounts for use in test centres or for high-stakes exams, and you want to hand out passwords manually.

<figure><img src="/files/Y41p82s2tTyzYynBzKCA" alt=""><figcaption><p>Toggle welcome emails off</p></figcaption></figure>

### 🧍‍♂️ Generating a single account

In a user group, go to **Manage > Import users > Generate account**.

<figure><img src="/files/1XXxVl6T2KulcmfuTdwf" alt=""><figcaption><p>Locating the single account generator</p></figcaption></figure>

From here, you will get a pop-up modal to fill in all account details, including name, email, and password, which are all required. If you disable the welcome email, **you must provide values for any attributes that are required on registration.** Go to **Settings > Data Management > User attributes** to see which attributes are required on your platform.

<figure><img src="/files/PCJhXb56MHSO9GbMmwFs" alt=""><figcaption></figcaption></figure>

Once you have entered all the information, click **Generate**. The user account will be created and appear in the group's users table. Be aware that if the group has any content with automated emails enabled, the new user will receive those automatically.

### Bulk generating accounts

You can create a CSV with multiple accounts and passwords you want to generate. **You must use different passwords for each user on your sheet**. Go to the group you want to generate users in, then go to **Manage > Import users > Download CSV template > Generate accounts**. The template you download will be customised based on the attributes on your portal. Your attribute values must be formatted correctly, and any attributes set as required on registration must have values for each user row in the correct format.

<figure><img src="/files/0D1kKnCA5JcaByQJfgf2" alt=""><figcaption><p>Locating the generate accounts template and option</p></figcaption></figure>

{% hint style="info" %}
You can include existing users on the same sheet as new users. They will be added to the group, and if they have new attributes in the CSV, those will be applied.
{% endhint %}

**Attribute types and required CSV format**

| Attribute type  | Expected value on CSV                                                                                                                                                                                                                            |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Checkbox        | `TRUE` or `FALSE`                                                                                                                                                                                                                                |
| Long answer     | `string`                                                                                                                                                                                                                                         |
| Short answer    | `string`                                                                                                                                                                                                                                         |
| Multiple choice | One of defined `options`                                                                                                                                                                                                                         |
| Checkboxes      | defined `options` separated by commas                                                                                                                                                                                                            |
| Number          | Any numerical value                                                                                                                                                                                                                              |
| Date            | `DD/MM/YYYY`                                                                                                                                                                                                                                     |
| Link            | Choose whether to display as text or as a button. The link can be typed as an absolute URL (opens in new tab), or a root-relative URL (open in the same tab)                                                                                     |
| password        | Must be at least 8 characters long, with at least one upper case letter, one lower case letter and one number. And unique for each row.                                                                                                          |
| timezone        | Enter the user’s time zone using a valid IANA time zone identifier (e.g. `Europe/London`, `Africa/Accra`, `America/New_York`). This determines how dates and times are displayed for the user. Must match a supported tz database value exactly. |

Format your sheet carefully, making sure each row includes all required information. In the example below, the sheet has been colour-coded. The default required fields — name, email, and password — are highlighted in yellow. Two attributes required at registration are shown in red. Optional attributes are shown in green, and some of these are left blank.

<figure><img src="/files/kj6QYMhKyqy0dhI7VBb4" alt=""><figcaption><p>Example generate users sheet</p></figcaption></figure>

From here, save the sheet as a CSV and upload it to the platform. If there are any formatting errors, you will be notified and the upload will not run for any users.

<figure><img src="/files/rHVaUVs4oCd0hUfCJ9Bt" alt=""><figcaption><p>Example errors which need to be fixed</p></figcaption></figure>

Once your accounts have been generated, you will be sent a summary sheet confirming the passwords and other information created for each user. Double-check this to make sure all information is correct.

<figure><img src="/files/QGkKzzwWudDQGCGcd0qJ" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
🚨 Remember that users can change their passwords at any time, so your record of a user's initial password may not always be their current password.
{% endhint %}

### Timezones

Users without a timezone set will get one when they log in or use the platform, based on their browser's timezone. Users without a timezone set who have never used the platform will be given the portal-level timezone set by admins in portal settings.

To generate or invite users with a preset timezone, use the `timezone` field. The `timezone` field must use a valid **IANA (tz database) time zone identifier**, formatted as `Region/City`.

Examples:

* `Europe/London`
* `Africa/Accra`
* `America/New_York`
* `Asia/Singapore`

Timezone values are case-sensitive and must match the official IANA tz database names exactly. Abbreviations such as `GMT`, `BST`, or `EST` are not supported.

<details>

<summary>IANA tz database - for importing or generating users with a preset timezone</summary>

```
Africa/Abidjan
Africa/Accra
Africa/Addis_Ababa
Africa/Algiers
Africa/Asmara
Africa/Bamako
Africa/Bangui
Africa/Banjul
Africa/Bissau
Africa/Blantyre
Africa/Brazzaville
Africa/Bujumbura
Africa/Cairo
Africa/Casablanca
Africa/Ceuta
Africa/Conakry
Africa/Dakar
Africa/Dar_es_Salaam
Africa/Djibouti
Africa/Douala
Africa/El_Aaiun
Africa/Freetown
Africa/Gaborone
Africa/Harare
Africa/Johannesburg
Africa/Juba
Africa/Kampala
Africa/Khartoum
Africa/Kigali
Africa/Kinshasa
Africa/Lagos
Africa/Libreville
Africa/Lome
Africa/Luanda
Africa/Lubumbashi
Africa/Lusaka
Africa/Malabo
Africa/Maputo
Africa/Maseru
Africa/Mbabane
Africa/Mogadishu
Africa/Monrovia
Africa/Nairobi
Africa/Ndjamena
Africa/Niamey
Africa/Nouakchott
Africa/Ouagadougou
Africa/Porto-Novo
Africa/Sao_Tome
Africa/Tripoli
Africa/Tunis
Africa/Windhoek
America/Adak
America/Anchorage
America/Araguaina
America/Argentina/Buenos_Aires
America/Argentina/Catamarca
America/Argentina/Cordoba
America/Argentina/Jujuy
America/Argentina/La_Rioja
America/Argentina/Mendoza
America/Argentina/Rio_Gallegos
America/Argentina/Salta
America/Argentina/San_Juan
America/Argentina/San_Luis
America/Argentina/Tucuman
America/Argentina/Ushuaia
America/Asuncion
America/Bahia
America/Bahia_Banderas
America/Barbados
America/Belem
America/Belize
America/Blanc-Sablon
America/Boa_Vista
America/Bogota
America/Boise
America/Cambridge_Bay
America/Campo_Grande
America/Cancun
America/Caracas
America/Cayenne
America/Chicago
America/Chihuahua
America/Ciudad_Juarez
America/Costa_Rica
America/Creston
America/Cuiaba
America/Curacao
America/Danmarkshavn
America/Dawson
America/Dawson_Creek
America/Denver
America/Detroit
America/Edmonton
America/Eirunepe
America/El_Salvador
America/Fort_Nelson
America/Fortaleza
America/Glace_Bay
America/Goose_Bay
America/Grand_Turk
America/Guatemala
America/Guayaquil
America/Guyana
America/Halifax
America/Havana
America/Hermosillo
America/Indiana/Indianapolis
America/Indiana/Knox
America/Indiana/Marengo
America/Indiana/Petersburg
America/Indiana/Tell_City
America/Indiana/Vevay
America/Indiana/Vincennes
America/Indiana/Winamac
America/Inuvik
America/Iqaluit
America/Jamaica
America/Juneau
America/Kentucky/Louisville
America/Kentucky/Monticello
America/La_Paz
America/Lima
America/Los_Angeles
America/Maceio
America/Managua
America/Manaus
America/Martinique
America/Matamoros
America/Mazatlan
America/Menominee
America/Merida
America/Metlakatla
America/Mexico_City
America/Miquelon
America/Moncton
America/Monterrey
America/Montevideo
America/New_York
America/Nome
America/Noronha
America/North_Dakota/Beulah
America/North_Dakota/Center
America/North_Dakota/New_Salem
America/Ojinaga
America/Panama
America/Paramaribo
America/Phoenix
America/Port-au-Prince
America/Port_of_Spain
America/Porto_Velho
America/Puerto_Rico
America/Punta_Arenas
America/Rankin_Inlet
America/Recife
America/Regina
America/Resolute
America/Rio_Branco
America/Santarem
America/Santiago
America/Santo_Domingo
America/Sao_Paulo
America/Scoresbysund
America/Sitka
America/St_Johns
America/Swift_Current
America/Tegucigalpa
America/Thule
America/Tijuana
America/Toronto
America/Vancouver
America/Whitehorse
America/Winnipeg
America/Yakutat
Asia/Aden
Asia/Almaty
Asia/Amman
Asia/Anadyr
Asia/Aqtau
Asia/Aqtobe
Asia/Ashgabat
Asia/Atyrau
Asia/Baghdad
Asia/Baku
Asia/Bangkok
Asia/Barnaul
Asia/Beirut
Asia/Bishkek
Asia/Brunei
Asia/Chita
Asia/Colombo
Asia/Damascus
Asia/Dhaka
Asia/Dili
Asia/Dubai
Asia/Dushanbe
Asia/Famagusta
Asia/Gaza
Asia/Hebron
Asia/Ho_Chi_Minh
Asia/Hong_Kong
Asia/Hovd
Asia/Irkutsk
Asia/Jakarta
Asia/Jayapura
Asia/Jerusalem
Asia/Kabul
Asia/Kamchatka
Asia/Karachi
Asia/Kathmandu
Asia/Khandyga
Asia/Kolkata
Asia/Krasnoyarsk
Asia/Kuala_Lumpur
Asia/Kuching
Asia/Macau
Asia/Magadan
Asia/Makassar
Asia/Manila
Asia/Nicosia
Asia/Novokuznetsk
Asia/Novosibirsk
Asia/Omsk
Asia/Oral
Asia/Pontianak
Asia/Pyongyang
Asia/Qatar
Asia/Qostanay
Asia/Qyzylorda
Asia/Riyadh
Asia/Sakhalin
Asia/Samarkand
Asia/Seoul
Asia/Shanghai
Asia/Singapore
Asia/Srednekolymsk
Asia/Taipei
Asia/Tashkent
Asia/Tbilisi
Asia/Tehran
Asia/Thimphu
Asia/Tokyo
Asia/Tomsk
Asia/Ulaanbaatar
Asia/Urumqi
Asia/Ust-Nera
Asia/Vladivostok
Asia/Yakutsk
Asia/Yangon
Asia/Yekaterinburg
Asia/Yerevan
Atlantic/Azores
Atlantic/Bermuda
Atlantic/Canary
Atlantic/Cape_Verde
Atlantic/Faroe
Atlantic/Madeira
Atlantic/Reykjavik
Atlantic/South_Georgia
Atlantic/Stanley
Australia/Adelaide
Australia/Brisbane
Australia/Broken_Hill
Australia/Darwin
Australia/Eucla
Australia/Hobart
Australia/Lindeman
Australia/Lord_Howe
Australia/Melbourne
Australia/Perth
Australia/Sydney
Europe/Andorra
Europe/Astrakhan
Europe/Athens
Europe/Belgrade
Europe/Berlin
Europe/Brussels
Europe/Bucharest
Europe/Budapest
Europe/Chisinau
Europe/Dublin
Europe/Gibraltar
Europe/Helsinki
Europe/Istanbul
Europe/Kaliningrad
Europe/Kirov
Europe/Kyiv
Europe/Lisbon
Europe/London
Europe/Madrid
Europe/Malta
Europe/Minsk
Europe/Moscow
Europe/Paris
Europe/Prague
Europe/Riga
Europe/Rome
Europe/Samara
Europe/Saratov
Europe/Simferopol
Europe/Sofia
Europe/Tallinn
Europe/Tirane
Europe/Ulyanovsk
Europe/Vienna
Europe/Vilnius
Europe/Volgograd
Europe/Warsaw
Europe/Zurich
Indian/Chagos
Indian/Maldives
Indian/Mauritius
Indian/Reunion
Pacific/Apia
Pacific/Auckland
Pacific/Bougainville
Pacific/Chatham
Pacific/Easter
Pacific/Efate
Pacific/Fakaofo
Pacific/Fiji
Pacific/Galapagos
Pacific/Gambier
Pacific/Guadalcanal
Pacific/Guam
Pacific/Honolulu
Pacific/Kanton
Pacific/Kiritimati
Pacific/Kosrae
Pacific/Kwajalein
Pacific/Majuro
Pacific/Marquesas
Pacific/Nauru
Pacific/Niue
Pacific/Norfolk
Pacific/Noumea
Pacific/Pago_Pago
Pacific/Palau
Pacific/Pitcairn
Pacific/Port_Moresby
Pacific/Rarotonga
Pacific/Tahiti
Pacific/Tarawa
Pacific/Tongatapu
Pacific/Wake
Pacific/Wallis
Antarctica/Casey
Antarctica/Davis
Antarctica/Macquarie
Antarctica/Mawson
Antarctica/Palmer
Antarctica/Rothera
Antarctica/Syowa
Antarctica/Troll
Antarctica/Vostok
```

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.synap.ac/doc/users-and-groups/creating-groups/generating-user-accounts.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
