Gerenciar as configurações de origem do perfil de uma organização usando a API do Graph

A configuração de origem do perfil aprimora a experiência do usuário final, tornando a fonte dos dados de perfil clara e compreensível.

Este guia do administrador explica como definir as configurações de origem de perfil em uma organização usando APIs do Microsoft Graph. Ele detalha as etapas necessárias para adicionar, atualizar e excluir uma fonte de perfil em uma organização, garantindo que os dados de perfil sejam atribuídos com precisão e exibidos em várias experiências do Microsoft 365.

Importante

Por padrão, o Microsoft Entra ID é a fonte de dados de perfil em uma organização. Um administrador da organização define a propriedade sourceId que é um identificador de fonte de perfil legível e exclusivo. A propriedade sourceId não é atualizável e pode ser usada como uma chave alternativa ao consultar uma fonte de perfil. Uma origem de perfil é identificável por meio de uma chave gerada pelo sistema chamada id.

Os administradores podem personalizar um nome de exibição de origem de perfil para várias localidades por meio da propriedade localizações .

Definir as configurações de origem de perfil usando a API do Graph

Você pode usar a API profileSource para configurar uma fonte de perfil em sua organização.

Confirme as configurações atuais

Use a operação List para retornar as configurações atuais para fontes de perfil em sua organização.

O exemplo a seguir obtém a coleção de fontes de perfil em uma organização.

GET https://graph.microsoft.com/v1.0/admin/people/profileSources

Se for bem-sucedida, a resposta retornará um código de 200 OK 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 fonte de perfil

Use a operação Criar para adicionar uma origem de perfil em sua organização.

Solicitação

POST https://graph.microsoft.com/v1.0/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, esse método retornará um código de 201 Created 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 fonte de perfil

Use a operação de atualização para modificar uma fonte de perfil em sua organização.

Solicitação

PATCH https://graph.microsoft.com/v1.0/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, esse método retornará um código de 200 OK 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

Use a operação Excluir para remover uma fonte de perfil em sua organização.

Solicitação

DELETE https://graph.microsoft.com/v1.0/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

Definir as configurações de origem do perfil usando o SDK do Microsoft Graph PowerShell

Você pode usar o SDK do Microsoft Graph PowerShell para definir as configurações de origem de perfil em sua organização.

Pré-requisitos

Observação

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

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

Confirme as configurações atuais

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

Get-MgBetaAdminPeopleProfileSource

Para obter uma configuração de definição de origem de perfil em uma organização, use o comando a seguir.

Get-MgBetaAdminPeopleProfileSource -ProfileSourceId $id

Observação

Os comandos get exigem a PeopleSettings.Read.All permissão. Para criar uma sessão do Microsoft Graph com um escopo específico necessário, use o comando a seguir e concorde com as permissões solicitadas.

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

Adicionar uma configuração de fonte de perfil em sua organização

Você pode usar o módulo Microsoft Graph PowerShell para definir uma configuração de fonte de perfil em sua organização. O novo comando requer a PeopleSettings.ReadWrite.All permissão e, para criar uma sessão do Microsoft Graph com o escopo específico necessário, use o comando a seguir e concorde com as permissões solicitadas.

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 configuração de origem de perfil em sua organização

Você pode usar o módulo Microsoft Graph PowerShell para atualizar uma configuração de fonte de perfil em sua organização. O comando de atualização requer a PeopleSettings.ReadWrite.All permissão e, para criar uma sessão do Microsoft Graph com o escopo específico necessário, use o comando a seguir e concorde com as permissões solicitadas.

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 configuração de fonte de perfil na sua organização

Você pode usar o módulo Microsoft Graph PowerShell para remover uma configuração de fonte de perfil da sua organização. O comando remove requer a PeopleSettings.ReadWrite.All permissão e, para criar uma sessão do Microsoft Graph com o escopo específico necessário, use o comando a seguir e concorde com as permissões solicitadas.

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

Remove-MgBetaAdminPeopleProfileSource -ProfileSourceId $id

Conteúdo relacionado

Gerenciar as configurações de precedência de origem de perfil para uma organização

  • Last updated on