高级账户字段表达式

字段名

数据类型

说明

userId

String

用户ID。

username

String

用户名。

passwordSet

boolean

密码是否已设置。

• true：密码已设置。

• false：密码未设置。

displayName

String

用户显示名。

phoneRegion

String

手机地区编号，示例：中国区号为 "86"，不带 "00" 或 "+"。

phoneNumber

String

手机号。

phoneNumberVerified

boolean

手机号是否已验证。

• true：已验证。

• false：未验证。

email

String

邮箱。

emailVerified

boolean

邮箱是否已验证。

• true：已验证。

• false：未验证。

userExternalId

String

用户外部ID。

userSourceType

String

来源类型，取值为：

• build_in：自建。

• ding_talk：钉钉。

• ad：AD。

• ldap：LDAP。

• we_com：企业微信。

• lark：飞书。

• idp_auto_build：IDP自动创建。

userSourceId

String

来源ID。

status

String

用户状态，取值为：

• enabled：启用。

• disabled：禁用。

accountExpireTime

Long

用户过期时间，UNIX时间戳，单位毫秒。

registerTime

Long

用户注册时间，UNIX时间戳，单位毫秒。

passwordExpireTime

Long

密码过期时间，UNIX时间戳，单位毫秒。

lockExpireTime

Long

锁定过期时间，UNIX时间戳，单位毫秒。

createTime

Long

创建时间，UNIX时间戳，单位毫秒。

updateTime

Long

最近一次更新用户信息的时间，UNIX时间戳，单位毫秒。

description

String

描述。

primaryOrganizationalUnitId

String

主机构ID。

groups

Array

账户所属组列表。

• groupId

String

账户组ID。

• groupName

String

账户组名称。

• description

String

账户组描述。

• groupExternalId

String

账户组外部ID。

organizationalUnits

Array

账户所属组织列表。

• organizationalUnitId

String

所属组织ID。

• organizationalUnitName

String

所属组织名称。

• primary

boolean

是否主组织。

• true：是主组织。

• false：非主组织。

customFields

Array

扩展属性。

• fieldName

String

扩展属性标识。

• fieldValue

String

扩展属性值。

customFieldMap

Map<String,Object>

• key是FieldName。

• value是CustomField对象。

identityProviderUsers

Array

用户在身份提供方的信息。

• identityProviderId

String

身份提供方ID。

• identityProviderType

String

身份提供方类型

ding_talk：钉钉。

ad：AD。

ldap：LDAP。

we_com：企业微信。

lark：飞书。

• identityProviderExternalId

String

身份提供方的外部ID。

• identityProviderUserId

String

用户在身份提供方的UserId。

identityProviderUserMap

Map<String,Object>

key是identityProviderId，

value是IdentityProviderUser对象。

属性

说明

username

应用账号用户名。

函数名

函数定义

说明

举例

Append

Append(str1, str2, ..., strn)

拼接输入参数为新的字符串，等于str1+str2+...。

• 输入：Append("str1", "@example.com")

• 输出： str1@example.com

Join

Join(source1, source2, ..., sourceN, separator)

将多个源值拼接为一个字符串，源值间用分隔符分隔。

• 输入：Join("str1", "str2", 123,"-")

• 输出："str1-str2-123"

Coalesce

Coalesce(source1, source2, ..., sourceN, defaultValue)

返回输入参数中第一个非空参数，若参数都为空，则返回null，其中非空指非null且参数长度大于0。

• 输入：Coalesce("", user.phoneRegion, "86")

• 输出：当手机号区号为空即缺失时，输出为 86

IIF

IIF(condition, whenTrue, whenFalse)

三目运算。根据condition的结果返回不同的值，为true时返回whenTrue，为false时返回whenFalse。

示例1：

• 输入：IIF(true, 1, 2)

• 输出：1

示例2：

• 输入：IIF(false, 1, 2)

• 输出：2

IsNull

IsNull(value)

当value为null即缺失时，输出为true。

示例1：

• 输入：IsNull(null)

• 输出：输出为true

示例2：

• 输入：IsNull("")

• 输出：输出为false

IsNullOrEmpty

IsNullOrEmpty(value)

当value为null或空字符串时，输出为true。

示例1：

• 输入：IsNullOrEmpty(user.email)

• 输出：当邮箱为null即缺失时，输出为true

示例2：

• 输入：IsNullOrEmpty("")

• 输出：输出为true

Now

Now()

返回表示当前UTC DateTime的字符串，格式为 yyyy-MM-dd'T'HH:mm:ssXXX。

• 输出：2021-11 01T09:52:11Z

StringReplace

StringReplace("hello $VariableName", "$VariableName", ReplaceString)

普通字符串替换。

• 输入：StringReplace("hello $str", "$str", "world")

• 输出：hello world

Trim

Trim(source)

去除源值字符串前后的空白字符。

• 输入：Trim(" 123 ")

• 输出：123

TrimLeft

TrimLeft(source)

去除源值字符串左侧的空白字符。

• 输入：TrimLeft(" 123 ")

• 输出：123

TrimRight

TrimRight(source)

去除源值字符串右侧的空白字符。

• 输入：TrimRight(" 123 ")

• 输出： 123

ToLower

ToLower(source)

字符串变为全大写或全小写。

• 输入：ToLower(" Abc ")

• 输出：abc

ToUpper

ToUpper(source)

字符串变为全大写。

• 输入：ToUpper(" Abc ")

• 输出：ABC

Substring

Substring(source, fromIndex, endIndex)

返回字符串的子字符串，即子字符串下标地址为 [fromIndex, endIndex]。

• source：必须，源字符串，可为语法支持的任意类型。

• fromIndex：必须，整数类型。非整型时返回null。

