Compartilhar via

Gerir definições de origem de perfil para uma organização com o Microsoft API do Graph

A configuração da origem de perfil melhora a experiência do utilizador final, tornando clara e compreensível a origem dos respetivos dados de perfil.

Este guia de administrador explica como configurar as definições de origem de perfil numa organização com as APIs do Microsoft Graph. Detalha os passos necessários para adicionar, atualizar e eliminar uma origem de perfil numa organização, garantindo que os dados de perfil são atribuídos e apresentados com precisão em várias experiências do Microsoft 365.

Importante

Por predefinição, Microsoft Entra ID é a origem de dados de perfil numa organização. Um administrador da organização define a propriedade sourceId que é um identificador de origem de perfil legível e exclusivo. A propriedade sourceId não é atualizável e pode ser utilizada como uma chave alternativa quando consulta uma origem de perfil. Uma origem de perfil é identificável através de uma chave gerada pelo sistema com o nome ID.

Os administradores podem personalizar um nome a apresentar de origem de perfil para várias regiões através da propriedade localizações .

Configurar definições de origem de perfil com o Microsoft API do Graph

Pode utilizar a API profileSource para configurar uma origem de perfil na sua organização.

Confirmar as definições atuais

Utilize a operação Lista para devolver as definições atuais das origens de perfil na sua organização.

O exemplo seguinte obtém a coleção de origens de perfil numa organização.

GET https://graph.microsoft.com/beta/admin/people/profileSources

Se for bem-sucedida, a resposta devolve um 200 OK código de resposta e um objeto profileSource no corpo da resposta.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "27f1af7b-b166-4f5b-b994-ae135a581547",
      "sourceId": "bamboohr1",
      "kind": "BambooHR",
      "displayName": "HR Platform",
      "webUrl": "https://bamboohr.contoso.com/login",
      "localizations": [
        {
          "displayName" : "HR-Platform",
          "webUrl" : "http://bamboohr.contoso.com/en-us/login",
          "languageTag" : "en-us"
        },
        {
          "displayName" : "HR-Plattform",
          "webUrl" : "http://bamboohr.contoso.com/de/login",
          "languageTag" : "de"
        }
      ]
    },
    {
      "id": "520c18f8-0284-4d79-9b14-8a2d74461370",
      "sourceId": "4ce763dd-9214-4eff-af7c-da491cc3782d",
      "kind": "MSEntra",
      "displayName": "Contoso Microsoft Entra",
      "webUrl": "https://login.microsoftonline.com",
      "localizations": [
        {
          "displayName" : "Contoso Microsoft Entra",
          "webUrl" : "https://login.microsoftonline.com",
          "languageTag" : "en-us"
        }
      ]
    }
  ]
}

Adicionar uma origem de perfil

Utilize a operação Criar para adicionar uma origem de perfil na sua organização.

Solicitação

POST https://graph.microsoft.com/beta/admin/people/profileSources
Content-Type: application/json

