Login / Cómo utilizar las llamadas API del SDK del widget de Login
  Volver a Documentos

Login

Cómo utilizar las llamadas API del SDK del widget de Login

Puede trabajar con las llamadas API del SDK del widget de Login por separado del widget de Login si desea:

  • utilizar su propio diseño de widget
  • implementar parcialmente el flujo del widget de Login

Nota
No todas las llamadas API admiten este escenario.

Inicialización del código

Para utilizar las llamadas API del SDK del widget de Login sin un widget, conecte el siguiente código a la etiqueta <body>:

Copy
Full screen
Small screen
    <script>
    const api = new XsollaLogin.Api({
      projectId: 'someProjectId'
    });
    </script>
    

    El código de inicialización cuando se utiliza un paquete npm (npm-package):

    Copy
    Full screen
    Small screen
      import XsollaLogin from '@xsolla/login-sdk';
      const api = new XsollaLogin.Api({
        projectId: 'someProjectId'
      });
      

      Los siguientes parámetros se transmiten en el código de inicialización:

      ParámetroTipoDescripción
      projectId
      stringID de su proyecto de Login de Cuenta del editor. Obligatorio.
      fullLocale
      stringEl idioma de la interfaz y una región en el formato <language code>_<country code>, por el cual:Solo se admiten los siguientes idiomas: Árabe (ar_AE), búlgaro (bg_BG), checo (cz_CZ), inglés (en_XX), alemán (de_DE), español (es_ES), francés (fr_FR), hebreo (he_IL), italiano (it_IT), japonés (ja_JP), coreano (ko_KR), polaco (pl_PL), portugués (pt_BR), rumano (ro_RO), ruso (ru_RU), tailandés (th_TH), turco (tr_TR), vietnamita (vi_VN), chino simplificado (zh_CN) y chino tradicional (zh_TW).
      El parámetro afecta a la clasificación de las redes sociales según la frecuencia de uso en la región especificada y también afecta al idioma utilizado para los correos electrónicos enviados a los usuarios.
      callbackUrl
      stringLa URL con la que trabaja el servidor de Xsolla Login si el inicio de sesión o el registro se realiza correctamente.
      emailTemplate
      stringEl nombre del proyecto en nombre del cual se envían los correos electrónicos a los usuarios.
      payload (carga útil)
      stringDatos adicionales que se pueden transmitir en un código. Estos datos se añaden al JWT del usuario después de iniciar sesión correctamente.
      with_logout
      booleanSi se revocan los tókenes anteriores durante un nuevo inicio de sesión. false por defecto.
      clientId
      stringID de la aplicación cliente. Se transmite si se utiliza la autenticación basada en el protocolo OAuth 2.0 en la aplicación.
      scope (alcance)
      stringInformación adicional sobre una cuenta de usuario solicitada por la aplicación. Se transmite si se usa la autenticación basada en el protocolo OAuth 2.0 en la aplicación. Valores posibles:
      • email - una solicitud adicional de la dirección de correo electrónico del usuario durante el inicio de sesión mediante red social.
      • offline - una actualización automática del JWT después de que expire.
      • playfab - el parámetro SessionTicket se transmite automáticamente a un JWT si los datos del usuario se almacenan en PlayFab.
      También puede especificar sus propios parámetros. El servidor de Xsolla Login no los procesa sino que los devuelve a un JWT.
      estado
      stringUna verificación de usuario adicional para evitar, por ejemplo, ataques de CSRF. Debe tener más de 8 caracteres.
      redirectUrl
      stringLa URL a la que se redirige al usuario después de que confirme su cuenta, inicie sesión o confirme el restablecimiento de la contraseña.
      booleanSi desea desactivar o no la confirmación de la autenticación sin contraseña mediante un enlace insertado en el correo electrónico cuando los usuarios inician sesión sin contraseña por correo electrónico o teléfono. false por defecto.
      is_oauth2
      booleanSi se va a utilizar la autenticación basada en el protocolo OAuth 2.0 para los usuarios. false por defecto.

      Llamadas API

      Puede utilizar las siguientes llamadas API del SDK del widget de Login sin un widget de Login:

      Registro de usuario mediante contraseña

      LlamadaDescripciónParámetros
      api.signup(userInfo);Registra un nuevo usuario. Los datos sobre el usuario se transmiten en el objeto userInfo durante el registro. El token del usuario registrado se transmite en la respuesta.
      • email (string) - Dirección de correo electrónico del usuario. Obligatorio.
      • username (string) - Nombre de usuario. Obligatorio.
      • password (string) - Contraseña del usuario. Obligatorio.
      • nickname (string) - Alias del usuario.
      Ejemplo:
      Copy
      Full screen
      Small screen
        let result
        // Request
        api.signup({
          userInfo: {
            email: 'email@address.com',
            fields: {
              nickname: 'Johny'
            },
            password: 'password123',
            username: 'John'
          }
        }).then((res) => {
          result = res;
        })
        
        // Response
        result === {
          login_url: 'https://someurl.com?token=XXXXXXX'
        }
        

        Iniciar sesión con contraseña

        LlamadaDescripciónParámetros
        api.login(credentials);Autentica a un usuario con una contraseña. Los datos sobre el usuario necesarios para el inicio de sesión se transmiten en el objeto credentials. El token del usuario autenticado se transmite en la respuesta.
        • username (string) - Nombre de usuario, por ejemplo - John, o una dirección de correo electrónico, por ejemplo - email@address.com. Obligatorio.
        • password (string) - Contraseña del usuario. Obligatoria.
        Ejemplo:
        Copy
        Full screen
        Small screen
          let result
          // Request
          api.login({
            credentials: {
              password: 'password123',
              username: 'email@address.com'
            }
          }).then((res) => {
            result = res;
          })
          
          // Response
          result === {
            login_url: 'https://someurl.com?token=XXXXXXX'
          }
          
          // Response with additional fields
          result === {
            ask_fields: [{
              confirmation_type: 'code' || 'link'
              name: 'phone_number'
              required: false
              step: 0 // Displays the position of the field in the data retrieval queue.
              type: 'phone'
              validation: {} // Custom validation
            }]
            login_url: 'https://someurl.com?token=XXXXXXX',
            token: 'sometoken'
          }
          

          Confirmación de cuenta

          LlamadaDescripciónParámetros
          api.resendEmail(nombre de usuario);Envía un correo electrónico adicional de confirmación de cuenta. Para confirmar la cuenta, el usuario debe hacer clic en el enlace del correo electrónico. La dirección de correo electrónico del usuario se transmite en el objeto username. En la respuesta se devuelve el código estándar 204.
          • username (string) - Dirección de correo electrónico del usuario, por ejemplo: email@address.com. Obligatorio.
          Ejemplo:
          Copy
          Full screen
          Small screen
            let result
            // Request
            api.resendEmail({
              username: 'email@address.com'
            }).then((res) => {
              res.code === 204;
            })
            

            Autenticación sin contraseña

            Flujo del usuario:
            1. El usuario introduce su número de teléfono o su dirección de correo electrónico. En función de las credenciales que haya introducido, se llama a api.phoneGetCode o api.emailGetCode.
            2. El servidor recibe los datos y envía un correo electrónico o un SMS con el código al usuario. Si al inicializar el código se transmite el parámetro disableConfirmByLink=true, que desactiva la confirmación del inicio de sesión mediante el enlace del correo electrónico, se utiliza la llamada a api.getConfirmCode para el redireccionamiento automático del usuario tras hacer clic en el enlace.
            3. La llamada a api.phoneGetCode o api.emailGetCode devuelve el parámetro operation_id utilizado para confirmar el número de teléfono o la dirección de correo electrónico mediante la llamada a api.loginWithPhoneCode o api.loginWithEmailCode.
            4. Una vez confirmada correctamente la dirección de correo electrónico o el número de teléfono, se devuelve la URL con el parámetro token. Se utiliza en las solicitudes de datos adicionales sobre el usuario.
            LlamadaDescripciónParámetros
            api.phoneGetCode({ phone_number, link_url, isOauth2 });Envía un código de confirmación al número de teléfono. El parámetro operation_id utilizado para confirmar el número de teléfono se devuelve en la respuesta.
            • phone_number (string) - Número de teléfono para la autenticación sin contraseña.
            • link_url (string) - URL de confirmación.
            • isOauth2 (boolean) - Si se utiliza o no la autenticación basada en el protocolo OAuth 2.0 para los usuarios. Obligatorio.
            Ejemplo
            Copy
            Full screen
            Small screen
              let result
              // Request
              api.phoneGetCode({
                phone_number: '+somenumber',
                link_url: 'https://someurl.com',
                isOauth2: true
              }).then((res) => {
                result = res;
              })
              
              // Response
              result === {
                operation_id: '2334j255fdf13d515fgd1'
              }
              
              LlamadaDescripciónParámetros
              api.phoneGetCode({ phone_number, link_url, isOauth2 });Envía un código de confirmación a la dirección de correo electrónico. El parámetro operation_id utilizado para confirmar la dirección de correo electrónico se devuelve en la respuesta.
              • email (string) - Dirección de correo electrónico para la autenticación sin contraseña.
              • link_url (string) - URL de confirmación.
              • isOauth2 (boolean) - Si se utiliza o no la autenticación basada en el protocolo OAuth 2.0 para los usuarios. Obligatorio.
              Ejemplo
              Copy
              Full screen
              Small screen
                let result
                // Request
                api.emailGetCode({
                  email: 'email@address.com',
                  link_url: 'https://someurl.com',
                  isOauth2: true
                }).then((res) => {
                  result = res;
                })
                
                // Response
                result === {
                  operation_id: '2334j255fdf13d515fgd1'
                }
                
                LlamadaDescripciónParámetros
                api.getConfirmCode({ cancelToken, login, operation_id });Obtiene el código de confirmación para un redireccionamiento automático de un usuario tras pulsar el enlace.
                • cancelToken (string) - Token único para finalizar la sesión. Obligatorio.
                • login (string) - Número de teléfono o dirección de correo electrónico del usuario. Obligatorio.
                • operation_id (string) - Identificador único utilizado para confirmar el número de teléfono o la dirección de correo electrónico de un usuario durante una sesión en curso. Obligatorio.
                Ejemplo
                Copy
                Full screen
                Small screen
                  let result
                  // Request
                  const axiosCancelToken = Axios.CancelToken.source();
                  
                  api.getConfirmCode({
                    cancelToken: axiosCancelToken,
                    login: '+somenumber' || 'email@address.com',
                    operation_id: '334j255fdf13d515fgd1'
                  }).then((res) => {
                    result = res;
                  })
                  
                  // Response
                  result === {
                    code: 'string'
                  }
                  
                  // If the waiting time has elapsed, returns:
                  result === {
                    error: {
                      code: '010-050',
                      description: 'Deadline exceeded.'
                    }
                  }
                  
                  // If you no longer need to wait for verification through the link you can close the request waiting period:
                  axiosCancelToken.cancel();
                  
                  LlamadaDescripciónParámetros
                  api.loginWithPhoneCode({ phone_number, code, operation_id, isOauth2 });Confirma el número de teléfono. La URL con el parámetro token se devuelve en la respuesta. Se utiliza en las solicitudes de datos adicionales sobre el usuario.
                  • phone_number (string) - Número de teléfono para la autenticación sin contraseña.
                  • code (string) - Código de confirmación del teléfono enviado como un SMS.
                  • operation_id (string) - Identificador único utilizado para confirmar un número de teléfono de usuario durante una sesión en curso.
                  • isOauth2 (boolean) - Uso o no de la autenticación basada en el protocolo OAuth 2.0 para los usuarios. Obligatorio.
                  Ejemplo
                  Copy
                  Full screen
                  Small screen
                    let result
                    // Request
                    api.loginWithPhoneCode({
                      phone_number: 'email@address.com',
                      code: '3423',
                      operation_id: '334j255fdf13d515fgd1',
                      isOauth2: true
                    }).then((res) => {
                      result = res;
                    })
                    
                    // Response
                    result === {
                      login_url: 'https://someurl.com?token=XXXXXXX'
                    }
                    
                    
                    // Response with additional fields
                    result === {
                      ask_fields: [{
                        confirmation_type: 'code' || 'link'
                        name: 'email'
                        required: false
                        step: 0 // Displays the position of the field in the data retrieval queue.
                        type: 'email'
                        validation: {} // Custom validation
                      }]
                      login_url: 'https://someurl.com?token=XXXXXXX',
                      token: 'sometoken'
                    }
                    
                    LlamadaDescripciónParámetros
                    api.loginWithEmailCode({ email, code, operation_id, isOauth2 });Confirma la dirección de correo electrónico. La URL con el parámetro token se devuelve en la respuesta. Se utiliza en las solicitudes de datos adicionales sobre el usuario.
                    • email (string) - Dirección de correo electrónico para la autenticación sin contraseña.
                    • code (string) - Código de confirmación del teléfono enviado a una dirección de correo electrónico.
                    • operation_id (string) - Identificador único utilizado para confirmar una dirección de correo electrónico de usuario durante una sesión en curso.
                    • isOauth2 (boolean) - Usar o no la autenticación basada en el protocolo OAuth 2.0 para los usuarios. Obligatorio.
                    Ejemplo
                    Copy
                    Full screen
                    Small screen
                      let result
                      // Request
                      api.loginWithEmailCode({
                        email: 'email@address.com',
                        code: '3423',
                        operation_id: '334j255fdf13d515fgd1',
                        isOauth2: true
                      }).then((res) => {
                        result = res;
                      })
                      
                      // Response
                      result === {
                        login_url: 'https://someurl.com?token=XXXXXXX'
                      }
                      
                      // Response with additional fields
                      result === {
                        ask_fields: [{
                          confirmation_type: 'code' || 'link'
                          name: 'phone_number'
                          required: false
                          step: 0 // Displays the position of the field in the data retrieval queue.
                          type: 'phone'
                          validation: {} // Custom validation
                        }]
                        login_url: 'https://someurl.com?token=XXXXXXX',
                        token: 'sometoken'
                      }
                      

                      Solicitud de campos adicionales sin contraseña

                      Flujo del usuario:
                      1. Tras la autenticación correcta de un usuario, la llamada api.loginWithEmailCode o api.loginWithPhoneCode devuelve una matriz de campos que puede mostrar en una aplicación en un formulario independiente y recoger además el número de teléfono y la dirección de correo electrónico del usuario. También puede obtener la lista de campos ejecutando una llamada a api.getAskFields.
                      2. El usuario introduce un número de teléfono o una dirección de correo electrónico. Se ejecuta la llamada api.ask.
                      3. El servidor recibe los datos y envía un código de confirmación a un número de teléfono o dirección de correo electrónico. Si al inicializar el código se transmite el parámetro disableConfirmByLink=true, que deshabilita la confirmación del inicio de sesión mediante el enlace del correo electrónico, se utiliza la llamada api.getConfirmCode para el redireccionamiento automático del usuario tras hacer clic en el enlace.
                      4. La llamada api.ask devuelve el parámetro operation_id utilizado para confirmar el número de teléfono o la dirección de correo electrónico mediante la llamada api.loginWithPhoneCode o api.loginWithEmailCode.
                      5. La URL que se utiliza para el redireccionamiento a un usuario autenticado se devuelve tras la confirmación correcta de los datos.
                      LlamadaDescripciónParámetros
                      api.getAskFields(token);Obtiene la lista de campos de una solicitud adicional.
                      • token (string) - JWT de usuario. Obligatorio.
                      Ejemplo
                      Copy
                      Full screen
                      Small screen
                        let result
                        // Request
                        api.getAskFields({
                          token: 'sometoken'
                        }).then((res) => {
                          result = res;
                        })
                        
                        // Response
                        result === [
                          {
                            confirmation_type: 'code' || 'link'
                            name: 'phone_number' || 'email'
                            required: false
                            step: 0 // Displays the position of the field in the data retrieval queue.
                            type: 'phone' || 'email'
                            validation: {} // Custom validation
                          }
                        ]
                        
                        LlamadaDescripciónParámetros
                        api.ask({ fields, token, link_url });Envía datos adicionales sobre el usuario: un número de teléfono o una dirección de correo electrónico. En la respuesta se devuelve el parámetro operation_id que se usa para confirmar el número de teléfono o la dirección de correo electrónico especificados. Si no se requiere confirmación, en la respuesta se devuelve la URL con el parámetro token que se utiliza para redirigir a un usuario autenticado.
                        • fields (object) - Objeto en el cual se transmite el teléfono o la dirección de correo electrónico del usuario. Obligatorio.
                        • token (string) - JWT de usuario. Obligatorio.
                        • link_url (string) - URL de confirmación.
                        Un ejemplo de envío de un número de teléfono:
                        Copy
                        Full screen
                        Small screen
                          let result
                          // Request
                          api.ask({
                            fields: {  
                              phone_number: '+somenumber'
                            },
                            link_url: 'https://someurl.com',
                            token: 'sometoken'
                          }).then((res) => {
                            result = res;
                          })
                          
                          // Response
                          result === {
                            error: {
                              code: '003-014'
                              description: 'Confirm phone number.'
                              details: { operation_id: 'BPaBScLM44GesoOYSxT5I8QfgIrTSURd' }
                            }
                          }
                          
                          // Response without confirmation
                          result === {
                            redirect_url: '<login_url>?token=<token>'
                          }
                          

                          Ejemplo de envío de una dirección de correo electrónico:

                          Copy
                          Full screen
                          Small screen
                            let result
                            // request
                            api.ask({
                              fields: {  
                                email: 'email@address.com'
                              },
                              link_url: 'https://someurl.com',
                              token: 'sometoken'
                            }).then((res) => {
                              result = res;
                            })
                            
                            // Response
                            result === {
                              error: {
                                code: '003-011'
                                description: 'Confirm email.'
                                details: { operation_id: 'BPaBScLM44GesoOYSxT5I8QfgIrTSURd' }
                              }
                            }
                            
                            // Response without confirmation
                            result === {
                              redirect_url: '<login_url>?token=<token>'
                            }
                            
                            LlamadaDescripciónParámetros
                            api.getConfirmCode({ cancelToken, login, operation_id });Obtiene el código de confirmación para un redireccionamiento automático de un usuario tras pulsar en el enlace.
                            • cancelToken (string) - Token único para finalizar la sesión. Obligatorio.
                            • login (string) - Número de teléfono o dirección de correo electrónico del usuario. Obligatorio.
                            • operation_id (string) - Identificador único utilizado para confirmar el número de teléfono o la dirección de correo electrónico de un usuario durante una sesión en curso. Obligatorio.
                            Ejemplo
                            Copy
                            Full screen
                            Small screen
                              let result
                              // Request
                              const axiosCancelToken = Axios.CancelToken.source();
                              
                              api.getConfirmCode({
                                cancelToken: axiosCancelToken,
                                login: '+somenumber' || 'email@address.com',
                                operation_id: '334j255fdf13d515fgd1'
                              }).then((res) => {
                                result = res;
                              })
                              
                              // Response
                              result === {
                                code: 'string'
                              }
                              
                              // If the waiting time has elapsed, returns:
                              result === {
                                error: {
                                  code: '010-050',
                                  description: 'Deadline exceeded.'
                                }
                              }
                              
                              // If you no longer need to wait for verification through the link you can close the request waiting period:
                              axiosCancelToken.cancel();
                              
                              LlamadaDescripciónParámetros
                              api.loginWithPhoneCode({ phone_number, code, operation_id, isOauth2 });Confirma el número de teléfono. La URL con el parámetro token se devuelve en la respuesta. Se utiliza en las solicitudes de datos adicionales sobre el usuario.
                              • phone_number (string) - Número de teléfono para la autenticación sin contraseña.
                              • code (string) - Código de confirmación del teléfono enviado como un SMS.
                              • operation_id (string) - Identificador único utilizado para confirmar un número de teléfono de usuario durante una sesión en curso.
                              • isOauth2 (boolean) - Uso o no de la autenticación basada en el protocolo OAuth 2.0 para los usuarios. Obligatorio.
                              Ejemplo
                              Copy
                              Full screen
                              Small screen
                                let result
                                // Request
                                api.loginWithPhoneCode({
                                  phone_number: 'email@address.com',
                                  code: '3423',
                                  operation_id: '334j255fdf13d515fgd1',
                                  isOauth2: true
                                }).then((res) => {
                                  result = res;
                                })
                                
                                // Response
                                result === {
                                  login_url: 'https://someurl.com?token=XXXXXXX'
                                }
                                
                                
                                // Response with additional fields
                                result === {
                                  ask_fields: [{
                                    confirmation_type: 'code' || 'link'
                                    name: 'email'
                                    required: false
                                    step: 0 // Displays the position of the field in the data retrieval queue.
                                    type: 'email'
                                    validation: {} // Custom validation
                                  }]
                                  login_url: 'https://someurl.com?token=XXXXXXX',
                                  token: 'sometoken'
                                }
                                
                                LlamadaDescripciónParámetros
                                api.loginWithEmailCode({ email, code, operation_id, isOauth2 });Confirma la dirección de correo electrónico. La URL con el parámetro token se devuelve en la respuesta. Se utiliza en las solicitudes de datos adicionales sobre el usuario.
                                • email (string) - Dirección de correo electrónico para la autenticación sin contraseña.
                                • code (string) - Código de confirmación del teléfono enviado a la dirección de correo electrónico.
                                • operation_id (string) - Identificador único utilizado para confirmar una dirección de correo electrónico de usuario durante una sesión en curso.
                                • isOauth2 (boolean) - Uso o no de la autenticación basada en el protocolo OAuth 2.0 para los usuarios. Obligatorio.
                                Ejemplo
                                Copy
                                Full screen
                                Small screen
                                  let result
                                  // Request
                                  api.loginWithEmailCode({
                                    email: 'email@address.com',
                                    code: '3423',
                                    operation_id: '334j255fdf13d515fgd1',
                                    isOauth2: true
                                  }).then((res) => {
                                    result = res;
                                  })
                                  
                                  // Response
                                  result === {
                                    login_url: 'https://someurl.com?token=XXXXXXX'
                                  }
                                  
                                  // Response with additional fields
                                  result === {
                                    ask_fields: [{
                                      confirmation_type: 'code' || 'link'
                                      name: 'phone_number'
                                      required: false
                                      step: 0 // Displays the position of the field in the data retrieval queue.
                                      type: 'phone'
                                      validation: {} // Custom validation
                                    }]
                                    login_url: 'https://someurl.com?token=XXXXXXX',
                                    token: 'sometoken'
                                  }
                                  

                                  Restablecimiento de contraseña

                                  Flujo del usuario:
                                  1. La aplicación abre el formulario cuando el usuario introduce su dirección de correo electrónico o nombre de usuario. Se ejecuta la llamada api.reset.
                                  2. El servidor envía un correo electrónico de confirmación al usuario.
                                  3. El usuario hace clic en el enlace del correo electrónico y abre un formulario para introducir una nueva contraseña.
                                  4. El usuario introduce una nueva contraseña. Se ejecuta la llamada api.set.
                                  LlamadaDescripciónParámetros
                                  api.reset(username);Restablece la contraseña y confirma la acción. Para confirmar el restablecimiento de la contraseña, el usuario debe hacer clic en el enlace del correo electrónico. El nombre de usuario o la dirección de correo electrónico del usuario se transmiten en el objeto username. El código 204 se devuelve en la respuesta.
                                  • username (string) - Nombre de usuario, por ejemplo - John, o una dirección de correo electrónico, por ejemplo - email@address.com. Obligatorio.
                                  Ejemplo
                                  Copy
                                  Full screen
                                  Small screen
                                    let result
                                    // Request
                                    api.reset({
                                      username: 'John'
                                    }).then((res) => {
                                      res.code === 204;
                                    })
                                    
                                    LlamadaDescripciónParámetros
                                    api.set({ new_password, reset_code, user_id });Establece una nueva contraseña y confirma la acción. Para confirmar una nueva contraseña, el usuario debe hacer clic en el enlace del correo electrónico. El código 204 se devuelve en la respuesta.
                                    • new_password (string) - Nueva contraseña introducida por un usuario. Oblogatorio.
                                    • reset_code (string) - Un código utilizado para la verificación de un usuario que envió una solicitud de cambio de contraseña. El código se genera en el lado del servidor y se transmite en la URL a la que se redirige al usuario después de hacer clic en el enlace del correo electrónico. Obligatorio.
                                    • user_id (string) - Identificador de usuario. Se genera en el lado del servidor y se transmite en la URL a la que se redirige al usuario después de hacer clic en el enlace del correo electrónico. Obligatorio.
                                    Ejemplo
                                    Copy
                                    Full screen
                                    Small screen
                                      let result
                                      // Request
                                      api.set({
                                        new_password: 'newpass',
                                        reset_code: '3423',
                                        user_id: '324324234'
                                      }).then((res) => {
                                        res.code === 204;
                                      })
                                      

                                      Inicio de sesión único

                                      Nota
                                      ParámetroTipoDescripción
                                      api.checkUserAuthSSO();
                                      Comprueba si un usuario está autorizado a través de Inicio de sesión único. Si se autoriza correctamente, devuelve un code de un solo uso.
                                      Ejemplo
                                      Copy
                                      Full screen
                                      Small screen
                                        let result
                                        // Request
                                        api
                                          .checkUserAuthSSO()
                                          .then(res => {
                                            result === res;
                                          });
                                        
                                        result === {
                                          code: "examplecode"
                                        }
                                        
                                        LlamadaDescripciónParámetros
                                        api.userAuthSSOWithRedirect(loginUrl);Comprueba si un usuario se ha autorizado a través del Inicio de sesión único. Si se autoriza correctamente, un usuario es redirigido a la URL; loginUrl generada que incluye un código de autorización.
                                        • loginUrl (string) - URL a la que se redirige a un usuario tras una verificación de SSO. Tiene que ser la misma que la URL de devolución de llamada indicada en el bloque URL en Cuenta del editor en your Login project > General settings. Obligatorio cuando hay varias direcciones URL a las que se puede redirigir a un usuario.
                                        Ejemplo
                                        Copy
                                        Full screen
                                        Small screen
                                          // Request
                                          api
                                            .userAuthSSOWithRedirect(
                                              loginUrl: 'some-redirect-url.com'
                                            )
                                            .then(res => {
                                              res.code === 302;
                                            });
                                          
                                          LlamadaDescripciónParámetros
                                          api.logout(token, session);Cierra la sesión de un usuario del sistema y elimina una sesión de usuario de acuerdo con el parámetro session.
                                          • token (string) - el JWT del usuario. Obligatorio.
                                          • session (string) - muestra cómo un usuario se desconecta del sistema y cómo se elimina su sesión. Obligatorio. Puede ser:
                                            • sso - elimina solo la sesión de usuario de SSO.
                                            • all - elimina la sesión de usuario de SSO y todos los tókenes de acceso y actualizaciones.
                                          Ejemplo
                                          Copy
                                          Full screen
                                          Small screen
                                            // Request
                                            api
                                              .logout(
                                                token: 'exampleToken',
                                                session: 'sso' | 'all'
                                              )
                                              .then(res => {
                                                res.code === 204;
                                              });
                                            
                                            ParámetroTipoDescripción
                                            api.clearSSO();
                                            Elimina los archivos de cookies de Inicio de sesión único del dispositivo del usuario actual. El código 204 se devuelve en la respuesta si la llamada se realiza correctamente.
                                            Ejemplo
                                            Copy
                                            Full screen
                                            Small screen
                                              // Request
                                              api
                                                .clearSSO()
                                                .then(() => {
                                                  // Success
                                                });
                                              
                                              ¿Te ha resultado útil este artículo?
                                              ¡Gracias!
                                              ¿Hay algo en lo que podamos mejorar? Mensaje
                                              Lo sentimos
                                              Por favor, cuéntanos por qué no te ha resultado útil este artículo. Mensaje
                                              ¡Gracias por tu mensaje!
                                              Nos ayudará a mejorar tu experiencia.
                                              Última actualización: 22 de Enero de 2024

                                              ¿Has encontrado una errata u otro error de texto? Selecciona el texto y pulsa Ctrl+Intro.

                                              Informar de un problema
                                              Nos esforzamos por ofrecer contenido de calidad. Tus comentarios nos ayudan a mejorar.
                                              Déjanos tu correo electrónico para que te podamos responder
                                              ¡Gracias por tu mensaje!