全部产品
Search
文档中心

应用身份服务:扩展字段

更新时间:Sep 18, 2024

IDaaS支持对账户字段进行自定义扩展,存储额外属性值:例如工号、生日、所在区域等。管理员可在扩展字段菜单中定义并使用新的字段。

说明

当前仅支持账户的扩展字段,其他主体暂不支持。

image.png

创建字段

管理员可前往扩展字段页面,单击创建字段按钮,弹出字段的创建表单。需要填写的内容说明如下:

字段

说明

是否支持编辑

字段显示名称

字段的显示名称。

可编辑。

字段标识

字段的唯一标识,只允许英文小写字母和下划线,不能以下划线开头。​

不可编辑。

字段类型

字段在页面的呈现方式,可选如下:

  • 输入框Input

  • 下拉框Select

  • 勾选框Checkbox

不可编辑。

字段类型:

输入框Input

选择输入框类型后,需要填写如下字段:

  • 数据类型:指定数据为字符串或数字。

  • 默认值:指该字段不传入值时系统将默认采用的值。可类比关系型数据库中字段的DEFAULT值。

数据类型:不可编辑。

默认值:可编辑。

字段类型:

下拉框Select

  • 数据类型:指定数据为字符串或数字。

  • 数据项:定义下拉框中不同选项的键值对。

  • 处于数据兼容性考虑,数据项创建完成后无法删除,只能在编辑时禁用/启用。禁用后,该数据项将从选项中消失,旧有数据不受影响。

  • 默认值:指定字段的默认选项,填写对应的数据项key。

image.png

数据类型:不可编辑。

数据项

  • 新增:可编辑。

  • 禁用/启用:可编辑。

  • 删除:不可编辑。

  • 修改 key:不可编辑。

  • 修改名称:可编辑。

默认值:可编辑。

字段类型:

多选框Checkbox

参数填写如上:下拉框。

如上:下拉框。

字段描述

选填。

位于字段下方的说明信息。

可编辑。

是否必填

若勾选则之后发生的所有账户创建或编辑中该字段均为必填。

说明

注意:若有已配置在使用的IdP身份提供方进行账户导入,在添加新的必填字段,请务必前往身份提供方页面添加字段映射,否则同步将失败。

不可编辑。

是否唯一

指定字段是否在当前实例内唯一,例如存储工号时可能应该勾选。

不可编辑。

加密存储

对于敏感信息,IDaaS支持进行加密后存储到数据库中,以增强安全性。

不可编辑。

用户侧权限

管理员对扩展字段拥有全部权限。在一些场景中,用户对字段的权限应进行限制。

指定用户对当前扩展字段的权限。选项包括:

  • 不可见:用户看不到当前字段。

  • 可见:用户能看到字段值,但无法主动编辑。

  • 可编辑:用户可以对自己在该字段中的值进行查看和编辑。

可编辑。

填写扩展字段

创建完新字段,确保字段处于启用状态后,即可使用。

管理员可以来到账户与组织页面,单击创建账户按钮。在弹出的表单上方,即可切换到扩展字段页签,为账户的所有扩展字段指定值。

image.png

用户自服务

若字段的用户侧权限为可见,用户登录自己的门户后,单击我的账户,在扩展信息中即可看到对应字段和值。

若字段的用户侧权限为可编辑,用户可单击字段的修改选项,对选项值进行编辑。

image.png

获取扩展字段

应用可通过3种方式获取账户的扩展字段信息:

字段

说明

Dev/OpenAPI

应用获取任意指定账户的扩展信息,通常为便于同步,属于管理功能。Dev/OpenAPI会返回账户的所有扩展字段信息,无需进行额外配置。详情请参考 接口文档

OIDC SSO账户 id_token/userinfo

OIDC SSO后,应用可获取到当前登录账户的扩展字段内容。

扩展字段默认不在SSO结果中返回。在扩展id_token中,管理员可通过配置将扩展字段信息一并返回。OIDC的Userinfo用户信息端点将和id_token中返回内容一致。

填写格式为user.customFieldMap.$字段key值$.fieldValue

image..png

SAML SSO账户 attribute statements

SAML SSO后,应用可获取到当前登录账户的扩展字段内容。

扩展字段默认不在SSO结果中返回。在断言属性Attribute Statements中支持自定义返回信息,允许将扩展信息在SAMLResponse中一并返回。

image..png