@jellyfin/sdk
Preparing search index...
generated-client
UserApiAxiosParamCreator
Function UserApiAxiosParamCreator
UserApiAxiosParamCreator
(
configuration
?:
Configuration
,
)
:
{
authenticateUserByName
:
(
authenticateUserByName
:
AuthenticateUserByName
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
authenticateWithQuickConnect
:
(
quickConnectDto
:
QuickConnectDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
createUserByName
:
(
createUserByName
:
CreateUserByName
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
deleteUser
:
(
userId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
forgotPassword
:
(
forgotPasswordDto
:
ForgotPasswordDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
forgotPasswordPin
:
(
forgotPasswordPinDto
:
ForgotPasswordPinDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getCurrentUser
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
;
getPublicUsers
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
;
getUserById
:
(
userId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getUsers
:
(
isHidden
?:
boolean
,
isDisabled
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
updateUser
:
(
userDto
:
UserDto
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
updateUserConfiguration
:
(
userConfiguration
:
UserConfiguration
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
updateUserPassword
:
(
updateUserPassword
:
UpdateUserPassword
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
updateUserPolicy
:
(
userId
:
string
,
userPolicy
:
UserPolicy
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
}
UserApi - axios parameter creator
Parameters
Optional
configuration
:
Configuration
Returns
{
authenticateUserByName
:
(
authenticateUserByName
:
AuthenticateUserByName
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
authenticateWithQuickConnect
:
(
quickConnectDto
:
QuickConnectDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
createUserByName
:
(
createUserByName
:
CreateUserByName
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
deleteUser
:
(
userId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
forgotPassword
:
(
forgotPasswordDto
:
ForgotPasswordDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
forgotPasswordPin
:
(
forgotPasswordPinDto
:
ForgotPasswordPinDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getCurrentUser
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
;
getPublicUsers
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
;
getUserById
:
(
userId
:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
getUsers
:
(
isHidden
?:
boolean
,
isDisabled
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
updateUser
:
(
userDto
:
UserDto
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
updateUserConfiguration
:
(
userConfiguration
:
UserConfiguration
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
updateUserPassword
:
(
updateUserPassword
:
UpdateUserPassword
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
updateUserPolicy
:
(
userId
:
string
,
userPolicy
:
UserPolicy
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
;
}
authenticateUserByName
:
(
authenticateUserByName
:
AuthenticateUserByName
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
authenticateWithQuickConnect
:
(
quickConnectDto
:
QuickConnectDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
createUserByName
:
(
createUserByName
:
CreateUserByName
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
deleteUser
:
(
userId
:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
forgotPassword
:
(
forgotPasswordDto
:
ForgotPasswordDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
forgotPasswordPin
:
(
forgotPasswordPinDto
:
ForgotPasswordPinDto
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
getCurrentUser
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getPublicUsers
:
(
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getUserById
:
(
userId
:
string
,
options
?:
RawAxiosRequestConfig
)
=>
Promise
<
RequestArgs
>
Throws
getUsers
:
(
isHidden
?:
boolean
,
isDisabled
?:
boolean
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
updateUser
:
(
userDto
:
UserDto
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
updateUserConfiguration
:
(
userConfiguration
:
UserConfiguration
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
updateUserPassword
:
(
updateUserPassword
:
UpdateUserPassword
,
userId
?:
string
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
updateUserPolicy
:
(
userId
:
string
,
userPolicy
:
UserPolicy
,
options
?:
RawAxiosRequestConfig
,
)
=>
Promise
<
RequestArgs
>
Throws
Export
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@jellyfin/sdk
Loading...
UserApi - axios parameter creator