UpdateUser¶

Updates a user's properties.

$Membership.UpdateUser(identity: ( string | Identity ), properties: UserInfo):Identity

Parameters¶

( string | Identity ) identity
The identity of the user to update.

UserInfo properties
An object containing the properties to update for the user.

Returns¶

The updated user identity.

Remarks¶

The properties object is a JavaScript object that can contain a subset of user properties to update. Not all properties are required; only the properties specified in this object will be updated.

Setting a user password using the default eMakina organization provider:¶

var userId = 'e444bcae-edd0-4659-8d8d-65bb3d1fe82c';
$Membership.UpdateUser(userId, {
    providerName : 'Organization',
    id : '[email protected]',
    password : 'myPassword'
});

Associating an Active Directory logon with a user:¶

var userId = 'e444bcae-edd0-4659-8d8d-65bb3d1fe82c';

$Membership.UpdateUser(userId, {
    providerName : 'LDAP',
    id : 'http://ldap.emakin.com/user/john.doe'
});

Types¶

UserInfo¶

avatar : large : string

normal : string

small : string
Avatar urls of user

email : string
Email address of user

firstname : string
First name of user

id : string
Provider specific user id

language : string
Language of user

lastname : string
Last name of user

name : string
Full name of user

otherProperties : Array<UserInfoProperty>
Provider specific other properties to map

password : string
Password of user.

providerName : string
Name of provider. Default is "Organization"

subjectId : string
Provider specific subject id

UserInfoProperty¶

name : string
Name of property

value : string
Value of property