Partilhar via


Criar extensionProperty (extensão de diretório)

Namespace: microsoft.graph

Crie uma nova definição de extensão de diretório, representada por um objeto extensionProperty .

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

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

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Application.ReadWrite.All Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Application.ReadWrite.All Indisponível.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.All, Directory.ReadWrite.All

Solicitação HTTP

POST /applications/{application ObjectId}/extensionProperties
POST /applications(appId='{appId}')/extensionProperties

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 um objeto extensionProperty com as propriedades a seguir.

Propriedade Tipo Descrição
dataType Cadeia de caracteres Especifica o tipo de dados do valor que a propriedade de extensão pode conter. Há suporte para valores a seguir.
  • Binary - 256 bytes máximos
  • Boolean
  • DateTime - Deve ser especificado no formato ISO 8601. Serão armazenados no UTC.
  • Integer - Valor de 32 bits.
  • LargeInteger - Valor de 64 bits.
  • String - 256 caracteres no máximo
Não anulável. Para extensões de diretório multivalorizado, esses limites se aplicam por valor na coleção.
nome Cadeia de caracteres Nome da propriedade de extensão. Não anulável.
isMultiValued Booliano Define a extensão de diretório como uma propriedade de vários valores. Quando true, a propriedade de extensão de diretório pode armazenar uma coleção de objetos do dataType; por exemplo, uma coleção de tipos de cadeia de caracteres como "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. O valor padrão é false.
targetObjects Coleção de cadeias de caracteres Os recursos do Microsoft Graph que podem usar a propriedade de extensão. Todos os valores devem estar em PascalCase. Os valores a seguir têm suporte. Não anulável.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Resposta

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

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/applications/fd918e4b-c821-4efb-b50a-5eddd23afc6f/extensionProperties
Content-type: application/json

{
    "name": "jobGroup",
    "dataType": "String",
    "isMultiValued": true,
    "targetObjects": [
        "User"
    ]
}

Resposta

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#applications('fd918e4b-c821-4efb-b50a-5eddd23afc6f')/extensionProperties/$entity",
    "id": "da38c7b1-133e-4a79-abcd-e2fd586ce621",
    "deletedDateTime": null,
    "appDisplayName": "b2c-extensions-app. Do not modify. Used by AADB2C for storing user data.",
    "dataType": "String",
    "isMultiValued": true,
    "isSyncedFromOnPremises": false,
    "name": "extension_25883231668a43a780b25685c3f874bc_jobGroup",
    "targetObjects": [
        "User"
    ]
}