Compartilhar via


Criar contrato

Namespace: microsoft.graph

Crie um novo objeto de contrato .

Esta API está disponível nas seguintes implementações de cloud nacionais.

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

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
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

Em cenários delegados com contas escolares ou profissionais, tem de ser atribuída uma função de Microsoft Entra suportada ao utilizador com sessão iniciada. O Administrador de Acesso Condicional é a função com menos privilégios suportada para esta operação. O Administrador de Segurança é uma função mais privilegiada suportada para esta operação.

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 do pedido, forneça uma representação JSON de um objeto de contrato .

A tabela seguinte mostra as propriedades necessárias quando cria um contrato.

Propriedade Tipo Descrição
displayName Cadeia de caracteres Nome a apresentar do contrato.
isViewingBeforeAcceptanceRequired Booliano Indica se o utilizador tem de expandir e ver o contrato antes de aceitar.
fileName Cadeia de caracteres Nome do ficheiro de contrato (por exemplo, TOU.pdf).
isDefault Booliano Indica se este é o ficheiro de contrato predefinido se o idioma corresponder à preferência do cliente. Se nenhum dos ficheiros estiver marcado como predefinido, o primeiro é tratado como predefinido.
idioma Cadeia de caracteres O idioma do ficheiro do contrato no formato "languagecode2-country/regioncode2". "languagecode2" é um código em minúsculas de duas letras derivado da ISO 639-1, enquanto "país/regiãocode2" é derivado da ISO 3166 e, normalmente, consiste em duas letras maiúsculas ou uma etiqueta de idioma BCP-47. Por exemplo, inglês dos E.U.A. é en-US.
data Binária Dados que representam os termos de utilização do documento PDF.

Resposta

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

Exemplo

Solicitação

No corpo do pedido, 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"
}