UserController
extends UserController
in package
Class UserController.
Table of Contents
- $config : AirlayConfig
- $request : Request
- $user : UserEntity
- $status : StatusPage|null
- $tokenHandler : TokenHandler|null
- __destruct() : mixed
- afterExecuteRoute() : mixed
- authAction() : string
- Auth action.
- authAsAction() : string
- Authorization as another user request( 'method' => 'POST', 'url' => '/api/v4/user/authAs', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'User id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] ).
- beforeExecuteRoute() : mixed
- blockAction() : bool|string
- Block a user by id
- changePasswordAction() : string
- Change password request( 'method' => 'POST', 'url' => '/api/v4/user/changePassword', 'params' => [ [ 'name' => 'oldPassword', 'type' => 'string', 'description' => 'Old user password', 'require' => true ], [ 'name' => 'newPassword', 'type' => 'string', 'description' => 'New user password', 'require' => true ], [ 'name' => 'confirmationPassword', 'type' => 'string', 'description' => 'Confirmation user password', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
- confirmRegistrationAction() : string
- Confirm user registration.
- createAction() : string|false
- Create user request( 'method' => 'POST', 'url' => '/api/v4/user/create', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'User name', 'require' => true ], [ 'name' => 'password', 'type' => 'string', 'description' => 'User password', 'require' => false ], [ 'name' => 'email', 'type' => 'string', 'description' => 'User email', 'require' => true ], [ 'name' => 'firstName', 'type' => 'string', 'description' => 'User first name', 'require' => false ], [ 'name' => 'lastName', 'type' => 'string', 'description' => 'User last name', 'require' => false ], [ 'name' => 'secondName', 'type' => 'string', 'description' => 'User second name', 'require' => false ], [ 'name' => 'number', 'type' => 'string', 'description' => 'User phone number', 'require' => false ], [ 'name' => 'position', 'type' => 'string', 'description' => 'User position', 'require' => false ], [ 'name' => 'department', 'type' => 'string', 'description' => 'User department', 'require' => false ], [ 'name' => 'templateId', 'type' => 'ObjectId', 'description' => 'Template id for email message', 'require' => false ], ] ) response( '200' => [ 'status' => 200, 'message' => UserEntity, 'code' => 0 ] ).
- deleteAction() : string
- Delete user request( 'method' => 'POST', 'url' => '/api/v4/user/delete', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'User id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
- deleteByIdsAction() : string
- Delete users request( 'method' => 'POST', 'url' => '/api/v4/user/deleteByIds', 'params' => [ [ 'name' => 'ids', 'type' => 'objectId[]', 'description' => 'Users ids', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
- deleteByRegexAction() : string|bool
- Delete users by regex request( 'method' => 'POST', 'url' => '/api/v4/user/deleteByRegex', 'params' => [ [ 'name' => 'value', 'type' => 'string', 'description' => 'value regex for delete', 'require' => true ], [ 'name' => 'field', 'type' => 'string', 'description' => 'field for delete ['name', 'email']', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] ).
- findUsersByIdsAction() : string
- findUsersByNamesAction() : string
- Get users filtered by name.
- generateLoginAction() : bool|string
- Generate random user login by template from config
- geocodeAction() : string
- Coordinates geocoding.
- getAction() : string
- Get all organization users info or organization user info by id request( 'method' => 'GET', 'url' => '/api/v4/user/get', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'User id', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => Array<UserInfo>, 'code' => 0 ] ).
- getByNameOrFullNameAction() : string
- Get users by name or full name.
- getMinimizedAction() : string
- Get all organization users minimized info request( 'method' => 'GET', 'url' => '/api/v4/user/getMinimized', ) response( '200' => [ 'status' => 200, 'message' => [ [ '_id' => ObjectId, 'name' => string, 'fullName' => string, 'image' => [ 'big' => 'user avatar/user id: $_id/big.$extension", 'medium' => 'user avatar/user id: $_id/medium.$extension", 'small' => 'user avatar/user id: $_id/small.$extension" ] ($_id = userId, $extension = image extension) ], ... ], 'code' => 0 ] ).
- getPasswordConfigAction() : bool|string
- Get password configuration
- getRoleAction() : string
- Get role for portal or cms request([ 'method' => 'GET', 'url' => 'api/v3/user/getRole', 'params' => [ [ 'name' => 'portalId', 'type' => 'int', 'required' => false ] ] ]) response([ 'status' => 200, 'message' = 'Guest' | 'User' | 'CmsUser', 'code' => 0 ]).
- getServiceTokenAction() : string
- Generate service token for user request( 'method' => 'GET', 'url' => '/api/v4/user/getServiceToken', 'params' => [ [ 'name' => 'userId', 'type' => 'objectId', 'description' => 'User id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] )
- getUploadLogsAction() : void
- getUserInfoAction() : bool|string
- Confirm user registration.
- getUserSearchAction() : string|false
- Get users search.
- getUserWindowPositionAction() : string
- Get user window position.
- indexAction() : mixed
- initialize() : void
- isUsernameUniqueAction() : bool|string
- Verify that user name is unique
- listAction() : bool|string
- Get user list
- logoutAction() : string
- Logout user request( 'method' => 'POST', 'url' => '/api/v3/user/logout', 'params' => [ [ 'name' => 'refresh_token', 'type' => 'string', 'description' => 'Refresh token', 'require' => true ] ] ) response([ 'status' => 200, 'message' => Ok, 'code' => 0 ])
- performUserSearchAction() : string
- Perform user search.
- performUserSearchCountAction() : string
- get count of objects in search request( 'method' => 'GET'|'POST', 'url' => '/api/v4/user/performUserSearchCount', 'params' => [ [ 'name' => 'searchId', 'type' => 'objectId', 'description' => 'Search id', 'require' => true ], [ 'name' => 'queries', 'type' => 'json', 'description' => 'Json array quires', 'default' => '[]' 'require' => false ], [ 'name' => 'objectType', 'type' => 'string', 'description' => 'Object type: Feature or Relation', 'require' => false, 'default' => 'Features' ], [ 'name' => 'restriction', 'type' => 'json', 'description' => 'Additional restriction for search', 'require' => false ], [ 'name' => 'filter', 'type' => 'string', 'description' => 'Filter for searching', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'Dataset for searching', 'required' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => int, 'code' => 0 ] ).
- pinCodeAuthAction() : string
- Authorization by pin code request( 'method' => 'POST', 'url' => '/api/v3/user/pinCodeAuth', 'params' => [ [ 'name' => 'pinCode', 'type' => 'absint', 'description' => 'Authorization pin code', 'require' => true ], [ 'name' => 'token', 'type' => 'string', 'description' => 'Token for authorization by pin code', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => [ 'access_token' => JWT, 'refresh_token' => JWT ], 'code' => 0 ] ).
- refreshTokensAction() : mixed
- registrationAction() : string
- Registration new user request( 'method' => 'POST', 'url' => '/api/v3/user/registration', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'user login', 'require' => true ], [ 'name' => 'password', 'type' => 'string', 'description' => 'user password', 'require' => true ], [ 'name' => 'email', 'type' => 'string', 'description' => 'user email', 'require' => true ], [ 'name' => 'organization', 'type' => 'string', 'description' => 'organization name', 'require' => true ], [ 'name' => 'firstName', 'type' => 'string', 'description' => 'user firstName', 'require' => false ], [ 'name' => 'secondName', 'type' => 'string', 'description' => 'user secondName', 'require' => false ], [ 'name' => 'lastName', 'type' => 'string', 'description' => 'user lastName', 'require' => false ], [ 'name' => 'number', 'type' => 'string', 'description' => 'user phone number', 'require' => false ], [ 'name' => 'portalId', 'type' => 'ObjectId', 'description' => 'registration portal id', 'require' => false ], [ 'name' => 'organizationTemplate', 'type' => 'ObjectId', 'description' => 'organizationTemplateId', 'require' => false ], [ 'name' => 'domain', 'type' => 'string', 'description' => 'organization domain', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] ).
- restorePasswordAction() : void
- Restore password request([ 'method' => 'POST', 'url' => 'api/v4/user/restorePassword', 'params' => [ [ 'password' => 'email', 'type' => 'string', 'required' => true ] [ 'token' => 'portalId', 'type' => 'int', 'required' => false ] ] ]) response([ 'status' => 200, 'message' = 'OK', 'code' => 0 ]).
- restoreUserPasswordAction() : string
- Delete user request( 'method' => 'POST', 'url' => '/api/v4/user/restoreUserPassword', 'params' => [ [ 'name' => 'userId', 'type' => 'objectId', 'description' => 'User id', 'require' => true ], [ 'name' => 'portalId', 'type' => 'int', 'description' => 'Portal id', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
- saveUserWindowPositionAction() : string
- Save user window position.
- setPasswordAction() : string
- Set user password request([ 'method' => 'POST', 'url' => 'api/v3/user/setPassword', 'params' => [ [ 'name' => 'userId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'password', 'type' => 'string', 'required' => false ] ] ]) response([ 'status' => 'OK', 'message' = 'OK', 'code' => 0 ]).
- setPasswordByKeyAction() : void
- Set password by key request([ 'method' => 'POST', 'url' => 'api/v3/user/setPasswordByKey', 'params' => [ [ 'name' => 'password', 'type' => 'string', 'required' => true ] [ 'name' => 'key', 'type' => 'string', 'required' => true ] ] ]) response([ 'status' => 200, 'message' = 'OK', 'code' => 0 ]).
- setPasswordByTokenAction() : string
- Set password by token request([ 'method' => 'POST', 'url' => 'api/v3/user/changePasswordByToken', 'params' => [ [ 'password' => 'password', 'type' => 'string', 'required' => true ] [ 'token' => 'token', 'type' => 'string', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' = User, 'code' => 0 ]).
- unblockAction() : bool|string
- Unblock a user by id
- unlinkAccountAction() : bool|string
- Unlink current user linked account by type
- updateAction() : bool|string
- Update user info and password request( 'method' => 'POST', 'url' => '/api/v4/user/update', 'params' => [ [ 'name' => 'password', 'type' => 'string', 'description' => 'User password', 'require' => false ], [ 'name' => 'firstName', 'type' => 'string', 'description' => 'User first name', 'require' => false ], [ 'name' => 'lastName', 'type' => 'string', 'description' => 'User last name', 'require' => false ], [ 'name' => 'secondName', 'type' => 'string', 'description' => 'User second name', 'require' => false ], [ 'name' => 'department', 'type' => 'string', 'description' => 'Department name', 'require' => false ], [ 'name' => 'number', 'type' => 'string', 'description' => 'Pnone number', 'require' => false ], [ 'name' => 'position', 'type' => 'string', 'description' => 'Position in the organization', 'require' => false ], [ 'name' => 'image', 'type' => 'string', 'require' => false ], [ 'name' => 'SAPLogin', 'type' => 'string', 'require' => false ], [ 'name' => 'status', 'type' => 'string', 'require' => false ], [ 'name' => 'twoFactorAuthorizationType', 'type' => 'string', 'require' => false ], [ 'name' => 'addtionalInfo', 'type' => 'array', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
- updateUserInfoAction() : 200
- POST Update user info.
- uploadUsersAction() : string
- Upload users request( 'method' => 'POST', 'url' => '/api/v4/user/upload_users', 'params' => [ [ 'name' => 'format', 'type' => 'string', 'description' => 'Format of uploaded file', 'default' => 'xlsx' 'require' => false ], [ 'name' => 'portalId', 'type' => 'absint', 'description' => 'Portal id', 'require' => false ], [ 'name' => 'Template id', 'type' => 'objectId', 'description' => 'Template id for email notification of uploaded users', 'require' => false ], [ 'name' => 'language', 'type' => 'string', 'required' => false ], ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
- verifyAction() : string|false
- Verified new user request( 'method' => 'POST', 'url' => '/api/v3/user/verify', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'user id', 'require' => true ], [ 'name' => 'isVerified', 'type' => 'bool', 'description' => 'verified user or not', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] ).
- generateUnicKey() : string
- getId() : mixed
- getUserInfo() : UserEntity
- isTwoFactorAuthorizationEnabled() : bool
- secureData() : mixed
- sendEmail() : mixed
- twoFactorAuthorization() : array<string|int, mixed>
- checkAttemptsCount() : void
- sendRegistrationSupportMessage() : void
Properties
$config
public
AirlayConfig
$config
$request
public
Request
$request
$user
public
UserEntity
$user
$status
protected
StatusPage|null
$status
$tokenHandler
protected
TokenHandler|null
$tokenHandler
Methods
__destruct()
public
__destruct() : mixed
Return values
mixed —afterExecuteRoute()
public
afterExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
- $dispatcher : Dispatcher
Return values
mixed —authAction()
Auth action.
public
authAction() : string
request( 'method' => 'GET', 'url' => '/api/v4/user/auth', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'username', 'require' => true ], [ 'name' => 'password', 'type' => 'string', 'description' => 'user password', 'require' => true ], [ 'name' => 'deviceId', 'type' => 'string', 'description' => 'deviceId', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => string 'code' => 0 ] )
Tags
Return values
string —authAsAction()
Authorization as another user request( 'method' => 'POST', 'url' => '/api/v4/user/authAs', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'User id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] ).
public
authAsAction() : string
Tags
Return values
string —beforeExecuteRoute()
public
beforeExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
- $dispatcher : Dispatcher
Return values
mixed —blockAction()
Block a user by id
public
blockAction() : bool|string
request( 'method' => 'GET', 'url' => '/api/v4/user/block', 'params' => [ [ 'name' => 'userId', 'type' => 'objectId', 'description' => 'User id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => Ok, 'code' => 0 ] )
Tags
Return values
bool|string —changePasswordAction()
Change password request( 'method' => 'POST', 'url' => '/api/v4/user/changePassword', 'params' => [ [ 'name' => 'oldPassword', 'type' => 'string', 'description' => 'Old user password', 'require' => true ], [ 'name' => 'newPassword', 'type' => 'string', 'description' => 'New user password', 'require' => true ], [ 'name' => 'confirmationPassword', 'type' => 'string', 'description' => 'Confirmation user password', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
public
changePasswordAction() : string
Tags
Return values
string —confirmRegistrationAction()
Confirm user registration.
public
confirmRegistrationAction() : string
request( 'method' => 'POST', 'url' => '/api/v3/user/confirm', 'params' => [ [ 'name' => 'key', 'type' => 'string', 'description' => 'Confirm key', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => [ 'access_token' => JWT, 'refresh_token' => JWT ], 'code' => 0 ] ).
Tags
Return values
string —createAction()
Create user request( 'method' => 'POST', 'url' => '/api/v4/user/create', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'User name', 'require' => true ], [ 'name' => 'password', 'type' => 'string', 'description' => 'User password', 'require' => false ], [ 'name' => 'email', 'type' => 'string', 'description' => 'User email', 'require' => true ], [ 'name' => 'firstName', 'type' => 'string', 'description' => 'User first name', 'require' => false ], [ 'name' => 'lastName', 'type' => 'string', 'description' => 'User last name', 'require' => false ], [ 'name' => 'secondName', 'type' => 'string', 'description' => 'User second name', 'require' => false ], [ 'name' => 'number', 'type' => 'string', 'description' => 'User phone number', 'require' => false ], [ 'name' => 'position', 'type' => 'string', 'description' => 'User position', 'require' => false ], [ 'name' => 'department', 'type' => 'string', 'description' => 'User department', 'require' => false ], [ 'name' => 'templateId', 'type' => 'ObjectId', 'description' => 'Template id for email message', 'require' => false ], ] ) response( '200' => [ 'status' => 200, 'message' => UserEntity, 'code' => 0 ] ).
public
createAction() : string|false
Tags
Return values
string|false —deleteAction()
Delete user request( 'method' => 'POST', 'url' => '/api/v4/user/delete', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'User id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
public
deleteAction() : string
Tags
Return values
string —deleteByIdsAction()
Delete users request( 'method' => 'POST', 'url' => '/api/v4/user/deleteByIds', 'params' => [ [ 'name' => 'ids', 'type' => 'objectId[]', 'description' => 'Users ids', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
public
deleteByIdsAction() : string
Tags
Return values
string —deleteByRegexAction()
Delete users by regex request( 'method' => 'POST', 'url' => '/api/v4/user/deleteByRegex', 'params' => [ [ 'name' => 'value', 'type' => 'string', 'description' => 'value regex for delete', 'require' => true ], [ 'name' => 'field', 'type' => 'string', 'description' => 'field for delete ['name', 'email']', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] ).
public
deleteByRegexAction() : string|bool
Tags
Return values
string|bool —findUsersByIdsAction()
public
findUsersByIdsAction() : string
Return values
string —findUsersByNamesAction()
Get users filtered by name.
public
findUsersByNamesAction() : string
request([ 'method' => 'GET', 'url' => '/api/v3/user/findUsersByNames' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => 'true' ] ]) response([ 'status' => 200, 'message' => UserEntity[], 'code' => 0 ]).
Tags
Return values
string —generateLoginAction()
Generate random user login by template from config
public
generateLoginAction() : bool|string
request( 'method' => 'GET', 'url' => '/api/v4/user/generateLogin', 'params' => [] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] )
Tags
Return values
bool|string —geocodeAction()
Coordinates geocoding.
public
geocodeAction() : string
request([ 'method' => 'GET', 'url' => '/api/v3/user/geocode' 'params' => [ [ 'name' => 'query', 'type' => 'string', 'required' => 'true' ] ]) response([ 'status' => 200, 'message' => Search result, 'code' => 0 ])
Return values
string —getAction()
Get all organization users info or organization user info by id request( 'method' => 'GET', 'url' => '/api/v4/user/get', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'User id', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => Array<UserInfo>, 'code' => 0 ] ).
public
getAction() : string
Tags
Return values
string —getByNameOrFullNameAction()
Get users by name or full name.
public
getByNameOrFullNameAction() : string
request(
'method' => 'GET',
'url' => '/api/v4/user/getByNameOrFullName',
'params' => [
[
'name' => 'query',
'type' => 'string',
'description' => 'part of name or full name',
'require' => false
],
[
'name' => 'sortField',
'type' => 'string',
'description' => 'field for sort',
'require' => false
],
[
'name' => 'sortOrder',
'type' => 'asc' | 'desc',
'description' => 'sort order',
'require' => false
],
[
'name' => 'skip',
'type' => 'absint',
'require' => false
],
[
'name' => 'limit',
'type' => 'absint',
'require' => false
]
]
)
response(
'200' => [
'status' => 200,
'message' => [
'users' => Array
Tags
Return values
string —getMinimizedAction()
Get all organization users minimized info request( 'method' => 'GET', 'url' => '/api/v4/user/getMinimized', ) response( '200' => [ 'status' => 200, 'message' => [ [ '_id' => ObjectId, 'name' => string, 'fullName' => string, 'image' => [ 'big' => 'user avatar/user id: $_id/big.$extension", 'medium' => 'user avatar/user id: $_id/medium.$extension", 'small' => 'user avatar/user id: $_id/small.$extension" ] ($_id = userId, $extension = image extension) ], ... ], 'code' => 0 ] ).
public
getMinimizedAction() : string
Tags
Return values
string —getPasswordConfigAction()
Get password configuration
public
getPasswordConfigAction() : bool|string
request( 'method' => 'GET', 'url' => '/api/v4/user/getPasswordConfig', 'params' => [] ) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] )
Return values
bool|string —getRoleAction()
Get role for portal or cms request([ 'method' => 'GET', 'url' => 'api/v3/user/getRole', 'params' => [ [ 'name' => 'portalId', 'type' => 'int', 'required' => false ] ] ]) response([ 'status' => 200, 'message' = 'Guest' | 'User' | 'CmsUser', 'code' => 0 ]).
public
getRoleAction() : string
Tags
Return values
string —getServiceTokenAction()
Generate service token for user request( 'method' => 'GET', 'url' => '/api/v4/user/getServiceToken', 'params' => [ [ 'name' => 'userId', 'type' => 'objectId', 'description' => 'User id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] )
public
getServiceTokenAction() : string
Tags
Return values
string —getUploadLogsAction()
public
getUploadLogsAction() : void
Tags
Return values
void —getUserInfoAction()
Confirm user registration.
public
getUserInfoAction() : bool|string
request( 'method' => 'GET', 'url' => '/api/v3/user/getUserInfo', 'params' => [ [ 'name' => 'portalId', 'type' => 'absint', 'description' => 'Portal id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => UserEntity, 'code' => 0 ] ).
Tags
Return values
bool|string —getUserSearchAction()
Get users search.
public
getUserSearchAction() : string|false
request([ 'method' => 'GET', 'url' => '/api/v3/user/getUserSearch' 'params' => [ [ 'name' => 'portalId', 'type' => 'int', 'required' => 'true' ] ]) response([ 'status' => 200, 'message' => SearchingEntity[], 'code' => 0 ]).
Tags
Return values
string|false —getUserWindowPositionAction()
Get user window position.
public
getUserWindowPositionAction() : string
request([ 'method' => 'GET', 'url' => '/api/v3/user/getUserWindowPosition' 'params' => [ [ 'name' => 'query', 'type' => 'string', 'required' => 'true' ] ]) response([ 'status' => 200, 'message' => Window position, 'code' => 0 ])
Tags
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —isUsernameUniqueAction()
Verify that user name is unique
public
isUsernameUniqueAction() : bool|string
request( 'method' => 'GET', 'url' => '/api/v4/user/isUsernameUnique', 'params' => [ [ 'name' => 'username', 'type' => 'string', 'description' => 'User name', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => bool, 'code' => 0 ] )
Tags
Return values
bool|string —listAction()
Get user list
public
listAction() : bool|string
request( 'method' => 'GET', 'url' => '/api/v4/user/list', 'params' => [ [ 'name' => 'query', 'type' => 'string', 'description' => 'Search query by name or full name', 'require' => false, 'default' = '' ], [ 'name' => 'blocked', 'type' => 'bool', 'description' => 'User blocking flag', 'require' => false, 'default' = false ], [ 'name' => 'isVerified', 'type' => 'string', 'description' => 'User verification flag', 'require' => false, 'default' = true ], [ 'name' => 'registrationTimeStart', 'type' => 'unixtime', 'description' => 'Registration time start', 'require' => false, 'default' = 0 ], [ 'name' => 'registrationTimeEnd', 'type' => 'unixtime', 'description' => 'Registration time end', 'require' => false, 'default' = current Unix timestamp ], [ 'name' => 'authorizationTimeStart', 'type' => 'unixtime', 'description' => 'Authorization time start', 'require' => false, 'default' = 0 ], [ 'name' => 'authorizationTimeEnd', 'type' => 'unixtime', 'description' => 'Authorization time end', 'require' => false, 'default' = current Unix timestamp ], [ 'name' => 'sortField', 'type' => 'string', 'description' => 'Sorting field', 'require' => false, 'default' = _id ], [ 'name' => 'sortOrder', 'type' => 'string', 'description' => 'Sorting order, asc or desc', 'require' => false, 'default' = asc ], [ 'name' => 'skip', 'type' => 'absint', 'description' => 'How many users to skip before returning the first user in the result', 'require' => false, 'default' = 0 ], [ 'name' => 'limit', 'type' => 'absint', 'description' => 'Sets a limit of users returned in the result', 'require' => false, 'default' = 10 ], ] ) response( '200' => [ 'status' => 200, 'message' => UserEntity[], 'code' => 0 ] )
Tags
Return values
bool|string —logoutAction()
Logout user request( 'method' => 'POST', 'url' => '/api/v3/user/logout', 'params' => [ [ 'name' => 'refresh_token', 'type' => 'string', 'description' => 'Refresh token', 'require' => true ] ] ) response([ 'status' => 200, 'message' => Ok, 'code' => 0 ])
public
logoutAction() : string
Tags
Return values
string —performUserSearchAction()
Perform user search.
public
performUserSearchAction() : string
request( 'method' => 'GET'|'POST', 'url' => '/api/v4/user/performUserSearch', 'params' => [ [ 'name' => 'type', 'type' => 'string', 'description' => 'Search type(user/system)', 'require' => true ], [ 'name' => 'queries', 'type' => 'array', 'description' => 'Search query', 'require' => true ], [ 'name' => 'backName', 'type' => 'string', 'description' => 'Search name, only for system searching', 'require' => false ], [ 'name' => 'searchId', 'type' => 'ObjectId', 'description' => 'SearchEngine id, only for user searching', 'require' => false ], [ 'name' => 'objectType', 'type' => 'string', 'description' => 'Features/Relations', 'require' => false ], [ 'name' => 'filter', 'type' => 'string', 'description' => 'filter for find objects', 'require' => false ], [ 'name' => 'skip', 'type' => 'int', 'description' => 'Skip items in result', 'require' => false ], [ 'name' => 'limit', 'type' => 'int', 'description' => 'Limit items in result', 'require' => false ], [ 'name' => 'restriction', 'type' => 'array', 'description' => 'Restrict query $restriction['type'] Type of geometry restriction: circle/area/bbox $restriction['payload'] Restrict variables: circle: [[point], radius] bbox: [[coordinates]] area: [[coordinates]]', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => Search result, 'code' => 0 ] )
Tags
Return values
string —performUserSearchCountAction()
get count of objects in search request( 'method' => 'GET'|'POST', 'url' => '/api/v4/user/performUserSearchCount', 'params' => [ [ 'name' => 'searchId', 'type' => 'objectId', 'description' => 'Search id', 'require' => true ], [ 'name' => 'queries', 'type' => 'json', 'description' => 'Json array quires', 'default' => '[]' 'require' => false ], [ 'name' => 'objectType', 'type' => 'string', 'description' => 'Object type: Feature or Relation', 'require' => false, 'default' => 'Features' ], [ 'name' => 'restriction', 'type' => 'json', 'description' => 'Additional restriction for search', 'require' => false ], [ 'name' => 'filter', 'type' => 'string', 'description' => 'Filter for searching', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'Dataset for searching', 'required' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => int, 'code' => 0 ] ).
public
performUserSearchCountAction() : string
Tags
Return values
string —pinCodeAuthAction()
Authorization by pin code request( 'method' => 'POST', 'url' => '/api/v3/user/pinCodeAuth', 'params' => [ [ 'name' => 'pinCode', 'type' => 'absint', 'description' => 'Authorization pin code', 'require' => true ], [ 'name' => 'token', 'type' => 'string', 'description' => 'Token for authorization by pin code', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => [ 'access_token' => JWT, 'refresh_token' => JWT ], 'code' => 0 ] ).
public
pinCodeAuthAction() : string
Tags
Return values
string —refreshTokensAction()
public
refreshTokensAction() : mixed
Return values
mixed —registrationAction()
Registration new user request( 'method' => 'POST', 'url' => '/api/v3/user/registration', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'user login', 'require' => true ], [ 'name' => 'password', 'type' => 'string', 'description' => 'user password', 'require' => true ], [ 'name' => 'email', 'type' => 'string', 'description' => 'user email', 'require' => true ], [ 'name' => 'organization', 'type' => 'string', 'description' => 'organization name', 'require' => true ], [ 'name' => 'firstName', 'type' => 'string', 'description' => 'user firstName', 'require' => false ], [ 'name' => 'secondName', 'type' => 'string', 'description' => 'user secondName', 'require' => false ], [ 'name' => 'lastName', 'type' => 'string', 'description' => 'user lastName', 'require' => false ], [ 'name' => 'number', 'type' => 'string', 'description' => 'user phone number', 'require' => false ], [ 'name' => 'portalId', 'type' => 'ObjectId', 'description' => 'registration portal id', 'require' => false ], [ 'name' => 'organizationTemplate', 'type' => 'ObjectId', 'description' => 'organizationTemplateId', 'require' => false ], [ 'name' => 'domain', 'type' => 'string', 'description' => 'organization domain', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] ).
public
registrationAction() : string
Tags
Return values
string —restorePasswordAction()
Restore password request([ 'method' => 'POST', 'url' => 'api/v4/user/restorePassword', 'params' => [ [ 'password' => 'email', 'type' => 'string', 'required' => true ] [ 'token' => 'portalId', 'type' => 'int', 'required' => false ] ] ]) response([ 'status' => 200, 'message' = 'OK', 'code' => 0 ]).
public
restorePasswordAction() : void
Tags
Return values
void —restoreUserPasswordAction()
Delete user request( 'method' => 'POST', 'url' => '/api/v4/user/restoreUserPassword', 'params' => [ [ 'name' => 'userId', 'type' => 'objectId', 'description' => 'User id', 'require' => true ], [ 'name' => 'portalId', 'type' => 'int', 'description' => 'Portal id', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
public
restoreUserPasswordAction() : string
Tags
Return values
string —saveUserWindowPositionAction()
Save user window position.
public
saveUserWindowPositionAction() : string
request([ 'method' => 'POST', 'url' => '/api/v3/user/saveUserWindowPosition' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => 'true' ], [ 'name' => 'value', 'type' => 'json', 'required' => 'true' ] ]) response([ 'status' => 200, 'message' => Window position, 'code' => 0 ])
Tags
Return values
string —setPasswordAction()
Set user password request([ 'method' => 'POST', 'url' => 'api/v3/user/setPassword', 'params' => [ [ 'name' => 'userId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'password', 'type' => 'string', 'required' => false ] ] ]) response([ 'status' => 'OK', 'message' = 'OK', 'code' => 0 ]).
public
setPasswordAction() : string
Tags
Return values
string —setPasswordByKeyAction()
Set password by key request([ 'method' => 'POST', 'url' => 'api/v3/user/setPasswordByKey', 'params' => [ [ 'name' => 'password', 'type' => 'string', 'required' => true ] [ 'name' => 'key', 'type' => 'string', 'required' => true ] ] ]) response([ 'status' => 200, 'message' = 'OK', 'code' => 0 ]).
public
setPasswordByKeyAction() : void
Tags
Return values
void —setPasswordByTokenAction()
Set password by token request([ 'method' => 'POST', 'url' => 'api/v3/user/changePasswordByToken', 'params' => [ [ 'password' => 'password', 'type' => 'string', 'required' => true ] [ 'token' => 'token', 'type' => 'string', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' = User, 'code' => 0 ]).
public
setPasswordByTokenAction() : string
Tags
Return values
string —unblockAction()
Unblock a user by id
public
unblockAction() : bool|string
request( 'method' => 'GET', 'url' => '/api/v4/user/unblock', 'params' => [ [ 'name' => 'userId', 'type' => 'objectId', 'description' => 'User id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => Ok, 'code' => 0 ] )
Tags
Return values
bool|string —unlinkAccountAction()
Unlink current user linked account by type
public
unlinkAccountAction() : bool|string
request( 'method' => 'GET', 'url' => '/api/v4/user/unlinkAccount', 'params' => [ [ 'name' => 'type', 'type' => 'string', 'description' => 'linked account type', 'require' => true ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] )
Return values
bool|string —updateAction()
Update user info and password request( 'method' => 'POST', 'url' => '/api/v4/user/update', 'params' => [ [ 'name' => 'password', 'type' => 'string', 'description' => 'User password', 'require' => false ], [ 'name' => 'firstName', 'type' => 'string', 'description' => 'User first name', 'require' => false ], [ 'name' => 'lastName', 'type' => 'string', 'description' => 'User last name', 'require' => false ], [ 'name' => 'secondName', 'type' => 'string', 'description' => 'User second name', 'require' => false ], [ 'name' => 'department', 'type' => 'string', 'description' => 'Department name', 'require' => false ], [ 'name' => 'number', 'type' => 'string', 'description' => 'Pnone number', 'require' => false ], [ 'name' => 'position', 'type' => 'string', 'description' => 'Position in the organization', 'require' => false ], [ 'name' => 'image', 'type' => 'string', 'require' => false ], [ 'name' => 'SAPLogin', 'type' => 'string', 'require' => false ], [ 'name' => 'status', 'type' => 'string', 'require' => false ], [ 'name' => 'twoFactorAuthorizationType', 'type' => 'string', 'require' => false ], [ 'name' => 'addtionalInfo', 'type' => 'array', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
public
updateAction() : bool|string
Tags
Return values
bool|string —updateUserInfoAction()
POST Update user info.
public
updateUserInfoAction() : 200
Tags
Return values
200 —OK
uploadUsersAction()
Upload users request( 'method' => 'POST', 'url' => '/api/v4/user/upload_users', 'params' => [ [ 'name' => 'format', 'type' => 'string', 'description' => 'Format of uploaded file', 'default' => 'xlsx' 'require' => false ], [ 'name' => 'portalId', 'type' => 'absint', 'description' => 'Portal id', 'require' => false ], [ 'name' => 'Template id', 'type' => 'objectId', 'description' => 'Template id for email notification of uploaded users', 'require' => false ], [ 'name' => 'language', 'type' => 'string', 'required' => false ], ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] ).
public
uploadUsersAction() : string
Tags
Return values
string —verifyAction()
Verified new user request( 'method' => 'POST', 'url' => '/api/v3/user/verify', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'user id', 'require' => true ], [ 'name' => 'isVerified', 'type' => 'bool', 'description' => 'verified user or not', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => string, 'code' => 0 ] ).
public
verifyAction() : string|false
Tags
Return values
string|false —generateUnicKey()
protected
generateUnicKey(array<string|int, mixed> $props) : string
Parameters
- $props : array<string|int, mixed>
Return values
string —getId()
protected
getId() : mixed
Return values
mixed —getUserInfo()
protected
getUserInfo() : UserEntity
Tags
Return values
UserEntity —isTwoFactorAuthorizationEnabled()
protected
isTwoFactorAuthorizationEnabled(UserEntity $user) : bool
Parameters
- $user : UserEntity
Return values
bool —secureData()
protected
secureData(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —sendEmail()
protected
sendEmail(string $email, string $name, string $subject, string $body) : mixed
Parameters
- $email : string
- $name : string
- $subject : string
- $body : string
Return values
mixed —twoFactorAuthorization()
protected
twoFactorAuthorization(UserEntity $user[, string|null $deviceId = null ]) : array<string|int, mixed>
Parameters
- $user : UserEntity
- $deviceId : string|null = null
Tags
Return values
array<string|int, mixed> —checkAttemptsCount()
private
checkAttemptsCount() : void
Tags
Return values
void —sendRegistrationSupportMessage()
private
sendRegistrationSupportMessage(UserEntity $user, string $organizationName) : void
Parameters
- $user : UserEntity
- $organizationName : string