Ladda upp många användare

Provisionering av dina användare i en miljö som interna användare, med eller utan lösenord:

Du kan ladda upp användarna med deras lösenord, om du känner användarnas lösenord.
Annars kan du ladda upp användarna utan lösenord och användarna ombeds då att sätta ett lösenord med en e-post eller SMS bekräftelsekod. Kräv att användarna har antingen en e-post eller ett telefonnummer.

Användarna bulk uppladdas till en miljö med upp till 1 000 användare per request när användarna skapas utan lösenord, och upp till 100 användare per request när lösenord ingår. Detta stöder flera uppladdningar och gör att miljoner användare kan importeras. Du kan antingen använda FoxIDs Control API direkt eller använda seed tool.

Exempel uppladdningstid för 50 000 användare

Scenario	Användare	Batch storlek	Ca. total tid
Utan lösenord	50 000	1 000	~2 minuter
Med lösenord	50 000	100	~2 timmar
Lösenordshashar förberäknade på klient	50 000	1 000	~5 minuter

Tiderna är ungefärliga och beror på klientmaskin, nätverk och infrastruktur.

Uppladdning av användare med lösenord tar längre tid eftersom en password hash måste beräknas för varje användare, och denna operation är avsiktligt tidskrävande av säkerhetsskäl.
Uppladdningstiden kan förbättras genom att beräkna password hashes på klienten innan användarna laddas upp.

Ladda upp med seed tool

Seed tool läser användare från en CSV fil och laddar upp användarna till den konfigurerade miljön. Seed tool stöder även bulk borttagning av användare.

Som standard förberäknar seed tool password hashes på klienten under uppladdning för att minska serverns behandlingstid.

CSV fil

CSV fil elementen är separerade med ; och texten kan valfritt vara inom citattecken.

Du kan hitta exempel CSV filer här.
(Till exempel, se UTF-8 tecken i claims i filen password-claims-3-test-users.csv som visar stöd för multi language / extended character.)

Första raden i CSV filen är case sensitive headers. Du kan välja att använda alla headers eller en delmängd av headers och ändra ordningen på headers.
Headers:

Email
Phone
Username
ConfirmAccount
EmailVerified
PhoneVerified
Password
PasswordHashAlgorithm
PasswordHash
PasswordHashSalt
ChangePassword
PasswordLastChanged
SetPasswordEmail
SetPasswordSms
DisableAccount
Claims
RequireMultiFactor

Antalet headers och element i varje rad måste matcha.

Denna CSV fil sample använder Email och SetPasswordEmail headers för att ladda upp användare utan lösenord. Användaren måste sätta ett lösenord med e-post bekräftelse vid första login. E-post markeras därefter som verifierad.

Email;SetPasswordEmail
u1@somedomain.test;true
u2@somedomain.test;true
u3@somedomain.test;true

Denna CSV fil sample inkluderar ett användarnamn och sätter e-post och telefonnummer som verifierade. Lösenorden sätts med en e-post eller SMS bekräftelsekod.

Email;Phone;Username;EmailVerified;PhoneVerified;SetPasswordEmail;SetPasswordSms
u1@somedomain.test;;u1;true;true;true;false
;+4422222222;u2;true;true;false;true
u3@somedomain.test;+4433333333;u3;true;true;true;false

Denna CSV fil sample använder alla headers och laddar upp användare med lösenord och claims. Den sista användaren laddas upp som en inaktiverad användare.

Email;Phone;Username;ConfirmAccount;EmailVerified;PhoneVerified;Password;ChangePassword;SetPasswordEmail;SetPasswordSms;DisableAccount;Claims;RequireMultiFactor
u1@somedomain.test;+4411111111;u1;false;true;true;"My1Password!";false;false;false;false;"[{""Claim"": ""role"", ""Values"": [""admin""]}]";false
u2@somedomain.test;+4422222222;u2;false;true;true;"My2Password!";true;false;false;false;"[{""Claim"": ""role"", ""Values"": [""admin""]}, {""Claim"": ""customer_id"", ""Values"": [""1234""]}]";true
u3@somedomain.test;+4433333333;u3;false;true;true;"My3Password!";false;false;false;true;"[{""Claim"": ""role"", ""Values"": [""admin"", ""user""]}]";false

Om du förberäknar password hashes på klienten, använd kolumnerna PasswordHashAlgorithm, PasswordHash och PasswordHashSalt och lämna Password tom (eller ta bort). Du kan valfritt bevara original password change timestamp med PasswordLastChanged (Unix sekunder). När ett lösenord eller hash levereras utan PasswordLastChanged stämplas uppladdningen med aktuell tid.

Du bör lägga till lösenord och claims med ;""; notationen. Om ett lösenord innehåller " symbolen blir det escaped, till exempel lösenordet My"Password som blir ;"My""Password";

Claims läggs till med en JSON struktur utan radbrytningar och " symbolerna escapes.

[
  { "Claim": "role", "Values": ["admin", "user"] }, 
  { "Claim": "customer_id", "Values": ["1234"] }
]

Ladda ner och konfigurera seed tool

Ladda först ner FoxIDs.SeedTool-x.x.x-win-x64.zip för Windows eller FoxIDs.SeedTool-x.x.x-linux-x64.zip för Linux från FoxIDs release och packa upp seed tool.

Seed tool konfigureras i appsettings.json filen.

Åtkomst att ladda upp användare ges i din master miljö.

Skapa en seed tool OAuth 2.0 klient i FoxIDs Control Client:

Detta ger seed tool full åtkomst till din tenant, för least privileges se API access rights.

Logga in på din tenant (i self hosted huvud tenant)
Välj master miljön (i den övre mitten miljöväljaren)
Välj fliken Applications
Klicka New Application
Klicka Backend Application
1. Välj Show advanced
2. Lägg till ett Name t.ex. Seed tool
3. Ändra Client ID till foxids_seed
4. Klicka Register
5. Kom ihåg Authority.
6. Kom ihåg Client secret.
7. Klicka Close
Klicka på applikationen i listan för att öppna den
I sektionen Resource and scopes
1. Ta bort bocken från Default resource 'foxids_seed' for the application itself
2. Klicka Add Resource and scope och lägg till resursen foxids_control_api
3. Klicka sedan Add Scope och lägg till scopet foxids:tenant
Välj Show advanced
I sektionen Issue claims
1. Klicka Add Claim och lägg till claim role
2. Klicka sedan Add Value och lägg till claim värdet foxids:tenant
Klicka Update

FoxIDs Control Client - master seed tool client

Lägg till ditt FoxIDs Control API endpoint och tenant och environment samt seed tool Authority och Client secret och CSV fil sökväg i seed tool konfigurationen.

"SeedSettings": {
    "FoxIDsControlEndpoint": "https://control.foxids.com", // self-hosted "https://control.yyyyxxxx.com" or local development https://localhost:44331
    "Tenant": "xxxxxx",
    "Environment": "xxxxxx",
    "Authority": "https://id.foxids.com/zzzzz/master/foxids_seed/", // custom domain, self-hosted or local development "https://https://localhost:44331/zzzzz/master/foxids_seed/"
    "ClientId": "foxids_master_seed",
    "ClientSecret": "xxxxxx",
    "Scope": "foxids_control_api:foxids:tenant",
    "UsersSvcPath": "c:\\... xxx ...\\users.csv"
}

Kör seed tool och ladda upp användarna

Starta en Command Prompt
Kör seed tool med SeedTool.exe
Klicka U för att starta uppladdning av användare

Uppladdningen kan ta en stund beroende på antalet användare.