Search
Preparing search index...
The search index is not available
@sentinel-one/management-node-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
Users
Class Users
Hierarchy
EntityBaseClass
Users
Implements
BaseClass
Index
Constructors
constructor
Properties
api
Call
end
Points
entity
Name
Methods
change
User
Password
check
Tenant
Admin
check
Viewer
Auth
create
delete
disable
Two
Fa
enable
Two
Fa
enable
Two
FaApp
enroll2fa
error
Handler
generate
Iframe
Token
generate
User
Api
Token
generate
User
Recovery
Code
get
get
All
Users
get
Api
Token
Details
get
Defualt
Logged
InUser
Props
get
Logged
InUser
get
User
ById
get
User
ByToken
make
Api
Call
prepare
Api
Url
Queries
request
Two
FaApp
revoke
Api
Token
sing
Eula
trigger
Reset
Password
OnNext
Login
update
user
Info
verify
Code
verify
Email
Constructors
constructor
new
Users
(
apiCall
:
ApiCall
)
:
Users
Parameters
apiCall:
ApiCall
Returns
Users
Properties
Private
api
Call
api
Call
:
ApiCall
end
Points
end
Points
:
any
entity
Name
entity
Name
:
string
Methods
change
User
Password
change
User
Password
(
data
:
ChangePasswordRequest
)
:
Promise
<
SDKRespond
>
Parameters
data:
ChangePasswordRequest
Returns
Promise
<
SDKRespond
>
check
Tenant
Admin
check
Tenant
Admin
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
check
Viewer
Auth
check
Viewer
Auth
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
create
create
(
createUserReq
:
CreateUserRequest
)
:
Promise
<
SDKRespond
>
Parameters
createUserReq:
CreateUserRequest
Returns
Promise
<
SDKRespond
>
delete
delete
(
userId
:
string
)
:
Promise
<
SDKRespond
>
Parameters
userId:
string
Returns
Promise
<
SDKRespond
>
disable
Two
Fa
disable
Two
Fa
(
id
:
string
)
:
Promise
<
SDKRespond
>
Parameters
id:
string
Returns
Promise
<
SDKRespond
>
enable
Two
Fa
enable
Two
Fa
(
id
:
string
)
:
Promise
<
SDKRespond
>
Parameters
id:
string
Returns
Promise
<
SDKRespond
>
enable
Two
FaApp
enable
Two
FaApp
(
data
:
Enable2faAppRequest
)
:
Promise
<
SDKRespond
>
Parameters
data:
Enable2faAppRequest
Returns
Promise
<
SDKRespond
>
enroll2fa
enroll2fa
(
userIds
:
string
[]
)
:
Promise
<
SDKRespond
>
Parameters
userIds:
string
[]
Returns
Promise
<
SDKRespond
>
Protected
error
Handler
error
Handler
(
reqMethode
:
HttpMethod
, endpointName
:
any
, error
:
any
)
:
GetEntityError
|
CreateEntityError
|
UpdateEntityError
|
DeleteEntityError
Parameters
reqMethode:
HttpMethod
endpointName:
any
error:
any
Returns
GetEntityError
|
CreateEntityError
|
UpdateEntityError
|
DeleteEntityError
: GetEntityError | CreateEntityError | UpdateEntityError | DeleteEntityError
generate
Iframe
Token
generate
Iframe
Token
(
generateIframeTokenReq
:
GenerateIframeTokenRequest
)
:
Promise
<
SDKRespond
>
Parameters
generateIframeTokenReq:
GenerateIframeTokenRequest
Returns
Promise
<
SDKRespond
>
generate
User
Api
Token
generate
User
Api
Token
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
generate
User
Recovery
Code
generate
User
Recovery
Code
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
get
get
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
get
All
Users
get
All
Users
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
get
Api
Token
Details
get
Api
Token
Details
(
user_id
:
string
)
:
Promise
<
SDKRespond
>
Parameters
Optional
user_id:
string
Returns
Promise
<
SDKRespond
>
Private
get
Defualt
Logged
InUser
Props
get
Defualt
Logged
InUser
Props
(
passedParams
:
any
, requieredFields
:
string
[]
)
:
Promise
<
any
>
Parameters
passedParams:
any
requieredFields:
string
[]
Returns
Promise
<
any
>
get
Logged
InUser
get
Logged
InUser
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
get
User
ById
get
User
ById
(
user_id
:
string
)
:
Promise
<
SDKRespond
>
Parameters
user_id:
string
Returns
Promise
<
SDKRespond
>
get
User
ByToken
get
User
ByToken
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
make
Api
Call
make
Api
Call
(
endpointName
:
string
, data
:
any
)
:
Promise
<
SDKRespond
>
Parameters
endpointName:
string
Optional
data:
any
Returns
Promise
<
SDKRespond
>
Protected
prepare
Api
Url
Queries
prepare
Api
Url
Queries
(
data
:
any
[]
)
:
ApiUrlQueries
Parameters
data:
any
[]
Returns
ApiUrlQueries
request
Two
FaApp
request
Two
FaApp
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
revoke
Api
Token
revoke
Api
Token
(
id
:
string
)
:
Promise
<
SDKRespond
>
Parameters
id:
string
Returns
Promise
<
SDKRespond
>
sing
Eula
sing
Eula
(
)
:
Promise
<
SDKRespond
>
Returns
Promise
<
SDKRespond
>
trigger
Reset
Password
OnNext
Login
trigger
Reset
Password
OnNext
Login
(
userIds
:
string
[]
)
:
Promise
<
SDKRespond
>
Parameters
userIds:
string
[]
Returns
Promise
<
SDKRespond
>
update
update
(
data
:
UpdateUserRequest
, id
:
string
)
:
Promise
<
SDKRespond
>
Parameters
data:
UpdateUserRequest
Optional
id:
string
Returns
Promise
<
SDKRespond
>
user
Info
user
Info
(
id
:
string
)
:
Promise
<
SDKRespond
>
Parameters
Optional
id:
string
Returns
Promise
<
SDKRespond
>
verify
Code
verify
Code
(
data
:
VerifyCodeRequest
)
:
Promise
<
SDKRespond
>
Parameters
data:
VerifyCodeRequest
Returns
Promise
<
SDKRespond
>
verify
Email
verify
Email
(
id
:
string
)
:
Promise
<
SDKRespond
>
Parameters
id:
string
Returns
Promise
<
SDKRespond
>
Globals
Users
constructor
api
Call
end
Points
entity
Name
change
User
Password
check
Tenant
Admin
check
Viewer
Auth
create
delete
disable
Two
Fa
enable
Two
Fa
enable
Two
FaApp
enroll2fa
error
Handler
generate
Iframe
Token
generate
User
Api
Token
generate
User
Recovery
Code
get
get
All
Users
get
Api
Token
Details
get
Defualt
Logged
InUser
Props
get
Logged
InUser
get
User
ById
get
User
ByToken
make
Api
Call
prepare
Api
Url
Queries
request
Two
FaApp
revoke
Api
Token
sing
Eula
trigger
Reset
Password
OnNext
Login
update
user
Info
verify
Code
verify
Email
Generated using
TypeDoc