User

Många anrop på denna sida använder userIdentifier. För att hitta vilket fält som är gällande userIdentifier i applikationen se nedan: applikation -> konfiguration -> användare -> "Användaridentifierare"

Anrop	Beskrivning	Kodexempel
addGroup( applicationRef, userIdentifier, groupId )	Spara ett grupp-id på en given användare. Returnerar inget värde.	let user = sp3.user() await user.addGroup( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. "userIdentifier", "groupId" ) return
count(applicationRef)	Räkna antalet användare för en given applikation. Returnerar antalet användare.	let user = sp3.user() let adminCount = await user.count( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. ) return adminCount
create( applicationRef, userIdentifier, opt ) opt = { userAttributes: object }	Skapa upp ett nytt användarobjekt för en given applikation. Returnerar ett JSON-objekt.	let user = sp3.user() const newUser = await user.create( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. "userIdentifier", { userAttributes: { key: "value" } } ) return newUser.result
exist( applicationRef, userIdentifier )	Kolla om given användare finns för den givna applikationen. Returnerar användarobjektet i JSON format.	let user = sp3.user() const existingUser = await user.exist( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. "userIdentifier", ) return existingUser
generateToken( applicationRef ) https://jwt.io/introduction	Generera en JWT token för given applikation. Returnerar en JWT token.	let user = sp3.user() const JWT = await user.generateToken( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. ) return JWT
get( applicationRef, userIdentifier, opt ) opt = { myself: boolean, extractRole: boolean }	Hämta en användare från databasen. Returnerar användarobjektet i JSON format.	let user = sp3.user() const adminUser = await user.get( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. "userIdentifier", ) return adminUser
gets( applicationRef, filter, opt ) filter: mongoDB filter opt = { extractRole: boolean, }	Hämta en eller flera användare från databasen. Returnerar en array of användarobjekt i JSON format.	let user = sp3.user() const emails = ["[e-mail]", "[e-mail]"] const adminsByEmails = await user.gets( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. { email: { $in: emails } }, ) return adminsByEmails
profile()	Hämta användar profilen för den inloggade användaren. Returnerar användarprofilen i JSON format.	let user = sp3.user() const myProfile = await user.profile() return myProfile
removeGroup( applicationRef, userIdentifier, groupId )	Ta bort en grupp från en given en användare. Returnerar inget värde.	let user = sp3.user() await user.removeGroup( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. "userIdentifier", "groupId" ) return
update( applicationRef, userIdentifier, updateObj )	Updatera en användare med ett givet värde. Returnerar ett JSON-objekt.	let user = sp3.user() const updated = await user.update( "admin", // The admin application has applicationRef = "admin". // Use _id for other applications. "userIdentifier / userId", // Both work here { name: "newName", email: "newEmail" }, ) return updated.result