• endIndex：必须，整数类型。非整型时返回null。

示例1：

• 输入：Substring("0123456", 1, 5)

• 输出：1234

示例2：

• 输入：Substring("0123456", -1, 7)

• 输出：0123456

示例3：

• 输入：Substring("0123456", "1", 5)

• 输出：null

SubstringBefore

SubstringBefore(source, subString)

返回源字符串中从左到右匹配到的第一个目标字符串后的字串。若目标字符串不存在，则返回null。

参数：

• source：必须，源字符串，可为语法支持的任意类型。

• target：必须，目标字符串，可为语法支持的任意类型。

返回值：string

示例1：

• 输入：SubstringBefore("test@example@com", "@")

• 输出："test"

Array

Array(source1, source2,...)

将多个值组合成为数组。值可为Object类型。

• 输入: Array(1, 2, 3)

• 输出：[1, 2, 3]

ArrayAdd

ArrayAdd(Array(), "test")

在数组对象中添加一个数组。

• 输入：ArrayAdd(Array(), "test")

• 输出：["test"]

ArrayMap

ArrayMap($ArrayObject, __item.对象属性)

取数组对象中的某个属性的值形成新的数组。

取用户中所属组的id列表

• 输入：ArrayMap(user.groups, __item.groupId)

• 输出：["groupId1","groupId2","groupId3"]

ArrayIndex

ArrayIndex(Array(), n)

取Array第几个元素，从0开始。

• 输入：ArrayIndex(Array(1,2,3), 0)

• 输出：1

ArrayJoin

ArrayJoin(Array(), str)

数组以某个字符串拼接。

• 输入：ArrayJoin(Array(1,2,3), "-")

• 输出："1-2-3"

Object

Object(key1, value1, key2, value2, ...)

通过制定键值对组合成为Object对象。

支持零个或偶数个参数。

• 输入 Object("key1", "value1", "key2", "value2")

• 输出对应对象：

{"key1": "value1", "key2": "value2"}

ObjectIndex

ObjectIndex(user, "username")

指定对象的某个属性的值

代码 ObjectIndex(user, "username") 等价于 user.username

ObjectToJsonString

ObjectToJsonString(user.groups)

对象转JSON字符串。

-

Contains

Contains(str1,str2)

判断是否包含，返回true,false。

示例1：

• 输入：Contains("test", "t")

• 输出：true

示例2：

• 输入：Contains("test", "a")

• 输出：false

Or

Or(true,false,...,true)

或的方式判断多个条件，有一个条件为true，则为true。

示例1：

• 输入：Or(true,false)

• 输出：true

示例2：

• 输入：Or(true,true,false)

• 输出：true

示例3：

• 输入：Or(false,false)

• 输出：false

And

And(true,false,...,true)

且的方式判断多个条件，有一个条件为false，则为false。

示例1：

• 输入：And(true,false)

• 输出：false

示例2：

• 输入：And(true,true,false)

• 输出：false

示例3：

• 输入：And(true,true,true)

• 输出：true

xOr

xOr(true,false,...,true)

有且只能有2个条件。

如果都为true或者都为false,则返回false。

如果同时存在true,false的条件，则返回ture。

示例1：

• 输入：xOr(true,false)

• 输出：true

示例2：

• 输入：xOr(true,true)

• 输出：false

示例3：

• 输入：And(false,false)

• 输出：false

StartsWith

StartsWith(str1, str2)

判断字符串以...开头，只能包含2个参数。

示例1：

• 输入：StartsWith("test", "t")

• 输出：true

示例2：

• 输入：StartsWith("test", "e")

• 输出：false

Split

Split("str1,str2,str3")

字符串分割后，返回一个数组。

示例1：

• 输入：Split("str1,str2,str3",",")

• 输出：Array(str1,str2,str3)

Equals

Equals(str1,str2)

比较2个字符串是否一致。

Equals(str1,str2)。

Equals(str1,str2,false) 不忽略大小写比较。

Equals(str1,str2,true) 忽略大小写比较。

示例1：

• 输入：Equals("test","Test")

• 输出：false

示例2：

• 输入：Equals("test","Test",true)

• 输出：true

示例3：

• 输入：Equals("test","Test",false)

• 输出：false

CurrentTimeMillis

CurrentTimeMillis()

当前时间UNIX时间戳，单位毫秒。

-

SamlArray

SamlArray(Array())

仅SAML SSO可用。

输入：

SamlArray(Array("group1","group2"))

• SAML Response输出：

<saml2:Attribute Name="grouIdArray"

NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">

<saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="xsd:string">

group1

</saml2:AttributeValue>

<saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xsd:string">

group2

</saml2:AttributeValue>

• 输入：SamlArray(Array("group1","group2"))

• SAML Response输出：

</saml2:Attribute>

效果

表达式示例

取用户名，拼接固定 "@example.com"。

Append(user.username, "@example.com")

当邮箱不为空，返回邮箱。

当邮箱为空时，取手机号。

Coalesce(user.email, user.phoneNumber)

当手机号为空时，默认填写固定手机号。

IIF(IsNullOrEmpty(user.phoneNumber), "1888888****", user.phoneNumber)

将手机号地区和手机号以 - 拼接。

Join(user.phoneRegion, user.phoneNumber, "-")

返回包含显示名的自定义欢迎信息。

StringReplace("hello $DisplayName", "$DisplayName", user.displayName)

将手机号中间四位用 * 脱敏返回。

Append(

SubString(user.phoneNumber, 0, 4),

"****",

SubString(user.phoneNumber, 8, 10)

)

提取邮箱中的用户名。

SubstringBefore(user.email, "@")

组装SCIM规范中数组格式的email字段。

Array(Object("email", user.email, "type", "work", "primary", true))