Partager via


Créer un contrat

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

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.

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge. Administrateur de l’accès conditionnel est le rôle le moins privilégié pris en charge pour cette opération. Administrateur de sécurité est un rôle plus privilégié pris en charge pour cette opération.

Requête HTTP

POST /identityGovernance/termsOfUse/agreements

En-têtes de demande

Nom Type Description
Autorisation string Porteur {token}. Obligatoire.

Corps de la demande

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

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

Propriété Type Description
displayName String Nom d’affichage du contrat.
isViewingBeforeAcceptanceRequired Booléen Indique si l’utilisateur doit développer et afficher le contrat avant d’accepter.
files/fileName String Nom du fichier d’accord (par exemple, TOU.pdf).
files/isDefault Booléen Indique s’il s’agit du fichier d’accord par défaut si aucune culture ne correspond à la préférence du client. Si aucun fichier n’est marqué comme fichier par défaut, le premier est traité comme étant par défaut.
fichiers/langue String Culture du fichier d’accord au format languagecode2-country/regioncode2. languagecode2 est un code minuscule à deux lettres dérivé de la norme ISO 639-1. 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, en-US).
files/fileData/data Binary Données représentant les conditions d’utilisation du document PDF.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse et un 201, Created 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/beta/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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements/$entity",
    "id": "94410bbf-3d3e-4683-8149-f034e55c39dd",
    "displayName": "Contoso ToU for guest users",
    "termsExpiration": null,
    "userReacceptRequiredFrequency": null,
    "isViewingBeforeAcceptanceRequired": true,
    "isPerDeviceAcceptanceRequired": false
}