{"items":[{"type":"link","link":"https://developers.xsolla.com/#api","label":"Home page","labelTranslationKey":"sidebar.homePageLabel","icon":"/assets/sidebar-item-home.fd3d2b3c91f902fbc43a05c268a93377758b6172e032bbcd4cfb0211304ca738.9c1bb791.svg"},{"type":"link","label":"Login API","link":"/api/login","routeSlug":"/api/login"},{"type":"link","label":"Overview ","link":"/api/login/overview","routeSlug":"/api/login/overview"},{"type":"link","label":"IP addresses ","link":"/api/login/ip-addresses","routeSlug":"/api/login/ip-addresses"},{"type":"group","label":"Glossary ","link":"/api/login/glossary","routeSlug":"/api/login/glossary","items":[{"type":"link","label":"Rate limits ","link":"/api/login/glossary/glossary-rate-limits","routeSlug":"/api/login/glossary/glossary-rate-limits"},{"type":"link","label":"Standard Login project ","link":"/api/login/glossary/glossary-standard-login-project","routeSlug":"/api/login/glossary/glossary-standard-login-project"},{"type":"link","label":"Shadow Login project ","link":"/api/login/glossary/glossary-shadow-login-project","routeSlug":"/api/login/glossary/glossary-shadow-login-project"},{"type":"link","label":"Main account ","link":"/api/login/glossary/glossary-main-account","routeSlug":"/api/login/glossary/glossary-main-account"},{"type":"link","label":"Platform account ","link":"/api/login/glossary/glossary-platform-account","routeSlug":"/api/login/glossary/glossary-platform-account"},{"type":"link","label":"Publishing platform ","link":"/api/login/glossary/glossary-publishing-platform","routeSlug":"/api/login/glossary/glossary-publishing-platform"}]},{"type":"group","label":"Authentication ","link":"/api/login/authentication","routeSlug":"/api/login/authentication","items":[{"type":"link","label":"Authentication schemes ","link":"/api/login/authentication/authentication-schemes","routeSlug":"/api/login/authentication/authentication-schemes"},{"type":"link","label":"Getting a user token ","link":"/api/login/authentication/getting-user-token","routeSlug":"/api/login/authentication/getting-user-token"},{"type":"link","label":"Getting a server token ","link":"/api/login/authentication/getting-server-token","routeSlug":"/api/login/authentication/getting-server-token"},{"type":"link","label":"Set up server OAuth 2.0 client ","link":"/api/login/authentication/set-up-server-oauth-20-client","routeSlug":"/api/login/authentication/set-up-server-oauth-20-client"},{"type":"link","label":"Generate server JWT ","link":"/api/login/authentication/generate-server-jwt","routeSlug":"/api/login/authentication/generate-server-jwt"}]},{"type":"link","label":"Rate limits ","link":"/api/login/rate-limits","routeSlug":"/api/login/rate-limits"},{"type":"group","label":"JWT structure ","link":"/api/login/jwt-structure","routeSlug":"/api/login/jwt-structure","items":[{"type":"link","label":"User JWT ","link":"/api/login/jwt-structure/user-jwt","routeSlug":"/api/login/jwt-structure/user-jwt"},{"type":"link","label":"Main claims ","link":"/api/login/jwt-structure/jwt-main-claims","routeSlug":"/api/login/jwt-structure/jwt-main-claims"},{"type":"link","label":"PlayFab storage ","link":"/api/login/jwt-structure/playfab-storage","routeSlug":"/api/login/jwt-structure/playfab-storage"},{"type":"link","label":"Custom storage ","link":"/api/login/jwt-structure/custom-storage","routeSlug":"/api/login/jwt-structure/custom-storage"},{"type":"link","label":"Social authentication ","link":"/api/login/jwt-structure/social-authentication","routeSlug":"/api/login/jwt-structure/social-authentication"},{"type":"link","label":"Authentication via the OAuth 2.0 protocol ","link":"/api/login/jwt-structure/authentication-via-oauth-protocol","routeSlug":"/api/login/jwt-structure/authentication-via-oauth-protocol"},{"type":"link","label":"Authentication via a phone number ","link":"/api/login/jwt-structure/authentication-via-phone-number","routeSlug":"/api/login/jwt-structure/authentication-via-phone-number"},{"type":"link","label":"Server JWT ","link":"/api/login/jwt-structure/server-jwt","routeSlug":"/api/login/jwt-structure/server-jwt"}]},{"type":"link","label":"JWT validation ","link":"/api/login/jwt-validation","routeSlug":"/api/login/jwt-validation"},{"type":"link","label":"Errors ","link":"/api/login/errors","routeSlug":"/api/login/errors"},{"type":"separator","label":"Login project configuration"},{"type":"group","label":"Age restrictions","link":"/api/login/product-configuration-age-restrictions","routeSlug":"/api/login/product-configuration-age-restrictions","items":[{"label":"Delete age restriction for country","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-age-restrictions/delete-age-restriction","routeSlug":"/api/login/product-configuration-age-restrictions/delete-age-restriction","metadata":{"seo":{"title":"Delete age restriction for country","description":"Deletes age restriction for a selected country in a project."}},"httpPath":"/projects/{project_id}/age_rating"},{"label":"List age restrictions for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-age-restrictions/list-age-restrictions","routeSlug":"/api/login/product-configuration-age-restrictions/list-age-restrictions","metadata":{"seo":{"title":"List age restrictions for project","description":"Returns a list of countries with age restrictions in a project."}},"httpPath":"/projects/{project_id}/age_rating"},{"label":"Create age restriction for country","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-age-restrictions/create-age-restriction","routeSlug":"/api/login/product-configuration-age-restrictions/create-age-restriction","metadata":{"seo":{"title":"Create age restriction for country","description":"Creates or updates existing age restriction for a selected country in a project."}},"httpPath":"/projects/{project_id}/age_rating"},{"label":"Manage age restrictions for countries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-age-restrictions/batch-age-restrictions","routeSlug":"/api/login/product-configuration-age-restrictions/batch-age-restrictions","metadata":{"seo":{"title":"Manage age restrictions for countries","description":"Updates, deletes, or creates age restrictions for all countries in a project. You may set default restrictions for all countries and set country-specific restrictions, if any."}},"httpPath":"/projects/{project_id}/age_rating/batch"}]},{"type":"group","label":"Custom email templates","link":"/api/login/custom-email-templates","routeSlug":"/api/login/custom-email-templates","items":[{"label":"Get custom email template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/custom-email-templates/get-custom-email-template","routeSlug":"/api/login/custom-email-templates/get-custom-email-template","metadata":{"seo":{"title":"Get custom email template","description":"Gets all information about the specific template."}},"httpPath":"/projects/{project_id}/templates/email/{template_id}/{locale}/{template_type}"},{"label":"Create custom email template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/custom-email-templates/create-custom-email-template","routeSlug":"/api/login/custom-email-templates/create-custom-email-template","metadata":{"seo":{"title":"Create custom email template","description":"Creates an email template with custom structure, styles, and texts. You can add the variables for some texts to the template. To add the relevant texts for these variables, use the Send email based on template call."}},"httpPath":"/projects/{project_id}/templates/email/{template_id}/{locale}/{template_type}"},{"label":"Update custom email template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/custom-email-templates/update-custom-email-template","routeSlug":"/api/login/custom-email-templates/update-custom-email-template","metadata":{"seo":{"title":"Update custom email template","description":"Updates the specific custom email template."}},"httpPath":"/projects/{project_id}/templates/email/{template_id}/{locale}/{template_type}"},{"label":"Switch off welcome email","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/custom-email-templates/switch-off-welcome-email","routeSlug":"/api/login/custom-email-templates/switch-off-welcome-email","metadata":{"seo":{"title":"Switch off welcome email","description":"Switches off a welcome email."}},"httpPath":"/projects/{project_id}/welcome_email"},{"label":"Switch on welcome email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/custom-email-templates/switch-on-welcome-email","routeSlug":"/api/login/custom-email-templates/switch-on-welcome-email","metadata":{"seo":{"title":"Switch on welcome email","description":"Switches on a welcome email."}},"httpPath":"/projects/{project_id}/welcome_email"},{"label":"Send email based on template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/custom-email-templates/send-email-based-on-template","routeSlug":"/api/login/custom-email-templates/send-email-based-on-template","metadata":{"seo":{"title":"Send email based on template","description":"Sends an email based on a custom template and data that you provided to the specified email address."}},"httpPath":"/templates/email/send"}]},{"type":"group","label":"RSA keys","link":"/api/login/product-configuration-rsa","routeSlug":"/api/login/product-configuration-rsa","items":[{"label":"Get JSON Web Key Set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-rsa/json-web-key-set","routeSlug":"/api/login/product-configuration-rsa/json-web-key-set","metadata":{"seo":{"title":"Get JSON Web Key Set","description":"Gets a JSON object that represents a set of JWKs. The JSON object MUST have a keys member, which is an array of JWKs."}},"httpPath":"/projects/{project_id}/jwks.json"},{"label":"Get project keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-rsa/get-projects-keys","routeSlug":"/api/login/product-configuration-rsa/get-projects-keys","metadata":{"seo":{"title":"Get project keys","description":"Gets a list of the public RSA project keys."}},"httpPath":"/projects/{project_id}/keys"}]},{"type":"group","label":"Social","link":"/api/login/product-configuration-social","routeSlug":"/api/login/product-configuration-social","items":[{"label":"Change settings for connected social provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-social/put-social-provider-token","routeSlug":"/api/login/product-configuration-social/put-social-provider-token","metadata":{"seo":{"title":"Change settings for connected social provider","description":"Configure social provider token in Login JWT."}},"httpPath":"/projects/{project_id}/social/provider_token"},{"label":"Change scope settings for connected social provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-social/put-social-provider-custom-scope","routeSlug":"/api/login/product-configuration-social/put-social-provider-custom-scope","metadata":{"seo":{"title":"Change scope settings for connected social provider","description":"Manage custom Oauth2 scopes for provider."}},"httpPath":"/projects/{project_id}/social/{provider_name}/custom_scope"}]},{"type":"group","label":"User groups","link":"/api/login/product-configuration-groups","routeSlug":"/api/login/product-configuration-groups","items":[{"label":"Get project groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-groups/get-project-user-groups","routeSlug":"/api/login/product-configuration-groups/get-project-user-groups","metadata":{"seo":{"title":"Get project groups","description":"Gets a list of user groups in project."}},"httpPath":"/projects/{project_id}/user_groups"},{"label":"Add new group to project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-groups/post-project-user-group","routeSlug":"/api/login/product-configuration-groups/post-project-user-group","metadata":{"seo":{"title":"Add new group to project","description":"Adds a new user group to a project."}},"httpPath":"/projects/{project_id}/user_groups"},{"label":"Delete group from project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-groups/del-project-user-group","routeSlug":"/api/login/product-configuration-groups/del-project-user-group","metadata":{"seo":{"title":"Delete group from project","description":"Deletes a user group."}},"httpPath":"/projects/{project_id}/user_groups/{group_id}"},{"label":"Update group name","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-groups/put-project-user-group","routeSlug":"/api/login/product-configuration-groups/put-project-user-group","metadata":{"seo":{"title":"Update group name","description":"Changes a user group name."}},"httpPath":"/projects/{project_id}/user_groups/{group_id}"}]},{"type":"group","label":"Multi-factor authentication","link":"/api/login/product-configuration-mfa","routeSlug":"/api/login/product-configuration-mfa","items":[{"label":"Get project two-factor authentication settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-mfa/get-project-two-factor-authentication-settings","routeSlug":"/api/login/product-configuration-mfa/get-project-two-factor-authentication-settings","metadata":{"seo":{"title":"Get project two-factor authentication settings","description":"Gets project two-factor authentication settings."}},"httpPath":"/projects/{project_id}/mfa"},{"label":"Update project two-factor authentication settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-mfa/update-project-two-factor-authentication-settings","routeSlug":"/api/login/product-configuration-mfa/update-project-two-factor-authentication-settings","metadata":{"seo":{"title":"Update project two-factor authentication settings","description":"Updates project two-factor authentication settings. The user must confirm the changes by entering a one-time code."}},"httpPath":"/projects/{project_id}/mfa"},{"label":"Get user's two-factor authentication settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-mfa/get-server-mfa","routeSlug":"/api/login/product-configuration-mfa/get-server-mfa","metadata":{"seo":{"title":"Get user's two-factor authentication settings","description":"Gets user's two-factor authentication settings."}},"httpPath":"/projects/{project_id}/users/{user_id}/mfa"},{"label":"Update user's two-factor authentication settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-mfa/update-server-mfa","routeSlug":"/api/login/product-configuration-mfa/update-server-mfa","metadata":{"seo":{"title":"Update user's two-factor authentication settings","description":"Updates user's two-factor authentication settings from server."}},"httpPath":"/projects/{project_id}/users/{user_id}/mfa"},{"label":"Get user’s two-factor authentication settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-mfa/get-users-two-factor-authentication-settings","routeSlug":"/api/login/product-configuration-mfa/get-users-two-factor-authentication-settings","metadata":{"seo":{"title":"Get user’s two-factor authentication settings","description":"Gets user’s two-factor authentication settings. You must enable two-factor authentication for the Login project. Contact your Customer Success Manager to enable it."}},"httpPath":"/users/me/mfa"},{"label":"Update user’s two-factor authentication settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/product-configuration-mfa/update-users-two-factor-authentication-settings","routeSlug":"/api/login/product-configuration-mfa/update-users-two-factor-authentication-settings","metadata":{"seo":{"title":"Update user’s two-factor authentication settings","description":"Updates user’s two-factor authentication settings. The user must confirm the changes by entering a one-time code."}},"httpPath":"/users/me/mfa"}]},{"type":"group","label":"Webhooks","link":"/api/login/webhooks","routeSlug":"/api/login/webhooks","items":[{"label":"Get webhooks for event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/webhooks/get-webhooks-for-event","routeSlug":"/api/login/webhooks/get-webhooks-for-event","metadata":{"seo":{"title":"Get webhooks for event","description":"Gets the list of webhooks information for the specified type of events."}},"httpPath":"/projects/{project_id}/events/{event_type}/webhooks"},{"label":"Add webhook for event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/webhooks/add-webhook-for-event","routeSlug":"/api/login/webhooks/add-webhook-for-event","metadata":{"seo":{"title":"Add webhook for event","description":"Creates a webhook for the specified event. The webhook has the following format:"}},"httpPath":"/projects/{project_id}/events/{event_type}/webhooks"},{"label":"Delete webhook for event","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/webhooks/delete-webhook-for-event","routeSlug":"/api/login/webhooks/delete-webhook-for-event","metadata":{"seo":{"title":"Delete webhook for event","description":"Deletes a webhook with the specified ID."}},"httpPath":"/projects/{project_id}/events/{event_type}/webhooks/{webhook_id}"}]},{"type":"separator","label":"User management"},{"type":"group","label":"User profile","link":"/api/login/user-profile","routeSlug":"/api/login/user-profile","items":[{"label":"[OAuth2.0] Resend account confirmation email\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/oauth-20-resend-account-confirmation-email","routeSlug":"/api/login/user-profile/oauth-20-resend-account-confirmation-email","metadata":{"seo":{"title":"[OAuth2.0] Resend account confirmation email\n","description":"Resends an account confirmation email to a user. To complete account confirmation, the user should follow the link in the email."}},"httpPath":"/oauth2/user/resend_confirmation_link"},{"label":"Unban user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/del-projects-users-ban","routeSlug":"/api/login/user-profile/del-projects-users-ban","metadata":{"seo":{"title":"Unban user","description":"Removes the ban from the user."}},"httpPath":"/projects/{project_id}/users/{user_id}/ban"},{"label":"Ban user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/post-projects-users-ban","routeSlug":"/api/login/user-profile/post-projects-users-ban","metadata":{"seo":{"title":"Ban user","description":"Add a ban to the user, either for a specific period or permanently."}},"httpPath":"/projects/{project_id}/users/{user_id}/ban"},{"label":"Update server custom ID for user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/put-user-custom-id","routeSlug":"/api/login/user-profile/put-user-custom-id","metadata":{"seo":{"title":"Update server custom ID for user","description":"Updates server custom ID for a user."}},"httpPath":"/projects/{project_id}/users/{user_id}/server_custom_id"},{"label":"[JWT] Resend account confirmation email\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/jwt-resend-account-confirmation-email","routeSlug":"/api/login/user-profile/jwt-resend-account-confirmation-email","metadata":{"seo":{"title":"[JWT] Resend account confirmation email\n","description":"Resends an account confirmation email to a user. To complete account confirmation, the user should follow the link in the email."}},"httpPath":"/user/resend_confirmation_link"},{"label":"Check user age","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/check-users-age","routeSlug":"/api/login/user-profile/check-users-age","metadata":{"seo":{"title":"Check user age","description":"Checks user’s age for a particular region. The age requirements depend on the region. Service determines the user’s location by the IP address."}},"httpPath":"/users/age/check"},{"label":"Get user details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/get-user-details","routeSlug":"/api/login/user-profile/get-user-details","metadata":{"seo":{"title":"Get user details","description":"Gets details of the user authenticated by the JWT."}},"httpPath":"/users/me"},{"label":"Update user details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/update-user-details","routeSlug":"/api/login/user-profile/update-user-details","metadata":{"seo":{"title":"Update user details","description":"Updates the details of the authenticated user by JWT."}},"httpPath":"/users/me"},{"label":"Get user devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/get-users-devices","routeSlug":"/api/login/user-profile/get-users-devices","metadata":{"seo":{"title":"Get user devices","description":"Gets a list of user’s devices."}},"httpPath":"/users/me/devices"},{"label":"Link device to account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/link-device-to-account","routeSlug":"/api/login/user-profile/link-device-to-account","metadata":{"seo":{"title":"Link device to account","description":"Links the specified device to the user account. To enable authentication via device ID and linking, use the instruction."}},"httpPath":"/users/me/devices/{device_type}"},{"label":"Unlink device from account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/unlink-device-from-account","routeSlug":"/api/login/user-profile/unlink-device-from-account","metadata":{"seo":{"title":"Unlink device from account","description":"Unlinks the specified device from the user account. To enable authentication via device ID and unlinking, contact your Customer Success Manager."}},"httpPath":"/users/me/devices/{id}"},{"label":"Get user email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/get-user-email","routeSlug":"/api/login/user-profile/get-user-email","metadata":{"seo":{"title":"Get user email","description":"Gets the email of the authenticated user by JWT."}},"httpPath":"/users/me/email"},{"label":"Add username/email auth to account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/add-username-email-auth-to-account","routeSlug":"/api/login/user-profile/add-username-email-auth-to-account","metadata":{"seo":{"title":"Add username/email auth to account","description":"Adds the username/email and password authentication to the existing user account. This call is used if the account is created via device ID or phone number."}},"httpPath":"/users/me/link_email_password"},{"label":"Get links for social auth","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/get-links-for-social-auth","routeSlug":"/api/login/user-profile/get-links-for-social-auth","metadata":{"seo":{"title":"Get links for social auth","description":"Gets links for authentication via the social networks enabled in your Login project > General settings > Social Networks section of Publisher Account. The links are valid for 10 minutes."}},"httpPath":"/users/me/login_urls"},{"label":"Get user phone number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/get-user-phone-number","routeSlug":"/api/login/user-profile/get-user-phone-number","metadata":{"seo":{"title":"Get user phone number","description":"Gets the phone number of the authenticated user by JWT."}},"httpPath":"/users/me/phone"},{"label":"Update user phone number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/update-user-phone-number","routeSlug":"/api/login/user-profile/update-user-phone-number","metadata":{"seo":{"title":"Update user phone number","description":"Updates the phone number of the authenticated user by JWT."}},"httpPath":"/users/me/phone"},{"label":"Delete user phone number","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/delete-user-phone-number","routeSlug":"/api/login/user-profile/delete-user-phone-number","metadata":{"seo":{"title":"Delete user phone number","description":"Deletes the phone number of the authenticated user by JWT."}},"httpPath":"/users/me/phone/{phoneNumber}"},{"label":"Confirmation of request to link phone number to user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/confirm-phone-number","routeSlug":"/api/login/user-profile/confirm-phone-number","metadata":{"seo":{"title":"Confirmation of request to link phone number to user","description":"NoticeRate limits for client-side methods are applied to this method."}},"httpPath":"/users/me/phone_link/confirm"},{"label":"Request to link phone number to user as new method of authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/link-phone-number","routeSlug":"/api/login/user-profile/link-phone-number","metadata":{"seo":{"title":"Request to link phone number to user as new method of authorization","description":"NoticeRate limits for client-side methods are applied to this method."}},"httpPath":"/users/me/phone_link/request"},{"label":"Delete user picture","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/delete-user-picture","routeSlug":"/api/login/user-profile/delete-user-picture","metadata":{"seo":{"title":"Delete user picture","description":"Deletes the profile picture of the authenticated user by JWT."}},"httpPath":"/users/me/picture"},{"label":"Upload user picture","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-profile/upload-user-picture","routeSlug":"/api/login/user-profile/upload-user-picture","metadata":{"seo":{"title":"Upload user picture","description":"Uploads the profile picture of the authenticated user by JWT."}},"httpPath":"/users/me/picture"}]},{"type":"group","label":"Account linking","link":"/api/login/account-linking","routeSlug":"/api/login/account-linking","items":[{"label":"Create code for linking accounts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/account-linking/create-code-for-linking-accounts","routeSlug":"/api/login/account-linking/create-code-for-linking-accounts","metadata":{"seo":{"title":"Create code for linking accounts","description":"Creates the code for linking the platform account to the existing main account when the user logs in to the game via a gaming console."}},"httpPath":"/users/account/code"},{"label":"Link accounts by code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/account-linking/link-accounts-by-code","routeSlug":"/api/login/account-linking/link-accounts-by-code","metadata":{"seo":{"title":"Link accounts by code","description":"Links the platform account to the existing main account by the code."}},"httpPath":"/users/account/link"},{"label":"Link user IDs via external ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/account-linking/link-user-ids-via-external-id","routeSlug":"/api/login/account-linking/link-user-ids-via-external-id","metadata":{"seo":{"title":"Link user IDs via external ID","description":"Links a user from your game to a user from your Login project via an external ID. You will not be able to link the same external ID to different users and update the external ID of a user if they already have it."}},"httpPath":"/users/account/link_external_id"}]},{"type":"group","label":"Password reset","link":"/api/login/password-reset","routeSlug":"/api/login/password-reset","items":[{"label":"Confirm password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/password-reset/confirm-password-reset","routeSlug":"/api/login/password-reset/confirm-password-reset","metadata":{"seo":{"title":"Confirm password reset","description":"Confirms the user password reset."}},"httpPath":"/password/reset/confirm"},{"label":"Reset password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/password-reset/reset-password","routeSlug":"/api/login/password-reset/reset-password","metadata":{"seo":{"title":"Reset password","description":"Resets the user password with user confirmation. If the user data is kept in the Xsolla data storage or on your side, users receive a password change confirmation email. If the user data is kept in the PlayFab storage, password reset is done on PlayFab’s side. To get more information, see the Comparison of user data storages page."}},"httpPath":"/password/reset/request"}]},{"type":"group","label":"User search","link":"/api/login/search","routeSlug":"/api/login/search","items":[{"label":"Get user by ID for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/search/get-user-for-project","routeSlug":"/api/login/search/get-user-for-project","metadata":{"seo":{"title":"Get user by ID for project","description":"Gets user data by user ID."}},"httpPath":"/projects/{project_id}/users"},{"label":"Search users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/search/search-users-by-filter","routeSlug":"/api/login/search/search-users-by-filter","metadata":{"seo":{"title":"Search users","description":"Searches users by criteria. Returns results with pagination and ordering."}},"httpPath":"/projects/{project_id}/users/search"},{"label":"Get user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/search/get-user","routeSlug":"/api/login/search/get-user","metadata":{"seo":{"title":"Get user by ID","description":"Gets user data by user ID."}},"httpPath":"/projects/{project_id}/users/search/by_id/{user_id}"},{"label":"Get social profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/search/get-all-users-social-profiles","routeSlug":"/api/login/search/get-all-users-social-profiles","metadata":{"seo":{"title":"Get social profiles","description":"Gets all user's social profiles."}},"httpPath":"/projects/{project_id}/users/{user_id}/social_profile"},{"label":"Get user IDs by social ID and platform","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/search/get-users-ids-by-social-id-and-platform","routeSlug":"/api/login/search/get-users-ids-by-social-id-and-platform","metadata":{"seo":{"title":"Get user IDs by social ID and platform","description":"The call will return:"}},"httpPath":"/users/linking_info"},{"label":"Search users by nickname","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/search/search-users-by-nickname","routeSlug":"/api/login/search/search-users-by-nickname","metadata":{"seo":{"title":"Search users by nickname","description":"Searches users by the nickname parameter and gets a list of them. Search can be performed instantly when the user starts entering the search parameter."}},"httpPath":"/users/search/by_nickname"}]},{"type":"group","label":"Social networks","link":"/api/login/social-networks","routeSlug":"/api/login/social-networks","items":[{"label":"Get linked networks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-networks/get-linked-networks","routeSlug":"/api/login/social-networks/get-linked-networks","metadata":{"seo":{"title":"Get linked networks","description":"Gets a list of the social networks linked to the user account."}},"httpPath":"/users/me/social_providers"},{"label":"Delete linked network\n","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-networks/delete-linked-networks","routeSlug":"/api/login/social-networks/delete-linked-networks","metadata":{"seo":{"title":"Delete linked network\n","description":"Deletes social network linked to the user account."}},"httpPath":"/users/me/social_providers/{providerName}"},{"label":"Link social network to account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-networks/link-social-network-to-account","routeSlug":"/api/login/social-networks/link-social-network-to-account","metadata":{"seo":{"title":"Link social network to account","description":"Links the social network, which is used by the player for authentication, to the user account."}},"httpPath":"/users/me/social_providers/{providerName}/login_redirect"},{"label":"Get URL to link social network to account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-networks/get-url-to-link-social-network-to-account","routeSlug":"/api/login/social-networks/get-url-to-link-social-network-to-account","metadata":{"seo":{"title":"Get URL to link social network to account","description":"Gets the URL to link the social network to the user’s account. The social network should be used for authentication."}},"httpPath":"/users/me/social_providers/{providerName}/login_url"}]},{"type":"group","label":"User friends","link":"/api/login/user-friends","routeSlug":"/api/login/user-friends","items":[{"label":"Get user friends","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-friends/get-users-friends","routeSlug":"/api/login/user-friends/get-users-friends","metadata":{"seo":{"title":"Get user friends","description":"Gets a list of users added as friends of the authenticated user."}},"httpPath":"/users/me/relationships"},{"label":"Update user friends","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-friends/update-users-friends","routeSlug":"/api/login/user-friends/update-users-friends","metadata":{"seo":{"title":"Update user friends","description":"Updates the friend list of the authenticated user."}},"httpPath":"/users/me/relationships"},{"label":"Get social account friends","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-friends/get-social-account-friends","routeSlug":"/api/login/user-friends/get-social-account-friends","metadata":{"seo":{"title":"Get social account friends","description":"Gets a list of user’s friends from a social provider."}},"httpPath":"/users/me/social_friends"},{"label":"Update social account friends","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-friends/update-social-account-friends","routeSlug":"/api/login/user-friends/update-social-account-friends","metadata":{"seo":{"title":"Update social account friends","description":"Begins data processing to update a list of user’s friends from a social provider. Note that there may be a delay in data processing because of the Xsolla Login server or provider server high loads."}},"httpPath":"/users/me/social_friends/update"},{"label":"Get user public profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-friends/get-user-public-profile","routeSlug":"/api/login/user-friends/get-user-public-profile","metadata":{"seo":{"title":"Get user public profile","description":"Gets the user information from their public profile by the user ID."}},"httpPath":"/users/{user_id}/public"}]},{"type":"group","label":"User groups","link":"/api/login/user-management-groups","routeSlug":"/api/login/user-management-groups","items":[{"label":"Delete user groups","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-management-groups/delete-user-groups","routeSlug":"/api/login/user-management-groups/delete-user-groups","metadata":{"seo":{"title":"Delete user groups","description":"Deletes user groups."}},"httpPath":"/projects/{project_id}/users/{user_id}/user_groups"},{"label":"Get user groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-management-groups/get-user-groups","routeSlug":"/api/login/user-management-groups/get-user-groups","metadata":{"seo":{"title":"Get user groups","description":"Gets all user's groups."}},"httpPath":"/projects/{project_id}/users/{user_id}/user_groups"},{"label":"Update user groups","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-management-groups/update-user-groups","routeSlug":"/api/login/user-management-groups/update-user-groups","metadata":{"seo":{"title":"Update user groups","description":"Updates user's groups."}},"httpPath":"/projects/{project_id}/users/{user_id}/user_groups"},{"label":"Manage groups for user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/user-management-groups/manage-user-groups","routeSlug":"/api/login/user-management-groups/manage-user-groups","metadata":{"seo":{"title":"Manage groups for user","description":"Manages groups for a user. A default group cannot be passed to this method."}},"httpPath":"/projects/{project_id}/users/{user_id}/user_groups"}]},{"type":"group","label":"Export/Import","link":"/api/login/bulk-user-management","routeSlug":"/api/login/bulk-user-management","items":[{"label":"Export user data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/bulk-user-management/export-users","routeSlug":"/api/login/bulk-user-management/export-users","metadata":{"seo":{"title":"Export user data","description":"Exports user data (personal information and attributes) from the Login project to an archive of CSV files. You will receive the archive of user data to the specified email address."}},"httpPath":"/projects/{project_id}/export_users"},{"label":"Import user data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/bulk-user-management/upload-import-file","routeSlug":"/api/login/bulk-user-management/upload-import-file","metadata":{"seo":{"title":"Import user data","description":"Imports user data from a CSV format file to the Login project."}},"httpPath":"/projects/{project_id}/user_import"}]},{"type":"separator","label":"Authentication methods"},{"type":"group","label":"Via server custom ID","link":"/api/login/server-custom-id","routeSlug":"/api/login/server-custom-id","items":[{"label":"[JWT] Auth by custom ID\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/server-custom-id/auth-by-custom-id","routeSlug":"/api/login/server-custom-id/auth-by-custom-id","metadata":{"seo":{"title":"[JWT] Auth by custom ID\n","description":"Authenticates a user by a particular custom ID. If the user does not exist, they are created."}},"httpPath":"/users/login/server_custom_id"}]},{"type":"group","label":"User and server token management","link":"/api/login/token-management","routeSlug":"/api/login/token-management","items":[{"label":"[OAuth2.0] Generate JWT\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/token-management/generate-jwt","routeSlug":"/api/login/token-management/generate-jwt","metadata":{"seo":{"title":"[OAuth2.0] Generate JWT\n","description":"Use this call:"}},"httpPath":"/oauth2/token"},{"label":"[OAuth2.0] Revoke Token\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/token-management/revoke-jwt","routeSlug":"/api/login/token-management/revoke-jwt","metadata":{"seo":{"title":"[OAuth2.0] Revoke Token\n","description":"Revokes an obtained access token"}},"httpPath":"/oauth2/token/revoke"},{"label":"Validate Server JWT","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/token-management/validate-server-jwt","routeSlug":"/api/login/token-management/validate-server-jwt","metadata":{"seo":{"title":"Validate Server JWT","description":"Validates a server JWT. Checks the following criteria:"}},"httpPath":"/server/token/validate"},{"label":"Validate user JWT","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/token-management/validate-jwt","routeSlug":"/api/login/token-management/validate-jwt","metadata":{"seo":{"title":"Validate user JWT","description":"Validates a user JWT based on the following criteria:"}},"httpPath":"/token/validate"}]},{"type":"group","label":"Via device ID","link":"/api/login/device-id","routeSlug":"/api/login/device-id","items":[{"label":"[JWT] Auth via device ID\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/device-id/jwt-auth-via-device-id","routeSlug":"/api/login/device-id/jwt-auth-via-device-id","metadata":{"seo":{"title":"[JWT] Auth via device ID\n","description":"Authenticates a user via a particular device ID. To enable silent authentication, use the instruction."}},"httpPath":"/login/device/{device_type}"},{"label":"[OAuth2.0] Auth via device ID\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/device-id/oauth-20-auth-via-device-id","routeSlug":"/api/login/device-id/oauth-20-auth-via-device-id","metadata":{"seo":{"title":"[OAuth2.0] Auth via device ID\n","description":"Authenticates a user via a particular device ID."}},"httpPath":"/oauth2/login/device/{device_type}"}]},{"type":"group","label":"Via social networks","link":"/api/login/social-login","routeSlug":"/api/login/social-login","items":[{"label":"[OAuth 2.0] Auth via social network\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-login/oauth-20-auth-via-social-network","routeSlug":"/api/login/social-login/oauth-20-auth-via-social-network","metadata":{"seo":{"title":"[OAuth 2.0] Auth via social network\n","description":"Redirects the user to the page for authentication via the specified social network."}},"httpPath":"/oauth2/social/{provider_name}/login_redirect"},{"label":"[OAuth 2.0] Get link for social auth\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-login/oauth-20-get-link-for-social-auth","routeSlug":"/api/login/social-login/oauth-20-get-link-for-social-auth","metadata":{"seo":{"title":"[OAuth 2.0] Get link for social auth\n","description":"Gets the link for authentication via the social network. The link is valid for 10 minutes."}},"httpPath":"/oauth2/social/{provider_name}/login_url"},{"label":"[OAuth 2.0] Auth via access token of social network\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-login/oauth-20-auth-via-access-token-of-social-network","routeSlug":"/api/login/social-login/oauth-20-auth-via-access-token-of-social-network","metadata":{"seo":{"title":"[OAuth 2.0] Auth via access token of social network\n","description":"Authenticates the user with the access token using social network credentials."}},"httpPath":"/oauth2/social/{provider_name}/login_with_token"},{"label":"[JWT] Auth via social network\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-login/jwt-auth-via-social-network","routeSlug":"/api/login/social-login/jwt-auth-via-social-network","metadata":{"seo":{"title":"[JWT] Auth via social network\n","description":"Redirects the user to the page for authentication via the specified social network."}},"httpPath":"/social/{provider_name}/login_redirect"},{"label":"[JWT] Get link for social auth\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-login/jwt-get-link-for-social-auth","routeSlug":"/api/login/social-login/jwt-get-link-for-social-auth","metadata":{"seo":{"title":"[JWT] Get link for social auth\n","description":"Gets the link for authentication via the social network. The link is valid for 10 minutes."}},"httpPath":"/social/{provider_name}/login_url"},{"label":"[JWT] Auth via access token of social network\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-login/jwt-auth-via-access-token-of-social-network","routeSlug":"/api/login/social-login/jwt-auth-via-access-token-of-social-network","metadata":{"seo":{"title":"[JWT] Auth via access token of social network\n","description":"Authenticates the user with the access token using social network credentials."}},"httpPath":"/social/{provider_name}/login_with_token"},{"label":"[JWT] Refresh social tokens in JWT\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/social-login/jwt-refresh-social-token","routeSlug":"/api/login/social-login/jwt-refresh-social-token","metadata":{"seo":{"title":"[JWT] Refresh social tokens in JWT\n","description":"Refreshes social token by social refresh token from JWT."}},"httpPath":"/social/{provider_name}/refresh_token"}]},{"type":"group","label":"Cross-platform","link":"/api/login/cross-platform","routeSlug":"/api/login/cross-platform","items":[{"label":"[OAuth 2.0] Silent authentication\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/cross-platform/oauth-20-silent-authentication","routeSlug":"/api/login/cross-platform/oauth-20-silent-authentication","metadata":{"seo":{"title":"[OAuth 2.0] Silent authentication\n","description":"Exchanges a platform-specific authentication credential (a session ticket/exchange code/authorization token) from Epic Games, Steam, or Xbox for the JWT in your project (projectId)."}},"httpPath":"/oauth2/social/{oauth2_cross_social_provider_name}/cross_auth"},{"label":"[JWT] Silent authentication\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/cross-platform/jwt-silent-authentication","routeSlug":"/api/login/cross-platform/jwt-silent-authentication","metadata":{"seo":{"title":"[JWT] Silent authentication\n","description":"Exchanges a platform-specific authentication credential (a session ticket/exchange code/authorization token) from Epic Games, Steam, or Xbox for the JWT in your project (projectId)."}},"httpPath":"/social/{cross_social_provider_name}/cross_auth"}]},{"type":"group","label":"Classic (with password)","link":"/api/login/login-and-password","routeSlug":"/api/login/login-and-password","items":[{"label":"[JWT] Auth by username and password\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/login-and-password/auth-by-username-and-password","routeSlug":"/api/login/login-and-password/auth-by-username-and-password","metadata":{"seo":{"title":"[JWT] Auth by username and password\n","description":"Authenticates the user by the username/email and password specified."}},"httpPath":"/login"},{"label":"[OAuth 2.0] Auth by username and password\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/login-and-password/oauth-20-auth-by-username-and-password","routeSlug":"/api/login/login-and-password/oauth-20-auth-by-username-and-password","metadata":{"seo":{"title":"[OAuth 2.0] Auth by username and password\n","description":"Authenticates the user by the username/email and password specified. To finish user authentication, get the user JWT by sending the Generate JWT request."}},"httpPath":"/oauth2/login"},{"label":"[OAuth 2.0] JWT auth by username and password\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/login-and-password/jwt-auth-by-username-and-password","routeSlug":"/api/login/login-and-password/jwt-auth-by-username-and-password","metadata":{"seo":{"title":"[OAuth 2.0] JWT auth by username and password\n","description":"Authenticates the user by the username/email and password and returns a JWT. Exchanging the code to a JWT via the Generate JWT call is not needed."}},"httpPath":"/oauth2/login/token"},{"label":"[OAuth2.0] Register new user\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/login-and-password/oauth-20-register-new-user","routeSlug":"/api/login/login-and-password/oauth-20-register-new-user","metadata":{"seo":{"title":"[OAuth2.0] Register new user\n","description":"Creates a new user."}},"httpPath":"/oauth2/user"},{"label":"[JWT] Register new user\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/login-and-password/jwt-register-new-user","routeSlug":"/api/login/login-and-password/jwt-register-new-user","metadata":{"seo":{"title":"[JWT] Register new user\n","description":"Creates a new user."}},"httpPath":"/user"}]},{"type":"group","label":"Passwordless","link":"/api/login/passwordless","routeSlug":"/api/login/passwordless","items":[{"label":"[JWT] Complete auth by email\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/jwt-complete-auth-by-email","routeSlug":"/api/login/passwordless/jwt-complete-auth-by-email","metadata":{"seo":{"title":"[JWT] Complete auth by email\n","description":"Completes authentication by the user email address and a confirmation code. The code lifetime is 3 minutes."}},"httpPath":"/login/email/confirm"},{"label":"[JWT] Start auth by email\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/jwt-start-auth-by-email","routeSlug":"/api/login/passwordless/jwt-start-auth-by-email","metadata":{"seo":{"title":"[JWT] Start auth by email\n","description":"Starts authentication by the user email address and sends a confirmation code to their email address. The code lifetime is 3 minutes."}},"httpPath":"/login/email/request"},{"label":"[JWT] Complete auth by phone number\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/jwt-complete-auth-by-phone-number","routeSlug":"/api/login/passwordless/jwt-complete-auth-by-phone-number","metadata":{"seo":{"title":"[JWT] Complete auth by phone number\n","description":"Completes authentication by the user phone number and a confirmation code. The code lifetime is 3 minutes."}},"httpPath":"/login/phone/confirm"},{"label":"[JWT] Start auth by phone number\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/jwt-start-auth-by-phone-number","routeSlug":"/api/login/passwordless/jwt-start-auth-by-phone-number","metadata":{"seo":{"title":"[JWT] Start auth by phone number\n","description":"Starts authentication by the user phone number and sends a confirmation code to their phone number. The code lifetime is 3 minutes."}},"httpPath":"/login/phone/request"},{"label":"[OAuth2.0] Complete auth by email\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/oauth-20-complete-auth-by-email","routeSlug":"/api/login/passwordless/oauth-20-complete-auth-by-email","metadata":{"seo":{"title":"[OAuth2.0] Complete auth by email\n","description":"Completes authentication by the user email address and a confirmation code. The code lifetime is 3 minutes."}},"httpPath":"/oauth2/login/email/confirm"},{"label":"[OAuth2.0] Start auth by email\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/oauth-20-start-auth-by-email","routeSlug":"/api/login/passwordless/oauth-20-start-auth-by-email","metadata":{"seo":{"title":"[OAuth2.0] Start auth by email\n","description":"Starts authentication by the user email address and sends a confirmation code to their email address. The code lifetime is 3 minutes."}},"httpPath":"/oauth2/login/email/request"},{"label":"[OAuth2.0] Complete auth by phone number\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/oauth-20-complete-auth-by-phone-number","routeSlug":"/api/login/passwordless/oauth-20-complete-auth-by-phone-number","metadata":{"seo":{"title":"[OAuth2.0] Complete auth by phone number\n","description":"Completes authentication by the user phone number and a confirmation code. The code lifetime is 3 minutes."}},"httpPath":"/oauth2/login/phone/confirm"},{"label":"[OAuth2.0] Start auth by phone number\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/oauth-20-start-auth-by-phone-number","routeSlug":"/api/login/passwordless/oauth-20-start-auth-by-phone-number","metadata":{"seo":{"title":"[OAuth2.0] Start auth by phone number\n","description":"Starts authentication by the user phone number and sends a confirmation code to their phone number. The code lifetime is 3 minutes."}},"httpPath":"/oauth2/login/phone/request"},{"label":"Get confirmation code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/get-confirmation-code","routeSlug":"/api/login/passwordless/get-confirmation-code","metadata":{"seo":{"title":"Get confirmation code","description":"Waits until the user follows the link provided via email or SMS and returns the confirmation code for authentication. If you sent this call and after 20 seconds you didn't get the code, there was an error. In this case, resend the call immediately. The code lifetime is 3 minutes."}},"httpPath":"/otc/code"},{"label":"Register new user from server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/passwordless/register-new-user-from-server","routeSlug":"/api/login/passwordless/register-new-user-from-server","metadata":{"seo":{"title":"Register new user from server","description":"Creates a new user with requested body parameters. These parameters are set as confirmed. Combination of parameters passed to the body must include at least email or phone_number parameter. The call is used only if you set up Xsolla storage."}},"httpPath":"/users"}]},{"type":"group","label":"SSO","link":"/api/login/sso","routeSlug":"/api/login/sso","items":[{"label":"OAuth 2.0 authorize","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/sso/oauth2-authorize","routeSlug":"/api/login/sso/oauth2-authorize","metadata":{"seo":{"title":"OAuth 2.0 authorize","description":"Checks the presence of a valid SSO session. Redirects to the URL passed in the redirect_url parameter with an authorization code."}},"httpPath":"/oauth2/auth"},{"label":"[OAuth 2.0] Clear SSO\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/sso/clear-sso-cookie","routeSlug":"/api/login/sso/clear-sso-cookie","metadata":{"seo":{"title":"[OAuth 2.0] Clear SSO\n","description":"Deletes user's SSO cookie for given project."}},"httpPath":"/oauth2/clear_sso"},{"label":"[OAuth 2.0] Log user out\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/sso/log-user-out","routeSlug":"/api/login/sso/log-user-out","metadata":{"seo":{"title":"[OAuth 2.0] Log user out\n","description":"Logs the user out and deletes the user session according to the value of the sessions parameter. Call the Check user authentication call to see if the user is logged in."}},"httpPath":"/oauth2/logout"},{"label":"[OAuth 2.0] Check user authentication\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/sso/check-user-authentication","routeSlug":"/api/login/sso/check-user-authentication","metadata":{"seo":{"title":"[OAuth 2.0] Check user authentication\n","description":"Checks if a user has already logged in via a service. If they have, you will receive an OAuth 2.0 authorization code without user participation. Used in Single Sign-on."}},"httpPath":"/oauth2/sso"}]},{"type":"group","label":"OAuth 2.0 consent management","link":"/api/login/consent-management","routeSlug":"/api/login/consent-management","items":[{"label":"[OAuth 2.0] Save consent for OAuth 2.0\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/consent-management/oauth2-save-consent","routeSlug":"/api/login/consent-management/oauth2-save-consent","metadata":{"seo":{"title":"[OAuth 2.0] Save consent for OAuth 2.0\n","description":"Saves the user's consent to the application of certain scopes for a specific OAuth 2.0 client."}},"httpPath":"/oauth2/consent"},{"label":"[OAuth 2.0]Check consent for OAuth 2.0\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/consent-management/oauth2-check-consent","routeSlug":"/api/login/consent-management/oauth2-check-consent","metadata":{"seo":{"title":"[OAuth 2.0]Check consent for OAuth 2.0\n","description":"Checks if the user gave consent to the application of the user data collection scope for a specific OAuth 2.0 client."}},"httpPath":"/oauth2/consent/validate"}]},{"type":"separator","label":"User attributes management"},{"type":"group","label":"Client-side","link":"/api/login/attributes-client","routeSlug":"/api/login/attributes-client","items":[{"label":"Get attributes by server custom IDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-client/get-attributes-by-server-custom-id","routeSlug":"/api/login/attributes-client/get-attributes-by-server-custom-id","metadata":{"seo":{"title":"Get attributes by server custom IDs","description":"Gets a list of particular user’s attributes."}},"httpPath":"/attributes/custom_id/get"},{"label":"Get user attributes from client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-client/get-users-attributes-from-client","routeSlug":"/api/login/attributes-client/get-users-attributes-from-client","metadata":{"seo":{"title":"Get user attributes from client","description":"Gets a list of particular user’s attributes. Returns only attributes with the client value of attr_type parameter."}},"httpPath":"/attributes/users/me/get"},{"label":"Get read-only user attributes from client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-client/get-users-read-only-attributes-from-client","routeSlug":"/api/login/attributes-client/get-users-read-only-attributes-from-client","metadata":{"seo":{"title":"Get read-only user attributes from client","description":"Gets a list of particular user’s read-only attributes. Returns only attributes with the server value of the attr_type parameter, which was set only for reading."}},"httpPath":"/attributes/users/me/get_read_only"},{"label":"Update user attributes from client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-client/update-users-attributes-from-client","routeSlug":"/api/login/attributes-client/update-users-attributes-from-client","metadata":{"seo":{"title":"Update user attributes from client","description":"Updates and creates particular user’s attributes."}},"httpPath":"/attributes/users/me/update"}]},{"type":"group","label":"Server-side","link":"/api/login/attributes-server","routeSlug":"/api/login/attributes-server","items":[{"label":"Get users by attribute from server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-server/get-users-by-attribute-from-server","routeSlug":"/api/login/attributes-server/get-users-by-attribute-from-server","metadata":{"seo":{"title":"Get users by attribute from server","description":"Gets a list of users by an attribute. Returns a list of the users’ IDs, their emails, and the attributes that were specified in the key object of the request."}},"httpPath":"/attributes/users/get"},{"label":"Get user attributes from server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-server/get-users-attributes-from-server","routeSlug":"/api/login/attributes-server/get-users-attributes-from-server","metadata":{"seo":{"title":"Get user attributes from server","description":"Gets user’s attributes."}},"httpPath":"/attributes/users/{user_id}/get"},{"label":"Get read-only user attributes from server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-server/get-users-read-only-attributes-from-server","routeSlug":"/api/login/attributes-server/get-users-read-only-attributes-from-server","metadata":{"seo":{"title":"Get read-only user attributes from server","description":"Gets a list of user’s read-only attributes."}},"httpPath":"/attributes/users/{user_id}/get_read_only"},{"label":"Update user attributes from server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-server/update-users-attributes-from-server","routeSlug":"/api/login/attributes-server/update-users-attributes-from-server","metadata":{"seo":{"title":"Update user attributes from server","description":"Updates and creates user’s attributes."}},"httpPath":"/attributes/users/{user_id}/update"},{"label":"Update user read-only attributes from server","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-server/update-users-read-only-attributes-from-server","routeSlug":"/api/login/attributes-server/update-users-read-only-attributes-from-server","metadata":{"seo":{"title":"Update user read-only attributes from server","description":"Updates and creates user’s read-only attributes."}},"httpPath":"/attributes/users/{user_id}/update_read_only"},{"label":"Update user attributes from server by server custom ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-server/update-users-attributes-from-server-by-server-custom-id","routeSlug":"/api/login/attributes-server/update-users-attributes-from-server-by-server-custom-id","metadata":{"seo":{"title":"Update user attributes from server by server custom ID","description":"Updates and creates user attributes by user ID on your server (server_custom_id)."}},"httpPath":"/projects/{project_id}/server_custom_id/{server_custom_id}/attributes"},{"label":"Get attributes by user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-server/get-attributes-by-user-id","routeSlug":"/api/login/attributes-server/get-attributes-by-user-id","metadata":{"seo":{"title":"Get attributes by user ID","description":"Gets a list of user’s attributes. Returns only attributes values for user by his ID."}},"httpPath":"/projects/{project_id}/users/{user_id}/attributes"}]},{"type":"group","label":"Validation schema","link":"/api/login/attributes-schema","routeSlug":"/api/login/attributes-schema","items":[{"label":"Delete schema","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-schema/delete-attributes-schema","routeSlug":"/api/login/attributes-schema/delete-attributes-schema","metadata":{"seo":{"title":"Delete schema","description":"Deletes JSON Schema of user attributes from the Login project."}},"httpPath":"/project/{project_id}/attribute_schema"},{"label":"Get schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-schema/get-attributes-schema","routeSlug":"/api/login/attributes-schema/get-attributes-schema","metadata":{"seo":{"title":"Get schema","description":"Gets JSON Schema of user attributes."}},"httpPath":"/project/{project_id}/attribute_schema"},{"label":"Update schema","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/login/attributes-schema/put-attributes-schema","routeSlug":"/api/login/attributes-schema/put-attributes-schema","metadata":{"seo":{"title":"Update schema","description":"Updates JSON Schema of user attributes."}},"httpPath":"/project/{project_id}/attribute_schema"}]}]}