Compartilhar via

tipo de recurso de permissão

  • Artigo

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

O recurso de permissão fornece informações sobre uma permissão de partilha concedida para um recurso driveItem .

As permissões de partilha têm muitos formulários diferentes. O recurso de permissão representa esses diferentes formulários por meio de facetas no recurso.

Nota: OneDrive for Business e as bibliotecas de documentos do SharePoint não devolvem a propriedade herdadaFrom.

OneDrive for Business e as bibliotecas de documentos do SharePoint não devolvem a propriedade herdadaFrom. grantedTo e grantedToIdentities serão preteridos no futuro e a resposta será migrada para grantedToV2 e grantedToIdentitiesV2 respectivamente sob nomes de propriedade apropriados.

Métodos

Método Caminho REST
Listar permissões GET /drive/items/{item-id}/permissions
Obter permissão GET /drive/items/{item-id}/permissions/{id}
Criar link POST /drive/items/{item-id}/createLink
Convidar pessoas POST /drive/items/{item-id}/invite
Atualizar permissão PATCH /drive/items/{item-id}/permissions/{id}
Excluir permissão DELETE /drive/items/{item-id}/permissions/{id}
Conceder acesso à ligação de partilha POST /shares/{encoded-sharing-url}/permission/grant
Revogar concessões na ligação de partilha POST /drive/items/{item-id}/permissions/{id}/revokeGrants

Propriedades

Propriedade Tipo Descrição
id String O identificador exclusivo da permissão entre todas as permissões no item. Somente leitura.
grantedToV2 SharePointIdentitySet Para permissões de tipo de usuário, os detalhes dos usuários e aplicativos para essa permissão. Somente leitura.
grantedToIdentitiesV2 Coleção(SharePointIdentitySet) Para permissões de tipo de link, os detalhes dos usuários aos quais a permissão foi concedida. Somente leitura.
invitation SharingInvitation Detalhes de um convite de compartilhamento associado para esta permissão. Somente leitura.
inheritedFrom ItemReference Fornece uma referência ao predecessor da permissão atual, se for herdada de um predecessor. Somente leitura.
link SharingLink Fornece os detalhes da ligação da permissão atual, se for uma permissão de tipo de ligação. Somente leitura.
funções Collection(String) O tipo de permissão, por exemplo, read. Veja a secção Valores da propriedade Funções para obter a lista completa de funções. Somente leitura.
shareId Cadeia de caracteres Um token exclusivo que pode ser usado para acessar esse item compartilhado por meio da API de compartilhamentos. Somente leitura.
expirationDateTime DateTimeOffset Um formato yyyy-MM-ddTHH:mm:ssZ de DateTimeOffset indica o tempo de expiração da permissão. DateTime.MinValue indica que não existe nenhuma expiração definida para esta permissão. Opcional.
hasPassword Boolean Indica se a senha está definida para essa permissão. Essa propriedade só aparece na resposta. Opcional. Somente leitura. Apenas para o OneDrive Pessoal.
grantedTo (preterido) IdentitySet Para permissões de tipo de usuário, os detalhes dos usuários e aplicativos para essa permissão. Somente leitura.
grantedToIdentities (preterido) Coleção(IdentitySet) Para permissões de tipo, os detalhes dos usuários aos quais a permissão foi concedida. Somente leitura.

Valores de propriedades Roles

Valor Descrição
leitura Oferece a capacidade de ler os metadados e o conteúdo do item.
gravação Oferece a capacidade de ler e modificar os metadados e o conteúdo do item.
proprietário Para o Microsoft Office SharePoint Online e o OneDrive for Business, este representa o papel do proprietário.

O recurso permission usa facetas para fornecer informações sobre o tipo de permissão representado pelo recurso.

Os links de compartilhamento contêm um token exclusivo e necessário para acessar o item.

