Account extension fields - Identity as a Service: Central de Documentação do Alibaba Cloud

O IDaaS EIAM oferece suporte a dois tipos de campos de conta: basic fields, predefinidos pelo sistema, e campos de extensão, criados para armazenar atributos adicionais do usuário, como ID de funcionário, departamento ou região.

Após a criação, os aplicativos consomem os campos de extensão de três formas: recuperação via Dev/OpenAPI para sincronização, inclusão no id_token OIDC e no endpoint UserInfo após o SSO, ou retorno em Attribute Statements SAML.

Campos básicos

Os campos básicos são predefinidos pelo sistema e registram informações padrão do usuário, como nome de usuário, endereço de e-mail e número de telefone. Não é possível adicioná-los ou excluí-los. Configure apenas a visibilidade e a editabilidade voltadas para o usuário, e somente para três campos: nome de exibição do usuário, e-mail do usuário e número de telefone.

Visualizar campos básicos

Faça login no console do IDaaS. No painel de navegação, selecione console do IDaaSEIAM, selecione sua instância do IDaaS e clique em Manage.
Acesse Account > Field Management > Basic Fields.
Para visualizar apenas os campos editáveis pelo usuário, selecione Editable Fields Only à esquerda.

A lista de campos básicos contém as seguintes colunas:

Coluna	Descrição
Nome de exibição do campo	Rótulo apresentado na interface do usuário
ID do campo	Identificador interno do sistema
Tipo de dados	Sempre `String` para campos básicos
Obrigatório	Indica se o preenchimento do campo é obrigatório
Único	Define se o valor do campo deve ser exclusivo entre as contas
Permissões do usuário	Determina se os usuários finais podem visualizar ou editar o campo: Invisible, Visible ou Editable
Ações	Disponível apenas para nome de exibição do usuário, e-mail do usuário e número de telefone

Configurar permissões de usuário para um campo básico

Apenas três campos básicos permitem alteração de permissões: user display name, user email e phone number.

Na aba Basic Fields, localize o campo que deseja atualizar.
Clique em Modify na coluna Actions.
Na caixa de diálogo Edit Field, defina as User Permissions:
- Invisible — oculta o campo dos usuários
- Visible — permite que os usuários vejam o valor do campo, mas não o editem
- Editable — possibilita que os usuários visualizem e atualizem seus próprios valores
Clique em OK para salvar.

Campos de extensão

Os campos de extensão permitem armazenar atributos personalizados do usuário além dos campos básicos integrados. Exemplos comuns incluem ID de funcionário, data de nascimento e região.

Apenas campos de extensão de conta têm suporte. O sistema não oferece suporte a campos de extensão para outros tipos de entidade, como grupos ou organizações.

Criar um campo de extensão

Acesse Account > Field Management > Extended Fields.
Clique em Create Field e preencha o formulário:

Configurações gerais

Campo	Descrição	Editável após a criação
Nome de exibição do campo	Rótulo apresentado na interface do usuário	Sim
ID do campo	Identificador exclusivo para este campo. Use apenas letras minúsculas e underscores; não inicie com underscore. Este valor corresponde à chave do campo nas configurações de API e SSO.	Não
Tipo de campo	Controla a renderização do campo: Input box, Drop-down list ou Checkbox	Não
Descrição do campo	(Opcional) Texto explicativo exibido abaixo do campo	Sim
Obrigatório	Quando selecionado, exige o preenchimento deste campo em todas as operações de criação e edição de conta. Se houver provedores de identidade (IdPs) configurados para importação de contas e você adicionar um novo campo obrigatório, acesse a página Identity Provider para adicionar o mapeamento de campos. Caso contrário, a sincronização falhará.	Não
Único	Define se o valor do campo deve ser exclusivo nesta instância. Selecione esta opção para campos como ID de funcionário.	Não
Criptografia	Criptografa os dados do campo antes do armazenamento. Recomendado para atributos sensíveis, visando reduzir riscos de exposição.	Não
Permissões do usuário	Controla o acesso do usuário final a este campo: Invisible, Visible ou Editable.	Sim

Tipo de campo: Input box

Parâmetro	Descrição	Editável após a criação
Tipo de dados	`String` ou `Number`	Não
Valor padrão	Valor utilizado quando nenhuma entrada é fornecida. Equivalente à restrição `DEFAULT` em um banco de dados relacional.	Sim

Tipo de campo: Drop-down list

Parâmetro	Descrição	Editável após a criação
Tipo de dados	`String` ou `Number`	Não
Itens de dados	Pares chave-valor para as opções da lista suspensa. A chave é o valor armazenado; o nome de exibição é o que os usuários veem. Por exemplo, armazene a chave `1` e exiba-a como `Small`.	Adicionar: Sim / Desativar ou ativar: Sim / Excluir: Não / Modificar chave: Não / Modificar nome de exibição: Sim
Valor padrão	Chave da opção selecionada por padrão	Sim

Não é possível excluir itens de dados após a criação. Para remover uma opção da lista suspensa, desative-a. Os valores de campo existentes não são afetados quando um item é desativado.

Tipo de campo: Checkbox

Utiliza os mesmos parâmetros e regras de edição da lista suspensa.

Clique em OK para criar o campo.

Preencher campos de extensão para uma conta

Após criar e ativar um campo:

Acesse Accounts And Orgs e clique em Create Account.
Na caixa de diálogo de criação de conta, mude para a aba Extended Field.
Insira os valores para os campos de extensão e envie o formulário.

Autoatendimento do usuário

Os usuários podem visualizar e editar seus próprios valores de campos de extensão no portal do usuário:

Campos Visible aparecem em My Account > Extended Information (somente leitura).
Campos Editable incluem uma opção de modificação para que os usuários atualizem seus próprios valores.

Recuperar campos de extensão em aplicativos

Os aplicativos acessam os dados dos campos de extensão por três métodos:

Método	Retornado por padrão	Configuração necessária
Dev/OpenAPI	Sim — todos os campos de extensão retornam sem configuração adicional	Nenhuma. Consulte a documentação da API.
SSO OIDC (`id_token` / endpoint UserInfo)	Não	Nas configurações estendidas do `id_token`, adicione o campo usando o formato `user.customFieldMap.$field key value$.fieldValue`. O endpoint UserInfo retorna as mesmas claims do `id_token`.
SSO SAML (Attribute Statements)	Não	Na configuração de Attribute Statements do aplicativo, adicione um atributo personalizado para incluir o valor do campo de extensão no SAMLResponse.