> For the complete documentation index, see [llms.txt](https://dynamicpixels.gitbook.io/dynamicpixels-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dynamicpixels.gitbook.io/dynamicpixels-docs/users.md). # Users Explore the list of API functions available in TypeScript for managing users, including detailed descriptions and usage examples. {% hint style="warning" %} To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header. {% endhint %} ## Authentication ### Login with email This function will log in a player with a pair of email and password, and return the token as the result. ```typescript DynamicPixels.Auth.LoginWithEmail(input: LoginWithEmailParams): Promise; ``` ### Register with email This function will register a new user and then login him in and return the token. ```typescript DynamicPixels.Auth.RegisterWithEmail(input: RegisterWithEmailParams): Promise; ``` ### Login with Google With this function, you can log in user with Google Auth. ```typescript DynamicPixels.Auth.LoginWithGoogle(input: LoginWithGoogleParams): Promise; ``` ### Login as guest If you want to login users easily and don't show any form, guest login is for you! This function will login users with a unique id and mark the user as a guest. also, you can edit the user and add additional information in the future. ```typescript DynamicPixels.Auth.LoginAsGuest(input: LoginAsGuestParams): Promise; ``` ### Login with token When you login with any function, a token will return that will be used in requests to the server to identify the user. you should save this token in a safe place and load it on every game startup. to prevent login in every game session, you should call this function and pass the saved token. ```typescript DynamicPixels.Auth.LoginWithToken(input: LoginWithTokenParams): Promise; ``` ### Check OTA is ready Check if OTA is available and developer can use it. you can fall back to other login ways if it's not available. ```typescript DynamicPixels.Auth.IsOtaReady(input: IsOtaReadyParams): Promise; ``` ### Send OTA token If OTA is ready, this function will generate a random key and send it as an SMS to a specified phone number. this key is valid for a few minutes to verify. ```typescript DynamicPixels.Auth.SendOtaToken(input: SendOtaTokenParams): Promise; ``` ### Verify OTA token After sending OTA key, you should get it by a form and verify it with this function. after that, login process will be done. ```typescript ServiceHub.Authentication.VerifyOtaToken(VerifyOtaTokenParams input); ``` ### Is logged in[](https://docs.dynamicpixels.dev/users-and-devices/auth-plugin#is-logged-in) This function returns the status of the user authentication. ```typescript DynamicPixels.Auth.IsLoggedIn():boolean ``` ### Logout This function closes all connections and forgets the user's token. then you can log in another user. ```typescript DynamicPixels.Auth.Logout():void ``` ## User Management ### Find Users[](https://docs.dynamicpixels.dev/users-and-devices/users-plugin#find-users) This function helps you to find other users of the game, and then use their info in other functions. ```typescript DynamicPixels.Services.Users.FindUsers(input: T): Promise ``` ### Get Current User's Info This function returnsthe profile information of the current user ```typescript DynamicPixels.Services.Users.GetCurrentUser(): Promise ``` ### Edit Current User Info[](https://docs.dynamicpixels.dev/users-and-devices/users-plugin#edit-current-user-info) You can edit your current user profile with this function. ```typescript DynamicPixels.Services.Users.EditCurrentUser(input: T): Promise ``` ### Get User Info By Id[](https://docs.dynamicpixels.dev/users-and-devices/users-plugin#get-user-info-by-id) With this function, you can get the profile information of a specific user with his id ```typescript DynamicPixels.Services.Users.GetUserById(input: T): Promise ``` ## Device Management ### Get Users Devices[](https://docs.dynamicpixels.dev/users-and-devices/devices-plugin#get-users-devices) This function will return the active devices of the current user. ```typescript DynamicPixels.Services.Devices.GetMyDevices(): Promise; ``` ### Revoke Device Access[](https://docs.dynamicpixels.dev/users-and-devices/devices-plugin#revoke-device-access) This function removes access to a specific device and forces it login again. ```typescript DynamicPixels.Services.Devices.RevokeDevice(input: T): Promise; ``` This function disables access to the revoked device and forces it to log in again.