RequestAuthAPI : inclus dans le champ d’application

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

    • RequestAuthAPI fournit des méthodes pour appliquer une signature à une demande REST.

    Générez des demandes de signature sortantes à l’aide de ces API dans l’ordre suivant :
    1. HttpRequestData : générer la demande d’API.
    2. AuthCredential : créer un objet d’informations d’identification ou mettre à jour un objet existant. Utilisez les informations d’identification pour signer la demande via la classe RequestAuthAPI .
    3. RequestAuthAPI : signer la demande et renvoyer un objet HttpRequestAuthedData.
    4. HttpRequestAuthedData : obtenir des informations sur la demande signée.
    5. GlideHTTPRequest : envoyer la demande signée.

    Avant d’utiliser ces API, vous devez configurer un algorithme d’authentification pour signer la demande et l’associer aux informations d’identification utilisées pour authentifier la demande.

    Utilisez cette API dans les scripts inclus dans le champ d’application avec l’identificateur d’espace de noms sn_auth.

    RequestAuthAPI : RequestAuthAPI (données de l’objet, informations d’identification de l’objet)

    Instancie un objet RequestAuthAPI à l’aide d’une demande REST et d’informations d’identification.

    Tableau 1. Paramètres
    Nom Type Description
    données Objet Objet HttpRequestData qui contient la demande REST non signée. Utilisez la classe HttpRequestData pour générer cet objet. Consultez API HttpRequestData.
    Credential Objet Objet qui représente un enregistrement de la table Informations d’identification [discovery_credentials]. Récupérez cet objet à l’aide de la classe AuthCredential . Voir API AuthCredential. 
    // Define the HttpRequestData object
var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod("PUT");
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl' , 'public-read' );
 
 // Get a credential record
var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("88772d0d40990010f8772fdd9ebc8075");
 
// Instantiate a RequestAuthAPI object
var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);

    RequestAuthAPI : generateAuth()

    Signe l’objet HttpRequestData et renvoie un objet HttpRequestAuthedData à utiliser pour envoyer la demande REST.

    Tableau 2. Paramètres
    Nom Type Description
    Aucun
    Tableau 3. Renvoie
    Type Description
    Données HttpRequestAuthedData Objet. Données à utiliser pour obtenir des informations sur le résultat signé. Utilisez les méthodes de la classe HttpRequestAuthedData pour interagir avec le résultat signé. Consultez l’API HttpRequestAuthedData.

    Cet exemple crée une demande et obtient un enregistrement d’informations d’identification à transmettre à l’API RequestAuthAPI . La méthode generateAuth() signe alors la requête.

    // Define the HttpRequestData object
var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod("PUT");
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl' , 'public-read' );
 
// Get a credential record
gs.info( "date:" + httpRequestData.getDate() );
var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");
 
// Create the RequestAuthAPI object and sign the request
var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
var output = signingAPI.generateAuth();

    RequestAuthAPI : getAuthCredential()

    Renvoie l’enregistrement d’informations d’identification utilisé pour signer la demande.

    Tableau 4. Paramètres
    Nom Type Description
    Aucun
    Tableau 5. Renvoie
    Type Description
    AuthCredential Objet. Données à utiliser pour obtenir des informations sur l’enregistrement d’informations d’identification utilisé pour signer la demande. Utilisez les méthodes de la classe AuthCredential pour interagir avec les informations d’identification. Voir API AuthCredential. 
    // Define the HttpRequestData object
var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod("PUT");
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl' , 'public-read' );
 
// Get a credential record
var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");
 
// Return the AuthCredential object
var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
var signingCredential = signingAPI.getAuthCredential();

    RequestAuthAPI : getHttpRequestData()

    Renvoie l’objet HttpRequestData utilisé pour instancier la classe RequestAuthAPI .

    Tableau 6. Paramètres
    Nom Type Description
    Aucun
    Tableau 7. Renvoie
    Type Description
    Données de demande en ligne Objet. Contient la demande REST non signée. Utilisez les méthodes de la classe HttpRequestData pour interagir avec la requête. Consultez API HttpRequestData. 
    // Define the HttpRequestData object
var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod("PUT");
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl' , 'public-read' );
 
 // Get a credential record
var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("88772d0d40990010f8772fdd9ebc8075");
 
// Return the HttpRequestData object
var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
var unsignedRequest = signingAPI.getHttpRequestData();
 
gs.info("Endpoint is: " + unsignedRequest.getEndpoint());

    Sortie :

    Endpoint is: https://third-party-endpoint

    RequestAuthAPI : resetAuthCredential()

    Génère un jeton de privilège temporaire et limité que vous pouvez utiliser pour fournir aux utilisateurs approuvés des informations d’identification de sécurité temporaires pour contrôler les ressources tierces.

    Pour utiliser cette méthode, le service tiers doit inclure une API ou un Kit de développement logiciel (SDK) qui traite et gère les jetons d’accès limité.

    Tableau 8. Paramètres
    Nom Type Description
    Aucun
    Tableau 9. Renvoie
    Type Description
    nul 
    // Creates a temporary token 
function(authAPI) {​
    var requestData = authAPI.getHttpRequestData();​
    var credential= authAPI.getAuthCredential();​
    credential.setAttribute('Action', 'aws_sessionToken');​  
    authAPI.resetAuthCredential();	

    //Returns status information
    var status = credential.getAttribute('credential_reset_status'); ​
}