Criar contrato

Namespace: microsoft.graph

Crie um novo objeto de contrato .

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Agreement.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte. As funções menos privilegiadas a seguir têm suporte para essa operação.

  • Administrador de Acesso Condicional \u2012 menos privilegiados
  • Administrador de Segurança

Solicitação HTTP

POST /identityGovernance/termsOfUse/agreements

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON de um objeto de contrato .

A tabela a seguir mostra as propriedades que são necessárias quando você cria um contrato.

Propriedade Tipo Descrição
displayName Cadeia de caracteres Nome de exibição do contrato.
isViewingBeforeAcceptanceRequired Booliano Indica se o usuário precisa expandir e exibir o contrato antes de aceitá-lo.
fileName Cadeia de caracteres Nome do arquivo do contrato (por exemplo, TOU.pdf).
isDefault Booliano Indica se este é o arquivo de contrato padrão se o idioma corresponde à preferência do cliente. Se nenhum dos arquivos for marcado como padrão, o primeiro será tratado como padrão.
idioma Cadeia de caracteres O idioma do arquivo do contrato no formato "languagecode2-country/regioncode2". "languagecode2" é um código minúsculo de duas letras derivado da ISO 639-1, enquanto "country/regioncode2" é derivado da ISO 3166 e geralmente consiste em duas letras maiúsculas ou uma tag de idioma BCP-47. Por exemplo, o inglês dos EUA é en-US.
data Binária Dados que representam os termos de uso do documento PDF.

Resposta

Se for bem-sucedido, esse método retornará um código de 201, Created resposta e um objeto de contrato no corpo da resposta.

Exemplo

Solicitação

No corpo da solicitação, forneça uma representação JSON do objeto do contrato .

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"
      }
    }
  ]
}

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

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