@webitel/api-services
Preparing search index...
users/users
getUsers
Function getUsers
getUsers
(
axiosInstance
?:
AxiosInstance
,
)
:
{
createUser
:
(
apiCreateUserRequest
:
{
user
?:
{
chatName
?:
string
;
contact
?:
{
id
?:
string
;
name
?:
string
}
;
device
?:
{
id
?:
string
;
name
?:
string
}
;
devices
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
email
?:
string
;
extension
?:
string
;
forcePasswordChange
?:
boolean
;
hotdesks
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
license
?:
{
[
key
:
number
]:
{
expiresAt
?:
string
;
id
?:
string
;
issuedAt
?:
string
;
name
?:
string
;
prod
?:
string
;
scope
?:
{
[
key
:
number
]:
string
}
;
user
?:
{
id
?:
string
;
name
?:
string
}
;
}
;
}
;
name
?:
string
;
password
?:
string
;
permissions
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
;
usage
?:
string
}
;
}
;
presence
?:
{
expires
?:
number
;
id
?:
string
;
note
?:
string
;
status
?:
string
;
timestamp
?:
string
;
}
;
profile
?:
{
[
key
:
string
]:
string
}
;
roles
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
totpUrl
?:
string
;
username
?:
string
;
}
;
}
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiCreateUserResponse
,
any
,
{}
>
>
;
deleteUsers
:
(
id
:
string
,
params
?:
DeleteUsersParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiDeleteUsersResponse
,
any
,
{}
>
>
;
deleteUsers2
:
(
deleteUsers2Body
:
string
[]
,
params
?:
DeleteUsers2Params
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiDeleteUsersResponse
,
any
,
{}
>
>
;
getUserWarnings
:
(
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiGetUserWarningsResponse
,
any
,
{}
>
>
;
logoutUser
:
(
id
:
string
,
usersLogoutUserBody
:
UsersLogoutUserBody
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiLogoutUserResponse
,
any
,
{}
>
>
;
readPasswordSettings
:
(
params
?:
ReadPasswordSettingsParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiGetPasswordSettingsResponse
,
any
,
{}
>
>
;
readUser
:
(
id
:
string
,
params
?:
ReadUserParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiReadUserResponse
,
any
,
{}
>
>
;
readUser2
:
(
params
?:
ReadUser2Params
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiReadUserResponse
,
any
,
{}
>
>
;
searchUsers
:
(
params
?:
SearchUsersParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiSearchUsersResponse
,
any
,
{}
>
>
;
searchUsers2
:
(
apiSearchUsersRequest
:
ApiSearchUsersRequest
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiSearchUsersResponse
,
any
,
{}
>
>
;
updatePassword
:
(
apiUpdatePasswordRequest
:
ApiUpdatePasswordRequest
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiUpdatePasswordResponse
,
any
,
{}
>
>
;
updateUser
:
(
updateUserBody
:
{
chatName
?:
string
;
contact
?:
{
id
?:
string
;
name
?:
string
}
;
device
?:
{
id
?:
string
;
name
?:
string
}
;
devices
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
email
?:
string
;
extension
?:
string
;
forcePasswordChange
?:
boolean
;
hotdesks
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
license
?:
{
[
key
:
number
]:
{
expiresAt
?:
string
;
id
?:
string
;
issuedAt
?:
string
;
name
?:
string
;
prod
?:
string
;
scope
?:
{
[
key
:
number
]:
string
}
;
user
?:
{
id
?:
string
;
name
?:
string
}
;
}
;
}
;
name
?:
string
;
password
?:
string
;
permissions
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
;
usage
?:
string
}
;
}
;
presence
?:
{
expires
?:
number
;
id
?:
string
;
note
?:
string
;
status
?:
string
;
timestamp
?:
string
;
}
;
profile
?:
{
[
key
:
string
]:
string
}
;
roles
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
totpUrl
?:
string
;
username
?:
string
;
}
,
params
?:
UpdateUserParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiUser
,
any
,
{}
>
>
;
updateUser2
:
(
updateUser2Body
:
{
chatName
?:
string
;
contact
?:
{
id
?:
string
;
name
?:
string
}
;
device
?:
{
id
?:
string
;
name
?:
string
}
;
devices
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
email
?:
string
;
extension
?:
string
;
forcePasswordChange
?:
boolean
;
hotdesks
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
license
?:
{
[
key
:
number
]:
{
expiresAt
?:
string
;
id
?:
string
;
issuedAt
?:
string
;
name
?:
string
;
prod
?:
string
;
scope
?:
{
[
key
:
number
]:
string
}
;
user
?:
{
id
?:
string
;
name
?:
string
}
;
}
;
}
;
name
?:
string
;
password
?:
string
;
permissions
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
;
usage
?:
string
}
;
}
;
presence
?:
{
expires
?:
number
;
id
?:
string
;
note
?:
string
;
status
?:
string
;
timestamp
?:
string
;
}
;
profile
?:
{
[
key
:
string
]:
string
}
;
roles
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
totpUrl
?:
string
;
username
?:
string
;
}
,
params
?:
UpdateUser2Params
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiUser
,
any
,
{}
>
>
;
}
Parameters
axiosInstance
:
AxiosInstance
= axios
Returns
{
createUser
:
(
apiCreateUserRequest
:
{
user
?:
{
chatName
?:
string
;
contact
?:
{
id
?:
string
;
name
?:
string
}
;
device
?:
{
id
?:
string
;
name
?:
string
}
;
devices
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
email
?:
string
;
extension
?:
string
;
forcePasswordChange
?:
boolean
;
hotdesks
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
license
?:
{
[
key
:
number
]:
{
expiresAt
?:
string
;
id
?:
string
;
issuedAt
?:
string
;
name
?:
string
;
prod
?:
string
;
scope
?:
{
[
key
:
number
]:
string
}
;
user
?:
{
id
?:
string
;
name
?:
string
}
;
}
;
}
;
name
?:
string
;
password
?:
string
;
permissions
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
;
usage
?:
string
}
;
}
;
presence
?:
{
expires
?:
number
;
id
?:
string
;
note
?:
string
;
status
?:
string
;
timestamp
?:
string
;
}
;
profile
?:
{
[
key
:
string
]:
string
}
;
roles
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
totpUrl
?:
string
;
username
?:
string
;
}
;
}
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiCreateUserResponse
,
any
,
{}
>
>
;
deleteUsers
:
(
id
:
string
,
params
?:
DeleteUsersParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiDeleteUsersResponse
,
any
,
{}
>
>
;
deleteUsers2
:
(
deleteUsers2Body
:
string
[]
,
params
?:
DeleteUsers2Params
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiDeleteUsersResponse
,
any
,
{}
>
>
;
getUserWarnings
:
(
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiGetUserWarningsResponse
,
any
,
{}
>
>
;
logoutUser
:
(
id
:
string
,
usersLogoutUserBody
:
UsersLogoutUserBody
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiLogoutUserResponse
,
any
,
{}
>
>
;
readPasswordSettings
:
(
params
?:
ReadPasswordSettingsParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiGetPasswordSettingsResponse
,
any
,
{}
>
>
;
readUser
:
(
id
:
string
,
params
?:
ReadUserParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiReadUserResponse
,
any
,
{}
>
>
;
readUser2
:
(
params
?:
ReadUser2Params
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiReadUserResponse
,
any
,
{}
>
>
;
searchUsers
:
(
params
?:
SearchUsersParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiSearchUsersResponse
,
any
,
{}
>
>
;
searchUsers2
:
(
apiSearchUsersRequest
:
ApiSearchUsersRequest
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiSearchUsersResponse
,
any
,
{}
>
>
;
updatePassword
:
(
apiUpdatePasswordRequest
:
ApiUpdatePasswordRequest
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiUpdatePasswordResponse
,
any
,
{}
>
>
;
updateUser
:
(
updateUserBody
:
{
chatName
?:
string
;
contact
?:
{
id
?:
string
;
name
?:
string
}
;
device
?:
{
id
?:
string
;
name
?:
string
}
;
devices
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
email
?:
string
;
extension
?:
string
;
forcePasswordChange
?:
boolean
;
hotdesks
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
license
?:
{
[
key
:
number
]:
{
expiresAt
?:
string
;
id
?:
string
;
issuedAt
?:
string
;
name
?:
string
;
prod
?:
string
;
scope
?:
{
[
key
:
number
]:
string
}
;
user
?:
{
id
?:
string
;
name
?:
string
}
;
}
;
}
;
name
?:
string
;
password
?:
string
;
permissions
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
;
usage
?:
string
}
;
}
;
presence
?:
{
expires
?:
number
;
id
?:
string
;
note
?:
string
;
status
?:
string
;
timestamp
?:
string
;
}
;
profile
?:
{
[
key
:
string
]:
string
}
;
roles
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
totpUrl
?:
string
;
username
?:
string
;
}
,
params
?:
UpdateUserParams
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiUser
,
any
,
{}
>
>
;
updateUser2
:
(
updateUser2Body
:
{
chatName
?:
string
;
contact
?:
{
id
?:
string
;
name
?:
string
}
;
device
?:
{
id
?:
string
;
name
?:
string
}
;
devices
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
email
?:
string
;
extension
?:
string
;
forcePasswordChange
?:
boolean
;
hotdesks
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
license
?:
{
[
key
:
number
]:
{
expiresAt
?:
string
;
id
?:
string
;
issuedAt
?:
string
;
name
?:
string
;
prod
?:
string
;
scope
?:
{
[
key
:
number
]:
string
}
;
user
?:
{
id
?:
string
;
name
?:
string
}
;
}
;
}
;
name
?:
string
;
password
?:
string
;
permissions
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
;
usage
?:
string
}
;
}
;
presence
?:
{
expires
?:
number
;
id
?:
string
;
note
?:
string
;
status
?:
string
;
timestamp
?:
string
;
}
;
profile
?:
{
[
key
:
string
]:
string
}
;
roles
?:
{
[
key
:
number
]:
{
id
?:
string
;
name
?:
string
}
}
;
totpUrl
?:
string
;
username
?:
string
;
}
,
params
?:
UpdateUser2Params
,
options
?:
AxiosRequestConfig
,
)
=>
Promise
<
AxiosResponse
<
ApiUser
,
any
,
{}
>
>
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@webitel/api-services
Loading...