Partager via


Créer un contrat

Espace de noms: microsoft.graph

Créez un objet de contrat .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Agreement.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Non prise en charge. Non prise en charge.

Requête HTTP

POST /identityGovernance/termsOfUse/agreements

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un objet de contrat .

Le tableau suivant indique les propriétés requises lorsque vous créez un contrat.

Propriété Type Description
displayName Chaîne Nom d’affichage du contrat.
isViewingBeforeAcceptanceRequired Valeur booléenne Indique si l’utilisateur doit développer et afficher le contrat avant d’accepter.
fileName Chaîne Nom du fichier d’accord (par exemple, TOU.pdf).
isDefault Valeur booléenne Indique s’il s’agit du fichier de contrat par défaut si la langue correspond à la préférence du client. Si aucun des fichiers n’est marqué comme fichier par défaut, le premier est traité comme étant par défaut.
language Chaîne Langue du fichier de contrat au format « languagecode2-country/regioncode2 ». « languagecode2 » est un code à deux lettres minuscules dérivé de la norme ISO 639-1, tandis que « country/regioncode2 » est dérivé de la norme ISO 3166 et se compose généralement de deux lettres majuscules ou d’une balise de langue BCP-47. Par exemple, l’anglais américain est en-US.
data Binaire Données qui représentent les conditions d’utilisation du document PDF.

Réponse

Si elle réussit, cette méthode renvoie un 201, Created code de réponse et un objet de contrat dans le corps de la réponse.

Exemple

Demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet contrat .

POST https://graph.microsoft.com/v1.0/identityGovernance/termsOfUse/agreements
Content-type: application/json

{
  "displayName": "Contoso ToU for guest users",
  "isViewingBeforeAcceptanceRequired": true,
  "files": [
    {
      "fileName": "TOU.pdf",
      "language": "en",
      "isDefault": true,
      "fileData": {
        "data": "SGVsbG8gd29ybGQ=//truncated-binary"
      }
    }
  ]
}

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-type: application/json

{
  "displayName": "MSGraph Sample",
  "isViewingBeforeAcceptanceRequired": true,
  "id": "093b947f-8363-4979-a47d-4c52b33ee1be"
}