{
  "sourceId": "bamboohr1",
  "displayName": "HR Platform",
  "kind": "BambooHR",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

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

Resposta

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

{
  "id" : "27f1af7b-b166-4f5b-b994-ae135a581547",
  "sourceId": "bamboohr1",
  "kind": "BambooHR",
  "displayName": "HR Platform",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

Atualizar uma origem de perfil

Utilize a operação Atualizar para modificar uma origem de perfil na sua organização.

Solicitação

PATCH https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='bamboohr1')
Content-Type: application/json

{
  "displayName": "BambooHR Updated",
  "localizations": [
    {
      "displayName" : "HR-Platform",
      "webUrl" : "http://bamboohr.contoso.com/en-us/login",
      "languageTag" : "en-us"
    },
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto profileSource no corpo da resposta.

Resposta

HTTP/1.1 200 OK
Content-type: application/json

{
  "id" : "27f1af7b-b166-4f5b-b994-ae135a581547",
  "sourceId": "bamboohr1",
  "kind": "BambooHR",
  "displayName": "BambooHR Updated",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Platform",
      "webUrl" : "http://bamboohr.contoso.com/en-us/login",
      "languageTag" : "en-us"
    },
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

Remover uma origem de perfil

Utilize a operação Eliminar para remover uma origem de perfil na sua organização.

Solicitação

DELETE https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='bamboohr1')

Se tiver êxito, este método retornará um código de resposta 204 No Content.

Resposta

HTTP/1.1 204 No Content

Configurar definições de origem de perfil com o SDK do PowerShell do Microsoft Graph

Pode utilizar o SDK do PowerShell do Microsoft Graph para configurar as definições de origem do perfil na sua organização.

Pré-requisitos

Observação

Os comandos do PowerShell para as definições de origem do perfil só estão disponíveis na versão beta. Mude para a experiência beta antes de executar os seguintes comandos.

Install-Module -Name Microsoft.Graph.Beta -MinimumVersion 2.3.0
Update-Module Microsoft.Graph.Beta

Confirmar as definições atuais

Para obter a configuração das definições de origem do perfil para uma organização, utilize o seguinte comando.

Get-MgBetaAdminPeopleProfileSource

Para obter uma configuração de definição de origem de perfil numa organização, utilize o seguinte comando.

Get-MgBetaAdminPeopleProfileSource -ProfileSourceId $id

Observação

Os comandos get requerem a PeopleSettings.Read.All permissão. Para criar uma sessão do Microsoft Graph com um âmbito necessário específico, utilize o seguinte comando e consentimento para as permissões pedidas.

Connect-MgGraph -Scopes "PeopleSettings.Read.All"

Adicionar uma definição de origem de perfil na sua organização

Pode utilizar o módulo do PowerShell do Microsoft Graph para configurar uma definição de origem de perfil na sua organização. O novo comando requer a permissão PeopleSettings.ReadWrite.All e para criar uma sessão do Microsoft Graph com o âmbito necessário específico, utilize o seguinte comando e consentimento para as permissões pedidas.

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

$params = @{
	displayName = "HR-Platform"
	sourceId = "hrPlatform1"
	webUrl = "http://bamboohr.contoso.com/login"
	localizations = @(
		@{
			displayName = "HR-Plattform"
			webUrl = "http://bamboohr.contoso.com/de/login"
			languageTag = "de"
		}
	)
}

New-MgBetaAdminPeopleProfileSource -BodyParameter $params

Atualizar uma definição de origem de perfil na sua organização

Pode utilizar o módulo do PowerShell do Microsoft Graph para atualizar uma definição de origem de perfil na sua organização. O comando update requer a permissão PeopleSettings.ReadWrite.All e para criar uma sessão do Microsoft Graph com o âmbito necessário específico, utilize o seguinte comando e consentimento para as permissões pedidas.

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

$params = @{
	displayName = "HR-Platform Updated"
	sourceId = "hrPlatform1"
	webUrl = "http://bamboohr.contoso.com/login"
	localizations = @(
    @{
      displayName = "HR-Platform"
      webUrl = "http://bamboohr.contoso.com/en-us/login"
      languageTag = "en-us"
    },
		@{
			displayName = "HR-Plattform"
			webUrl = "http://bamboohr.contoso.com/de/login"
			languageTag = "de"
		}
	)
}

Update-MgBetaAdminPeopleProfileSource -ProfileSourceId $id -BodyParameter $params

Remover uma definição de origem de perfil na sua organização

Pode utilizar o módulo do PowerShell do Microsoft Graph para remover uma definição de origem de perfil da sua organização. O comando remover requer a permissão PeopleSettings.ReadWrite.All e para criar uma sessão do Microsoft Graph com o âmbito necessário específico, utilize o seguinte comando e consentimento para as permissões pedidas.

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

Remove-MgBetaAdminPeopleProfileSource -ProfileSourceId $id

Conteúdo relacionado

Gerir definições de precedência de origem de perfil para uma organização

  • Last updated on