![Lukas Reschke](https://secure.gravatar.com/avatar/a2d00cc3b0115e29a1dbfbc73a30cf83?d=identicon) Expose backend type via REST API
This change will expose the user backend via the REST API which is a pre-requisite for https://github.com/owncloud/core/issues/12620.
For example:
````json
[{"name":"9707A09E-CA9A-4ABE-A66A-3F632F16C409","displayname":"Document Conversion User Account","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/9707A09E-CA9A-4ABE-A66A-3F632F16C409","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"ED86733E-745C-4E4D-90CB-278A9737DB3C","displayname":"Hacker","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/ED86733E-745C-4E4D-90CB-278A9737DB3C","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"71CDF45B-E125-450D-983C-D9192F36EC88","displayname":"admin","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/71CDF45B-E125-450D-983C-D9192F36EC88","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"admin","displayname":"admin","groups":["admin"],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/admin","lastLogin":"1418057287","backend":"OC_User_Database"},{"name":"test","displayname":"test","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/test","lastLogin":0,"backend":"OC_User_Database"}]
```
9 years ago ![Lukas Reschke](https://secure.gravatar.com/avatar/a2d00cc3b0115e29a1dbfbc73a30cf83?d=identicon) Expose backend type via REST API
This change will expose the user backend via the REST API which is a pre-requisite for https://github.com/owncloud/core/issues/12620.
For example:
````json
[{"name":"9707A09E-CA9A-4ABE-A66A-3F632F16C409","displayname":"Document Conversion User Account","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/9707A09E-CA9A-4ABE-A66A-3F632F16C409","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"ED86733E-745C-4E4D-90CB-278A9737DB3C","displayname":"Hacker","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/ED86733E-745C-4E4D-90CB-278A9737DB3C","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"71CDF45B-E125-450D-983C-D9192F36EC88","displayname":"admin","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/71CDF45B-E125-450D-983C-D9192F36EC88","lastLogin":0,"backend":"OCA\\user_ldap\\USER_LDAP"},{"name":"admin","displayname":"admin","groups":["admin"],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/admin","lastLogin":"1418057287","backend":"OC_User_Database"},{"name":"test","displayname":"test","groups":[],"subadmin":[],"quota":"default","storageLocation":"\/Users\/lreschke\/Programming\/core\/data\/test","lastLogin":0,"backend":"OC_User_Database"}]
```
9 years ago |
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210 |
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
-
- namespace OCP;
-
- /**
- * Interface IUser
- *
- * @package OCP
- * @since 8.0.0
- */
- interface IUser {
-
- /**
- * get the user id
- *
- * @return string
- * @since 8.0.0
- */
- public function getUID();
-
- /**
- * get the display name for the user, if no specific display name is set it will fallback to the user id
- *
- * @return string
- * @since 8.0.0
- */
- public function getDisplayName();
-
- /**
- * set the display name for the user
- *
- * @param string $displayName
- * @return bool
- * @since 8.0.0
- */
- public function setDisplayName($displayName);
-
- /**
- * returns the timestamp of the user's last login or 0 if the user did never
- * login
- *
- * @return int
- * @since 8.0.0
- */
- public function getLastLogin();
-
- /**
- * updates the timestamp of the most recent login of this user
- * @since 8.0.0
- */
- public function updateLastLoginTimestamp();
-
- /**
- * Delete the user
- *
- * @return bool
- * @since 8.0.0
- */
- public function delete();
-
- /**
- * Set the password of the user
- *
- * @param string $password
- * @param string $recoveryPassword for the encryption app to reset encryption keys
- * @return bool
- * @since 8.0.0
- */
- public function setPassword($password, $recoveryPassword = null);
-
- /**
- * get the users home folder to mount
- *
- * @return string
- * @since 8.0.0
- */
- public function getHome();
-
- /**
- * Get the name of the backend class the user is connected with
- *
- * @return string
- * @since 8.0.0
- */
- public function getBackendClassName();
-
- /**
- * Get the backend for the current user object
- *
- * @since 15.0.0
- */
- public function getBackend();
-
- /**
- * check if the backend allows the user to change his avatar on Personal page
- *
- * @return bool
- * @since 8.0.0
- */
- public function canChangeAvatar();
-
- /**
- * check if the backend supports changing passwords
- *
- * @return bool
- * @since 8.0.0
- */
- public function canChangePassword();
-
- /**
- * check if the backend supports changing display names
- *
- * @return bool
- * @since 8.0.0
- */
- public function canChangeDisplayName();
-
- /**
- * check if the user is enabled
- *
- * @return bool
- * @since 8.0.0
- */
- public function isEnabled();
-
- /**
- * set the enabled status for the user
- *
- * @param bool $enabled
- * @since 8.0.0
- */
- public function setEnabled(bool $enabled = true);
-
- /**
- * get the users email address
- *
- * @return string|null
- * @since 9.0.0
- */
- public function getEMailAddress();
-
- /**
- * get the avatar image if it exists
- *
- * @param int $size
- * @return IImage|null
- * @since 9.0.0
- */
- public function getAvatarImage($size);
-
- /**
- * get the federation cloud id
- *
- * @return string
- * @since 9.0.0
- */
- public function getCloudId();
-
- /**
- * set the email address of the user
- *
- * @param string|null $mailAddress
- * @return void
- * @since 9.0.0
- */
- public function setEMailAddress($mailAddress);
-
- /**
- * get the users' quota in human readable form. If a specific quota is not
- * set for the user, the default value is returned. If a default setting
- * was not set otherwise, it is return as 'none', i.e. quota is not limited.
- *
- * @return string
- * @since 9.0.0
- */
- public function getQuota();
-
- /**
- * set the users' quota
- *
- * @param string $quota
- * @return void
- * @since 9.0.0
- */
- public function setQuota($quota);
- }
|