AuthCredential - Dans le champ d’application

L’API AuthCredential() fournit des méthodes qui vous permettent de générer des informations d’identification pour 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.

Vous pouvez créer un objet AuthCredential vide, instancier un objet AuthCredential existant ou utiliser la classe StandardCredentialsProvider pour instancier un objet AuthCredential à l’aide d’un enregistrement d’informations d’identification provenant de la table Informations d’identification [discovery_credentials]. Si vous créez un objet AuthCredential vide, utilisez la méthode setAttribute() pour ajouter des propriétés à l’objet.

L’exemple suivant montre comment instancier un AuthCredential à l’aide de StandardCredentialsProvider :

// Return an AuthCredential object using a Credential sys_id
var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");

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

AuthCredential : AuthCredential (objet authCredential)

Instancie un nouvel objet AuthCredential ou modifie un objet existant.

Vous pouvez créer un objet AuthCredential vide, instancier un objet AuthCredential existant ou utiliser la classe StandardCredentialsProvider pour instancier un objet AuthCredential à l’aide d’un enregistrement d’informations d’identification provenant de la table Informations d’identification [discovery_credentials]. Si vous créez un objet AuthCredential vide, utilisez la méthode setAttribute() pour ajouter des propriétés à l’objet.

Tableau 1. Paramètres

Nom	Type	Description
authCredential	Objet	Facultatif. Incluez ce paramètre pour mettre à jour un objet AuthCredential existant.

AuthCredential : getAttribute (clé de chaîne)

Renvoie la valeur d’un attribut AuthCredential.

Tableau 2. Paramètres

Nom	Type	Description
key	Chaîne	Clé de l’attribut pour lequel retourner la valeur. Si vous avez créé un objet AuthCredential vide, vous devez utiliser la méthode setAttribute() pour ajouter des propriétés à l’objet. Si vous avez utilisé un enregistrement d’informations d’identification pour instancier l’objet AuthCredential , transmettez un nom de champ à partir de la table Informations d’identification [discovery_credentials] pour accéder à la valeur.

Tableau 3. Renvoie

Type	Description
nul

// 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 AuthCredential object and set an attribute
var credential = new sn_auth.AuthCredential();
credential.setAttribute("user_name", "admin");
 
// Sign the request and return an AuthCredential attribute value
var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
var signingCredential = signingAPI.getAuthCredential();
name = signingCredential.getAttribute("name");

AuthCredential : setAttribute (clé de chaîne, valeur de chaîne)

Définit un attribut pour un objet AuthCredential.

Tableau 4. Paramètres

Nom	Type	Description
key	Chaîne	Nom de l’attribut à définir. Si vous avez créé un objet AuthCredential vide, vous devez utiliser cette méthode pour ajouter des propriétés à l’objet. Si vous avez utilisé un enregistrement d’informations d’identification pour instancier l’objet AuthCredential , transmettez un nom de champ à partir de la table Informations d’identification [discovery_credentials] pour définir la valeur.
valide	Chaîne	Valeur de l’attribut.

Tableau 5. Renvoie

Type	Description
nul

// 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 AuthCredential object and set an attribute
var credential = new sn_auth.AuthCredential();
credential.setAttribute("user_name", "admin");