As permissões com uma faceta de convite representam permissões adicionadas ao convidar utilizadores ou grupos específicos para terem acesso ao ficheiro.

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "id": "string (identifier)",
  "grantedTo": {"@odata.type": "microsoft.graph.identitySet"},
  "grantedToIdentities": [{"@odata.type": "microsoft.graph.identitySet"}],
  "grantedToV2": {"@odata.type": "microsoft.graph.sharePointIdentitySet"},
  "grantedToIdentitiesV2": [{"@odata.type": "microsoft.graph.sharePointIdentitySet"}],
  "inheritedFrom": {"@odata.type": "microsoft.graph.itemReference"},
  "invitation": {"@odata.type": "microsoft.graph.sharingInvitation"},
  "link": {"@odata.type": "microsoft.graph.sharingLink"},
  "roles": ["string"],
  "shareId": "string",
  "expirationDateTime": "string (timestamp)",
  "hasPassword": "boolean"
}

Comentários

Permissões com uma faceta link representam links de compartilhamento criados no item. Estes são os tipos mais comuns de permissões. Os links de compartilhamento fornecem uma URL exclusiva que pode ser usada para acessar um arquivo ou pasta. Podem ser configurados para conceder acesso de várias formas. Por exemplo, você pode usar a API createLink para criar um link que funcione para qualquer pessoa conectada à sua organização ou criar um link que funcione para qualquer pessoa, sem precisar fazer logon. Você pode usar a API invite para criar um link que funcione apenas para pessoas específicas, estejam elas na sua empresa ou não.

Aqui estão alguns exemplos de links de compartilhamento.

Este link de exibição fornece acesso somente leitura a qualquer pessoa com o link.

{
  "id": "1",
  "roles": ["read"],
  "link": {
    "scope": "anonymous",
    "type": "view",
    "webUrl": "https://onedrive.live.com/redir?resid=5D33DD65C6932946!70859&authkey=!AL7N1QAfSWcjNU8&ithint=folder%2cgif",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Este link de edição fornece acesso de leitura e gravação a qualquer pessoa na organização com o link.

{
  "id": "2ceefb3g32hh",
  "roles": ["write"],
  "link": {
    "scope": "organization",
    "type": "edit",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/fj277ghautbb422707565gnvg23",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Esta ligação não concede privilégios adicionais ao utilizador.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "roles": ["read"],
  "link": {
    "scope": "existingAccess",
    "type": "view",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/Shared%20Documents/SampleDoc.docx?d=w12345",
  },
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Este link fornece acesso de leitura e gravação para as pessoas específicas na coleção grantedToIdentities.

{
  "id": "3",
  "grantedToIdentities": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      }
    }
  ],
  "grantedToIdentitiesV2": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      },
      "siteUser": {
        "id": "1",
        "displayName": "Misty Suarez",
        "loginName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      },
      "siteUser": {
        "id": "2",
        "displayName": "Judith Clemons",
        "loginName": "Judith Clemons"
      }
    }
  ],
  "roles": ["write"],
  "link": {
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Partilhar convites

As permissões enviadas pela API de convite ou concessão podem ter informações adicionais na faceta do convite para endereços de e-mail que não correspondem a uma conta conhecida. Nestes casos, a propriedade grantedTo poderá não ser definida até que a ligação de convite seja resgatada, o que ocorre quando o utilizador clica na ligação pela primeira vez e inicia sessão.

{
  "id": "1",
  "roles": ["write"],
  "invitation": {
    "email": "jd@fabrikam.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Depois que o convite de compartilhamento tiver sido resgatado por um usuário, a propriedade grantedTo conterá as informações sobre a conta que resgatou as permissões:

{
  "id": "1",
  "roles": ["write"],
  "grantedTo": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "Robin Danielsen"
    }
  },
  "grantedToV2": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "Robin Danielsen"
    },
    "siteUser": {
      "id": "1",
      "displayName": "Robin Danielsen",
      "loginName": "Robin Danielsen"
    }
  },
  "invitation": {
    "email": "rd@contoso.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}