user.update
Opis
object user.update(object/array users)
Ta metoda pozwala na aktualizację istniejących użytkowników.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika aby uzyskać więcej informacji.
Siła hasła użytkownika jest walidowana zgodnie z zasadami zdefiniowanymi w polityce hasła dostępnej w API uwierzytelniania. Zobacz API uwierzytelniania aby uzyskać więcej informacji.
Parametry
(object/array) Właściwości użytkownika do zaktualizowania.
Właściwość userid musi być zdefiniowana dla każdego użytkownika, wszystkie inne
właściwości są opcjonalne. Tylko przekazane właściwości zostaną zaktualizowane, wszystkie
inne pozostaną niezmienione.
Oprócz standardowych właściwości użytkownika, metoda akceptuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| passwd | string | Hasło użytkownika. Może być pustym ciągiem znaków, jeśli użytkownik należy do grup lub jest przenoszony tylko do grup, które mają dostęp LDAP. |
| usrgrps | array | Grupy użytkowników, które zastąpią istniejące grupy użytkowników. Grupy użytkowników muszą mieć zdefiniowaną właściwość usrgrpid. |
| medias | array | Media użytkownika, które zastąpią istniejące media. |
| user_medias (przestarzałe) |
array | Ten parametr jest przestarzały, zamiast tego użyj medias.Media użytkownika, które zastąpią istniejące media. |
Zwracane wartości
(obiekt) Zwraca obiekt zawierający identyfikatory zaktualizowanych użytkowników
we właściwości userids.
Przykłady
Zmiana nazwy użytkownika
Zmień nazwę użytkownika na John Doe.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "user.update",
"params": {
"userid": "1",
"name": "John",
"surname": "Doe"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Odpowiedź:
{
"jsonrpc": "2.0",
"result": {
"userids": [
"1"
]
},
"id": 1
}
Zmiana roli użytkownika
Zmień rolę użytkownika.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "user.update",
"params": {
"userid": "12",
"roleid": "6"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Odpowiedź:
{
"jsonrpc": "2.0",
"result": {
"userids": [
"12"
]
},
"id": 1
}
Zobacz także
Źródło
CUser::update() w ui/include/classes/api/services/CUser.php.