UserPool ¶

New in version R15.037.

Note

This type cannot be instantiated.

Definition ¶

class c4d.modules.net. UserPool ¶

• UserPool.AddUser()
• UserPool.DeleteUser()
• UserPool.CheckUserCredentials()
• UserPool.EditUserInfo()
• UserPool.EditUserPassword()
• UserPool.ChangeUserAccountType()

• UserPool.ChangeLanguage()
• UserPool.ChangePassword()

• UserPool.GetUsers()

Members ¶

UserPool. AddUser ( username , password , description , isAdmin ) ¶

Adds a user.

Parameters:	username ( str ) – The user’s name. password ( str ) – The user’s password. description ( str ) – The user’s description. isAdmin ( bool ) – Set to True if the user to add is administrator, False otherwise.
Return type:	bool
Returns:	True if the user was successfully added, False otherwise.

UserPool. DeleteUser ( userUuid ) ¶

Deletes a user.

Parameters:	userUuid ( UUID ) – Changed in version R16.021. The user UUID.
Return type:	bool
Returns:	True if the user was successfully deleted, False otherwise.

UserPool. CheckUserCredentials ( username , password ) ¶

Checks a user’s credentials.

Parameters:	username ( str ) – The user name. password ( str ) – The user password.
Return type:	bool
Returns:	True if the user’s credentials were successfully checked, otherwise False .

UserPool. EditUserInfo ( userUuid , description ) ¶

New in version R16.021.

Sets a user’s information.

Parameters:	userUuid – The user UUID. description ( str ) – The new user description/information.
Return type:	bool
Returns:	True if the user’s information was successfully set, otherwise False .

UserPool. EditUserPassword ( userUuid , password ) ¶

New in version R16.021.

Sets a user’s password.

Parameters:	userUuid – The user UUID. password ( str ) – The new password.
Return type:	bool
Returns:	True if the user’s password was successfully set, otherwise False .

UserPool. ChangeUserAccountType ( userUuid , isAdmin ) ¶

New in version R16.021.

Changes a user’s account type.

Parameters:	userUuid – The user UUID. isAdmin ( bool ) – Set to True to change the user’s account type to administrator, False otherwise.
Return type:	bool
Returns:	True if the user’s account type was successfully changed, otherwise False .

UserPool. ChangeLanguage ( userUuid , language ) ¶

New in version R16.021.

Sets the language for a user.

Parameters:	userUuid – The user UUID. language ( str ) – The new language.
Return type:	bool
Returns:	True if the user’s password was successfully set, otherwise False .

UserPool. ChangePassword ( userUuid , oldPassword , newPassword ) ¶

Changes a user’s password.

Parameters:	userUuid – Changed in version R16.021. The user UUID. oldPassword ( str ) – The old user’s password. newPassword ( str ) – The new user’s password.
Return type:	bool
Returns:	True if the user’s password was successfully changed, otherwise False .

UserPool. GetUsers ( ) ¶

New in version R16.021.

Retrieves the users information from the pool.

Return type:	list of dict{ username , str, description : str, uuid : UUID ,, isadmin : bool, language : str}
Returns:	The users information.

Table Of Contents

• UserPool
  • Definition
  • Members