PersonalAuthAPI : inclus dans le champ d’application

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 2 minutes de lecture

    • PersonalAuthAPI fournit des méthodes qui vous permettent de gérer les jetons d’accès/d’actualisation pour les informations d’identification d’authentification personnelles.

    Pour accéder à cette API, le module d’extension Personal Authentication (com.snc.sn_ihub_personal_auth) doit être activé. Cette API s’exécute dans l’espace de noms sn_cc .

    Avant d’accéder à cette API, l’authentification personnelle doit être configurée sur votre instance. Pour en savoir plus, consultez Create a Connection & Credential alias.

    PersonalAuthAPI : PersonalAuthAPI()

    Instancie un nouvel objet PersonalAuthAPI.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun

    L’exemple de code suivant montre comment instancier un objet PersonalAuthAPI.

    var personalAuthAPI = new sn_cc.PersonalAuthAPI();

    PersonalAuthAPI : getInitiatorURL(String aliasId)

    Renvoie l’URL de l’initiateur OAuth pour les informations d’identification d’authentification personnelles associées à un alias spécifié.

    Tableau 2. Paramètres
    Nom Type Description
    aliasId Chaîne Sys_id de l’alias de connexion ou d’informations d’identification dont vous souhaitez récupérer l’URL de l’initiateur OAuth. Situé dans la table Alias de connexion et d’informations d’identification [sys_alias].
    Tableau 3. Renvoie
    Type Description
    Chaîne URL de l’initiateur OAuth de l’identifiant d’authentification personnel associé à l’alias spécifié. Si les informations d’identification d’authentification personnelles n’existent pas pour l’alias spécifié, la méthode renvoie une chaîne vide.

    L’exemple de code suivant montre comment appeler cette méthode.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250";
var personalAuthAPI = new sn_cc.PersonalAuthAPI();
var result = personalAuthAPI.getInitiatorURL(aliasId);
gs.info(result);

    Sortie :

    /oauth_initiator.do?oauth_requestor_context=oauth_2_0_credentials&oauth_requestor=d84b5115532102104c4bddeeff7b12f2&oauth_provider_profile=d84b5115532102104c4bddeeff7b12ec&response_type=code&personal=true

    PersonalAuthAPI : isTokenValid (aliasId de chaîne)

    Vérifie s’il existe un jeton d’accès/actualisation valide pour les informations d’identification d’autorisation personnelle associées à un alias spécifié.

    Tableau 4. Paramètres
    Nom Type Description
    aliasId Chaîne Sys_id de l’alias de connexion ou d’informations d’identification pour vérifier les informations d’identification d’autorisation personnelle associées. Situé dans la table Alias de connexion et d’informations d’identification [sys_alias].
    Tableau 5. Renvoie
    Type Description
    Booléen Marqueur indiquant s’il existe des informations d’identification d’autorisation personnelle associées à l’ID d’alias spécifié.
    Valeurs valides :
    • vrai : il existe des informations d’identification d’autorisation personnelles valides.
    • faux : il n’existe pas d’informations d’identification d’autorisation personnelle valides.

    L’exemple de code suivant montre comment appeler cette méthode.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250"; 
var personalAuthAPI = new sn_cc.PersonalAuthAPI();  
var result = personalAuthAPI.isTokenValid(aliasId); 
gs.info(result);

    Sortie :

    true

    PersonalAuthAPI : revokeToken (alias de chaîne)

    Révoque un jeton d’accès/actualisation existant pour les informations d’identification d’authentification personnelles associées à un alias spécifié.

    Tableau 6. Paramètres
    Nom Type Description
    aliasId Chaîne Sys_id de l’alias de connexion ou d’informations d’identification dont vous souhaitez révoquer le jeton d’accès/actualisation pour les informations d’identification d’autorisation personnelles. Situé dans la table Alias de connexion et d’informations d’identification [sys_alias].
    Tableau 7. Renvoie
    Type Description
    Objet Objet contenant des méthodes que vous pouvez appeler pour obtenir des informations supplémentaires sur l’état des informations d’identification et de l’appel de méthode. Ces méthodes sont disponibles jusqu’au prochain appel de cette méthode.
    • <object_name>.getResponseStatus() : renvoie l’état de l’appel de la méthode revokeToken(),soit avec succès ou échec. Vous pouvez trouver des informations supplémentaires sur toute erreur dans les journaux d’erreurs.
    • <object_name>.getExpiryInSeconds() : Renvoie le nombre de secondes avant l’expiration des informations d’identification associées. Si cette valeur est autre que zéro, la demande de révocation a échoué.
    • <object_name>.isAuthenticated() : renvoie une valeur booléenne qui indique si le jeton d’authentification personnel existe. Si l’appel de la méthode revokeToken() a réussi, cette méthode doit retourner false.
    • <object_name>.getCredentialId() : renvoie la sys_id des informations d’identification d’autorisation personnelles associées au jeton. Situé dans la table Informations d’identification OAuth 2.0 [oauth_2_0_credentials].

    L’exemple de code suivant montre comment appeler cette méthode.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250";
var personalAuthAPI = new sn_cc.PersonalAuthAPI();
var personalAuthResponse = personalAuthAPI.revokeToken(aliasId); 
gs.info(personalAuthResponse.getResponseStatus());
gs.info(personalAuthResponse.getExpiryInSeconds());
gs.info(personalAuthResponse.isAuthenticated());
gs.info(personalAuthResponse.getCredentialId());

    Sortie :

    SUCCESS
0
false
d84b5115532102104c4bddeeff7b12f2