AccountGroupInfo
查询账号组信息列表。
被如下接口引用:DescribeAccountGroup。
| 名称 | 类型 | 描述 |
|---|---|---|
| AccountGroupId | String | 账号组ID。 |
| GroupName | String | 账号组名。 |
| Description | String | 备注。 |
| CreatedDate | String | 创建时间。 |
AccountGroupSearchCriteria
账号组查询参数
被如下接口引用:DescribeAccountGroup, ListAccountInAccountGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Keyword | String | 否 | 关键字 示例值:比赛一组 |
AppAccountInfo
查询账号信息列表。
被如下接口引用:DescribeAppAccount, ListAccountInAccountGroup。
| 名称 | 类型 | 描述 |
|---|---|---|
| AccountId | String | 账号ID。 |
| AccountName | String | 账号名。 注意:此字段可能返回 null,表示取不到有效值。 |
| UserList | Array of LinkUserInfo | 用户信息列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| Description | String | 描述。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreatedDate | String | 创建时间。 注意:此字段可能返回 null,表示取不到有效值。 |
AppAccountSearchCriteria
账号查询参数
被如下接口引用:DescribeAppAccount。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Keyword | String | 否 | 关键字 示例值:张三 |
ApplicationAuthorizationInfo
应用信息列表。
被如下接口引用:ListAuthorizedApplicationsToUser。
| 名称 | 类型 | 描述 |
|---|---|---|
| ApplicationAccounts | Array of String | 用户在被授权应用下对应的账号列表 注意:此字段可能返回 null,表示取不到有效值。 |
| ApplicationId | String | 应用ID,是应用的全局唯一标识。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| InheritedForm | InheritedForm | 展示用户所在的用户组、机构节点拥有该应用的访问权限的ID信息列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| ApplicationName | String | 应用名称。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreatedDate | String | 应用创建时间。 注意:此字段可能返回 null,表示取不到有效值。 |
ApplicationInfoSearchCriteria
应用属性搜索条件。
被如下接口引用:ListApplications。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Keyword | String | 否 | 应用匹配搜索关键字,匹配范围包括:应用名称、应用ID。 |
| ApplicationType | String | 否 | 应用类型。ApplicationType的取值范围有:OAUTH2、JWT、CAS、SAML2、FORM、OIDC、APIGW。 |
ApplicationInformation
应用信息列表。
被如下接口引用:ListApplications。
| 名称 | 类型 | 描述 |
|---|---|---|
| ApplicationId | String | 应用ID,是应用的全局唯一标识。 |
| DisplayName | String | 应用展示名称,长度限制:64个字符。 默认与应用名字相同。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreatedDate | String | 应用创建时间,符合 ISO8601 标准。 注意:此字段可能返回 null,表示取不到有效值。 |
| LastModifiedDate | String | 上次更新时间,符合 ISO8601 标准。 注意:此字段可能返回 null,表示取不到有效值。 |
| AppStatus | Boolean | 应用状态。 注意:此字段可能返回 null,表示取不到有效值。 |
| Icon | String | 应用图标。 注意:此字段可能返回 null,表示取不到有效值。 |
| ApplicationType | String | 应用类型。 注意:此字段可能返回 null,表示取不到有效值。 |
| ClientId | String | 客户端id。 注意:此字段可能返回 null,表示取不到有效值。 |
AuthorizationInfo
返回的授权关系信息。
被如下接口引用:ListApplicationAuthorizations。
| 名称 | 类型 | 描述 |
|---|---|---|
| AppId | String | 应用唯一ID。 |
| AppName | String | 应用名称。 |
| EntityName | String | 类型名称。 |
| EntityId | String | 类型唯一ID。 |
| LastModifiedDate | String | 上次更新时间,符合 ISO8601 标准。 |
| AuthorizationId | String | 授权类型唯一ID。 |
AuthorizationInfoSearchCriteria
用户属性搜索条件。
被如下接口引用:ListApplicationAuthorizations。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Keyword | String | 否 | 名称匹配搜索,当查询类型为用户时,匹配范围包括:用户名称、应用名称;当查询类型为用户组时,匹配范围包括:用户组名称、应用名称;当查询类型为组织机构时,匹配范围包括:组织机构名称、应用名称。 |
AuthorizationResourceEntityInfo
授权资源详情
被如下接口引用:DescribeOrgResourcesAuthorization, DescribeUserGroupResourcesAuthorization。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResourceId | String | 授权关系的唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:6747d37a-616b-4b2f-9b7e-f4c922eb2932 |
| ResourceType | String | 资源授权类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:API |
| Resource | String | 授权的资源 注意:此字段可能返回 null,表示取不到有效值。 示例值:api1 |
| ResourceName | String | 资源名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:用户API |
AuthorizationUserResouceInfo
返回符合条件的用户数据列表
被如下接口引用:DescribeUserResourcesAuthorization。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResourceId | String | 资源ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:8580d166-2a25-45eb-beff-3085f5464deb |
| ResourceType | String | 资源类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:resourceGroup |
| Resource | String | 授权资源 注意:此字段可能返回 null,表示取不到有效值。 示例值:service-888:* |
| InheritedForm | InheritedForm | 继承关系 注意:此字段可能返回 null,表示取不到有效值。 |
| ApplicationAccounts | Array of String | 应用账户 注意:此字段可能返回 null,表示取不到有效值。 |
| ResourceName | String | 资源名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:用户菜单 |
InheritedForm
应用信息列表。
被如下接口引用:DescribeUserResourcesAuthorization, ListAuthorizedApplicationsToUser。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserGroupIds | Array of String | 用户所在的用户组ID列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| OrgNodeIds | Array of String | 用户所在的机构节点ID列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
LinkUserInfo
账号关联的用户信息
被如下接口引用:DescribeAppAccount, ListAccountInAccountGroup。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserId | String | 用户ID,是用户全局唯一标识,长度限制:64个字符。 注意:此字段可能返回 null,表示取不到有效值。 |
| UserName | String | 用户名称。 注意:此字段可能返回 null,表示取不到有效值。 |
ListUsersInOrgNodeSearchCriteria
展示机构下用户的属性搜索条件。
被如下接口引用:ListUsersInOrgNode。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserName | String | 否 | 用户名,长度限制:64个字符。 |
| Phone | String | 否 | 用户手机号。 |
| String | 否 | 用户邮箱。 | |
| Status | String | 否 | 用户状态,取值 NORMAL (正常)、FREEZE (已冻结)、LOCKED (已锁定)或 NOT_ENABLED (未启用)。 |
| CreationTime | String | 否 | 用户创建时间,遵循 ISO 8601 标准。 |
| LastUpdateTime | String | 否 | 用户上次更新时间。 |
| Keyword | String | 否 | 名称匹配搜索,匹配范围包括:用户名称、用户手机号。 |
OrgNodeChildInfo
当前机构节点下的子节点列表
被如下接口引用:DescribeOrgNode。
| 名称 | 类型 | 描述 |
|---|---|---|
| DisplayName | String | 机构节点展示名称,长度限制:64个字符。 默认与机构名相同。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| LastModifiedDate | String | 机构节点最后修改时间,符合 ISO8601 标准。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| CustomizedOrgNodeId | String | 用户自定义可选填的机构节点对外ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| ParentOrgNodeId | String | 当前机构节点的父节点ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| OrgNodeId | String | 机构节点ID,是机构节点的全局唯一标识。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| DataSource | String | 数据来源。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| CreatedDate | String | 机构节点创建时间,符合 ISO8601 标准。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| Description | String | 机构节点描述。 注意:此字段可能返回 null,表示取不到有效值。 |
OrgNodeChildUserInfo
机构子节点下的用户信息列表
被如下接口引用:ListUsersInOrgNode。
| 名称 | 类型 | 描述 |
|---|---|---|
| OrgNodeId | String | 机构ID,是机构节点全局唯一标识,长度限制:64个字符。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| UserInfo | Array of UserInfo | 用户信息列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| TotalUserNum | Integer | 当前机构节点下的用户总数。 注意:此字段可能返回 null,表示取不到有效值。 |
| OrgNodeIdPath | String | 组织机构ID路径。 注意:此字段可能返回 null,表示取不到有效值。 |
| OrgNodeNamePath | String | 组织机构名称路径。 注意:此字段可能返回 null,表示取不到有效值。 |
SortCondition
排序条件。
被如下接口引用:ListApplicationAuthorizations, ListApplications, ListUserGroups, ListUserGroupsOfUser, ListUsers, ListUsersInOrgNode, ListUsersInUserGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SortKey | String | 是 | 排序属性。 |
| SortOrder | String | 是 | 排序顺序,ASC为正向排序,DESC为反向排序。 |
ThirdPartyAccountInfo
三方账号信息。
被如下接口引用:DescribeUserThirdPartyAccountInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| AccountCode | String | 第三方账号代码。"2"代表企业微信。 注意:此字段可能返回 null,表示取不到有效值。 |
| AccountName | String | 账号对应的用户名。 注意:此字段可能返回 null,表示取不到有效值。 |
UserGroupInfo
返回的用户组列表。
被如下接口引用:ListUserGroupsOfUser。
| 名称 | 类型 | 描述 |
|---|---|---|
| DisplayName | String | 昵称,长度限制:64个字符。 默认与用户名相同。 注意:此字段可能返回 null,表示取不到有效值。 |
| UserGroupId | String | 用户组ID,是用户组全局唯一标识,长度限制:64个字符。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| Description | String | 用户组备注。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreatedDate | String | 创建时间。 注意:此字段可能返回 null,表示取不到有效值。 |
UserGroupInfoSearchCriteria
用户组属性搜索条件。
被如下接口引用:ListUserGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Keyword | String | 否 | 名称匹配搜索,匹配范围包括:用户组名称、用户组ID。 |
UserGroupInformation
返回的用户组列表。
被如下接口引用:ListUserGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserGroupId | String | 用户组ID。 |
| UserGroupName | String | 用户组名称。 |
| LastModifiedDate | String | 上次更新时间,符合 ISO8601 标准。 注意:此字段可能返回 null,表示取不到有效值。 |
UserGroupInformationSearchCriteria
获取用户所在的用户组列表功能中用户组属性搜索条件。
被如下接口引用:ListUserGroupsOfUser。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Keyword | String | 否 | 名称匹配搜索,匹配范围包括:用户组名称。 |
UserInfo
用户信息列表。
被如下接口引用:ListUsersInOrgNode, ListUsersInUserGroup。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserId | String | 用户ID,是用户全局唯一标识,长度限制:64个字符。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
| DisplayName | String | 昵称,长度限制:64个字符。 默认与用户名相同。 注意:此字段可能返回 null,表示取不到有效值。 |
| UserName | String | 用户名称。 注意:此字段可能返回 null,表示取不到有效值。 |
| Phone | String | 用户手机号。 注意:此字段可能返回 null,表示取不到有效值。 |
| String | 邮箱地址。 注意:此字段可能返回 null,表示取不到有效值。 |
|
| Status | String | 用户状态。 注意:此字段可能返回 null,表示取不到有效值。 |
| DataSource | String | 数据来源。 注意:此字段可能返回 null,表示取不到有效值。 |
UserInformation
用户信息列表。
被如下接口引用:ListUsers。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserName | String | 用户名,长度限制:32个字符。 注意:此字段可能返回 null,表示取不到有效值。 |
| Status | String | 用户状态。 注意:此字段可能返回 null,表示取不到有效值。 |
| DisplayName | String | 昵称,长度限制:64个字符。 默认与用户名相同。 注意:此字段可能返回 null,表示取不到有效值。 |
| Description | String | 用户备注,长度限制:512个字符。 注意:此字段可能返回 null,表示取不到有效值。 |
| LastUpdateTime | String | 用户上次更新时间,遵循 ISO 8601 标准。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreationTime | String | 用户创建时间,遵循 ISO 8601 标准。 注意:此字段可能返回 null,表示取不到有效值。 |
| OrgPath | String | 用户所属主组织机构的路径ID。 注意:此字段可能返回 null,表示取不到有效值。 |
| Phone | String | 带国家号的用户手机号,例如+86-00000000000。 注意:此字段可能返回 null,表示取不到有效值。 |
| SubjectGroups | Array of String | 用户所属用户组ID列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| String | 用户邮箱。 注意:此字段可能返回 null,表示取不到有效值。 |
|
| LastLoginTime | String | 用户上次登录时间,遵循 ISO 8601 标准。 注意:此字段可能返回 null,表示取不到有效值。 |
| UserId | String | 用户ID,是用户全局唯一标识,长度限制:64个字符。 注意:此字段可能返回 null,表示取不到有效值。 |
UserSearchCriteria
用户属性搜索条件。
被如下接口引用:ListUsers, ListUsersInUserGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserName | String | 否 | 用户名,长度限制:64个字符。 |
| Phone | String | 否 | 用户手机号。 |
| String | 否 | 用户邮箱。 | |
| Status | String | 否 | 用户状态,取值 NORMAL (正常)、FREEZE (已冻结)、LOCKED (已锁定)或 NOT_ENABLED (未启用)。 |
| CreationTime | String | 否 | 用户创建时间,遵循 ISO 8601 标准。 |
| LastUpdateTime | String | 否 | 用户上次更新时间区间。 |
| Keyword | String | 否 | 名称匹配搜索,匹配范围包括:用户名称、用户ID。 |