| AccessibleAppsDto |
|
| AccessTokenResDto |
|
| ActionAuth |
|
| AddDepartmentMembersReqDto.DepartmentIdType |
此次调用中使用的部门 ID 的类型
|
| AddTenantDepartmentMembersReqDto.DepartmentIdType |
此次调用中使用的部门 ID 的类型
|
| AdminAuditLogDto |
|
| AdminAuditLogDto.OperationType |
操作类型：
- `create`: 创建
- `delete`: 删除
- `import`: 导入
- `export`: 导出
- `update`: 修改
- `refresh`: 刷新
- `sync`: 同步
- `invite`: 邀请
- `resign`: 离职
- `recover`: 恢复
- `disable`: 禁用
- `userEnable`: 启用
|
| AdminAuditLogDto.ResourceType |
事件类型：
- `user`: 用户
- `userpool`: 用户池
- `tenant`: 租户
- `userLoginState`: 用户登录态
- `userAccountState`: 用户账号状态
- `userGroup`: 用户分组
- `fieldEncryptState`: 字段加密状态
- `syncTask`: 同步任务
- `socialConnection`: 社会化身份源
- `enterpriseConnection`: 社会化身份源
- `customDatabase`: 自定义数据库
- `org`: 组织机构
- `cooperator`: 协作管理员
- `application`: 应用
- `resourceNamespace`: 权限分组
- `resource`: 资源
- `role`: 角色
- `roleAssign`: 角色授权
- `policy`: 策略
|
| AdminAuditLogRespData |
|
| AliExmailEmailProviderConfig |
|
| AliExmailEmailProviderConfigInput |
|
| AlipayAuthInfoDataDto |
|
| Any |
|
| AppDto |
|
| AppDto.AppDefaultLoginStrategy |
App 默认的登录策略
|
| ApplicationAgreementDto |
|
| ApplicationAgreementDto.Lang |
此协议针对什么语言有效:
- `zh-CN`: 简体中文
- `zh-TW`: 繁体中文
- `en-US`: 英文
- `ja-JP`: 日语
|
| ApplicationBrandingConfig |
|
| ApplicationBrandingConfig.DefaultLanguage |
默认语言:
- `zh-CN`: 简体中文
- `zh-TW`: 繁体中文
- `en-US`: 英文
- `ja-JP`: 日语
|
| ApplicationBrandingConfig.GuardVersion |
Guard 版本：
- `Advanced`: 高级版
- `Classical`: 经典版
|
| ApplicationBrandingConfigInputDto |
|
| ApplicationBrandingConfigInputDto.DefaultLanguage |
展示的默认语言：
- `zh-CN`: 简体中文
- `zh-TW`: 繁体中文
- `en-US`: 英文
- `ja-JP`: 日语
默认情况下，Authing 登录页会根据用户浏览器语言自动渲染。
|
| ApplicationBrandingConfigInputDto.GuardVersion |
Guard 版本：
- `Advanced`: 高级版
- `Classical`: 经典版
|
| ApplicationDefaultLoginMethod |
|
| ApplicationDefaultLoginMethod.ConnectionType |
默认的登录类型
- `PASSWORD`: 密码类型，取决于你开启的基础登录方式，支持手机号/邮箱/用户名 + 密码进行登录
- `PASSCODE`: 验证码类型，取决于你开启的基础登录方式，支持手机号/邮箱 + 验证码进行登录
- `QRCODE`: 扫码登录类型，目前包含自建 APP 扫码登录、关注微信公众号扫码登录、微信小程序扫码登录三种类型
|
| ApplicationDefaultLoginMethod.QrcodeType |
当 `connectionType` 为 `QRCODE` 时，此参数表示二维码类型。
|
| ApplicationDefaultLoginMethodInput |
|
| ApplicationDefaultLoginMethodInput.ConnectionType |
默认的登录类型
- `PASSWORD`: 密码类型，取决于你开启的基础登录方式，支持手机号/邮箱/用户名 + 密码进行登录
- `PASSCODE`: 验证码类型，取决于你开启的基础登录方式，支持手机号/邮箱 + 验证码进行登录
- `QRCODE`: 扫码登录类型，目前包含自建 APP 扫码登录、关注微信公众号扫码登录、微信小程序扫码登录三种类型
|
| ApplicationDefaultLoginMethodInput.QrcodeType |
当 `connectionType` 为 `QRCODE` 时，此参数表示二维码类型。
|
| ApplicationDto |
|
| ApplicationDto.AppType |
应用类型
|
| ApplicationDto.DefaultProtocol |
默认应用协议类型
|
| ApplicationEnabledExtIdpConnDto |
|
| ApplicationEnabledExtIdpConnDto.ExtIdpConnType |
身份源连接类型
|
| ApplicationEnabledExtIdpConnDto.ExtIdpType |
身份源类型
|
| ApplicationEnabledExtIdpConnInputDto |
|
| ApplicationLoginConfigDto |
|
| ApplicationLoginConfigInputDto |
|
| ApplicationPaginatedDataDto |
|
| ApplicationPermissionRecordItem |
|
| ApplicationPermissionRecordItem.Effect |
授权作用，允许或拒绝
|
| ApplicationPermissionRecordItem.TargetType |
主体类型
|
| ApplicationRegisterConfig |
|
| ApplicationRegisterConfig.DefaultRegisterMethod |
默认的注册类型
- `PASSWORD`: 密码类型，支持邮箱 + 密码进行登录
- `PASSCODE`: 验证码类型，取决于你开启的注册方式，支持手机号/邮箱 + 验证码进行登录
|
| ApplicationRegisterConfigInputDto |
|
| ApplicationRegisterConfigInputDto.DefaultRegisterMethod |
默认的注册类型
- `PASSWORD`: 密码类型，支持邮箱 + 密码进行登录
- `PASSCODE`: 验证码类型，取决于你开启的注册方式，支持手机号/邮箱 + 验证码进行登录
|
| ApplicationSimpleInfoDto |
|
| ApplicationSimpleInfoDto.AppType |
应用类型
|
| ApplicationSimpleInfoPaginatedDataDto |
|
| AppQRCodeLoginDto.Action |
APP 扫二维码登录:
- `APP_LOGIN`: APP 扫码登录；
|
| ArchivedUsersListPagingDto |
|
| ArrayAuthorize |
|
| ArrayOrStringActionDto |
|
| ArrResourceAuthAction |
|
| AsaAccountDto |
|
| AsaAccountPaginatedDataDto |
|
| AsaAccountTargetDto |
|
| AsaAccountTargetDto.TargetType |
目标对象类型：
- `USER`: 用户
- `ROLE`: 角色
- `GROUP`: 分组
- `DEPARTMENT`: 部门
|
| AssignAsaAccountItem |
|
| AssignAsaAccountItem.TargetType |
目标对象类型：
- `USER`: 用户
- `ROLE`: 角色
- `GROUP`: 分组
- `DEPARTMENT`: 部门
|
| AuthenticateByADDto |
|
| AuthenticateByAlipayDto |
|
| AuthenticateByLarkInternalDto |
|
| AuthenticateByLarkPublicDto |
|
| AuthenticateByLDAPDto |
|
| AuthenticateByPassCodeDto |
|
| AuthenticateByPasswordDto |
|
| AuthenticateByWechatDto |
|
| AuthenticateByWechatMiniProgramCodeDto |
|
| AuthenticateByWechatMiniProgramPhoneDto |
|
| AuthenticateByWechatworkAgencyDto |
|
| AuthenticateByWechatworkDto |
|
| AuthenticateByYidunDto |
|
| AuthenticationCredentialDto |
|
| AuthenticationOptionsDto |
|
| AuthenticatorAssertionResponseDto |
|
| AuthenticatorAttestationResponseDto |
|
| AuthEnvParams |
|
| AuthEnvParams.BrowserType |
浏览器类型：IE/Chrome/Firefox
|
| AuthEnvParams.DeviceType |
设备类型：PC/Mobile
|
| AuthEnvParams.SystemType |
操作类型：Windows、Android、iOS、MacOS
|
| AuthorizedResourceDto |
|
| AuthorizedResourceDto.Effect |
允许还是拒绝
|
| AuthorizedResourceDto.ResourceType |
资源类型
|
| AuthorizedResourcePagingDto |
|
| AuthorizeResourceItem |
|
| AuthorizeResourceItem.TargetType |
目标对象类型：
- `USER`: 用户
- `ROLE`: 角色
- `GROUP`: 分组
- `DEPARTMENT`: 部门
|
| CancelSyncRiskOperationsDataDto |
|
| CasIdPConfig |
|
| ChangeEmailStrategyDto |
|
| ChangePhoneStrategyDto |
|
| ChangePushCodeStatusDto.Action |
修改推送码状态的动作:
- `CONFIRM`: 修改推送码状态为已授权；
- `CANCEL`: 修改推送码状态为已取消；
|
| ChangeQRCodeStatusDto.Action |
修改二维码状态的动作:
- `SCAN`: 修改二维码状态为已扫码状态，当移动 APP 扫了码之后，应当立即执行此操作；
- `CONFIRM`: 修改二维码状态为已授权，执行此操作前必须先执行 `SCAN 操作；
- `CANCEL`: 修改二维码状态为已取消，执行此操作前必须先执行 `SCAN 操作；
|
| CheckDomainAvailableDataDto |
|
| CheckExternalUserPermissionDataDto |
|
| CheckExternalUserPermissionsRespDto |
|
| CheckNamespaceParamsRespDto |
|
| CheckParamsDataPolicyRespDto |
|
| CheckParamsDataResourceRespDto |
|
| CheckPermissionDataDto |
|
| CheckPermissionNamespaceExistsRespDto |
|
| CheckPermissionsRespDto |
|
| CheckPushCodeStatusDataDto |
|
| CheckPushCodeStatusDataDto.Status |
推送码状态。
|
| CheckQRCodeStatusDataDto |
|
| CheckQRCodeStatusDataDto.Status |
二维码状态。
|
| CheckResourcePermissionDataDto |
|
| CheckResourcePermissionRespDto |
|
| CheckRoleParamsRespDto |
|
| CheckSessionStatusDataDto |
|
| CheckUserSameLevelPermissionDataDto |
|
| CheckUserSameLevelPermissionRespDto |
|
| CommonResourceDto |
|
| CommonResourceDto.Type |
资源类型，如数据、API、按钮、菜单
|
| CommonResourcePagingDto |
|
| ConfigEmailProviderDto.Type |
第三方邮件服务商类型:
- `custom`: 自定义 SMTP 邮件服务
- `ali`: [阿里企业邮箱](https://www.ali-exmail.cn/Land/)
- `qq`: [腾讯企业邮箱](https://work.weixin.qq.com/mail/)
- `sendgrid`: [SendGrid 邮件服务](https://sendgrid.com/)
|
| CookieSettingsDto |
|
| CostCurrentPackageInfo |
|
| CostGetOrderPayDetail |
|
| CountryDetailInfo |
|
| CreateAccessKeyRespDto |
|
| CreateApplicationDto.AppType |
应用类型
|
| CreateApplicationDto.DefaultProtocol |
默认应用协议类型
|
| CreateApplicationRespDataDto |
|
| CreateApplicationRespDataDto.AppType |
应用类型
|
| CreateApplicationRespDataDto.DefaultProtocol |
默认应用协议类型
|
| CreateArrayDataResourceRespDto |
|
| CreateArrayDataResourceRespDto.Type |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| CreateAsaAccountsBatchItemDto |
|
| CreateDataPolicyRespDto |
|
| CreateDataResourceDto.Type |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| CreateDataResourceRespDto |
|
| CreateDataResourceRespDto.Type |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| CreateDepartmentReqDto.DepartmentIdType |
此次调用中使用的父部门 ID 的类型
|
| CreateExtIdpConnDto.Type |
身份源连接类型
|
| CreateExtIdpDto.Type |
身份源连接类型
|
| CreateGroupReqDto |
|
| CreateIdentityDto |
|
| CreateIdentityDto.Provider |
外部身份源类型：
- `wechat`: 微信
- `qq`: QQ
- `wechatwork`: 企业微信
- `dingtalk`: 钉钉
- `weibo`: 微博
- `github`: GitHub
- `alipay`: 支付宝
- `baidu`: 百度
- `lark`: 飞书
- `welink`: Welink
- `yidun`: 网易易盾
- `qingcloud`: 青云
- `google`: Google
- `gitlab`: GitLab
- `gitee`: Gitee
- `twitter`: Twitter
- `facebook`: Facebook
- `slack`: Slack
- `linkedin`: Linkedin
- `instagram`: Instagram
- `oidc`: OIDC 型企业身份源
- `oauth2`: OAuth2 型企业身份源
- `saml`: SAML 型企业身份源
- `ldap`: LDAP 型企业身份源
- `ad`: AD 型企业身份源
- `cas`: CAS 型企业身份源
- `azure-ad`: Azure AD 型企业身份源
|
| CreateNamespacesBatchItemDto |
|
| CreatePermissionNamespaceRespDto |
|
| CreatePermissionNamespacesBatchItemDto |
|
| CreatePipelineFunctionDto.Scene |
函数的触发场景：
- `PRE_REGISTER`: 注册前
- `POST_REGISTER`: 注册后
- `PRE_AUTHENTICATION`: 认证前
- `POST_AUTHENTICATION`: 认证后
- `PRE_OIDC_ID_TOKEN_ISSUED`: OIDC ID Token 签发前
- `PRE_OIDC_ACCESS_TOKEN_ISSUED`: OIDC Access Token 签发前
- `PRE_COMPLETE_USER_INFO`: 补全用户信息前
|
| CreateResourceBatchItemDto |
|
| CreateResourceBatchItemDto.Type |
资源类型，如数据、API、按钮、菜单
|
| CreateResourceDto.Type |
资源类型，如数据、API、按钮、菜单
|
| CreateStringDataResourceRespDto |
|
| CreateStringDataResourceRespDto.Type |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| CreateSyncTaskDto.SyncTaskFlow |
同步任务数据流向：
- `upstream`: 作为上游，将数据同步到 Authing
- `downstream`: 作为下游，将 Authing 数据同步到此系统
|
| CreateSyncTaskDto.SyncTaskTrigger |
同步任务触发类型：
- `manually`: 手动触发执行
- `timed`: 定时触发
- `automatic`: 根据事件自动触发
|
| CreateSyncTaskDto.SyncTaskType |
同步任务类型:
- `lark`: 飞书
- `lark-international`: 飞书国际版
- `wechatwork`: 企业微信
- `dingtalk`: 钉钉
- `active-directory`: Windows AD
- `ldap`: LDAP
- `italent`: 北森
- `maycur`: 每刻报销
- `moka`: Moka
- `fxiaoke`: 纷享销客
- `xiaoshouyi`: 销售易
- `kayang`: 嘉扬 HR
- `scim`: 自定义同步源
|
| CreateTenantUserOptionsDto |
|
| CreateTenantUserOptionsDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| CreateTenantUserReqDto.Gender |
性别:
- `M`: 男性，`male`
- `F`: 女性，`female`
- `U`: 未知，`unknown`
|
| CreateTreeDataResourceRespDto |
|
| CreateTreeDataResourceRespDto.Type |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| CreateUserInfoDto |
|
| CreateUserInfoDto.Gender |
性别
|
| CreateUserInfoDto.Status |
账户当前状态
|
| CreateUserOptionsDto |
|
| CreateUserOptionsDto.DepartmentIdType |
此次调用中使用的父部门 ID 的类型
|
| CreateUserOptionsDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| CreateUserOtpDto |
|
| CreateUserReqDto.Gender |
性别
|
| CreateUserReqDto.Status |
账户当前状态
|
| CreateWebhookDto.ContentType |
请求数据格式
|
| CurrentUsageDto |
|
| CurrentUsageRespDto |
|
| CustomFieldDto |
|
| CustomFieldDto.DataType |
数据类型，**设置之后将不能进行修改**。
|
| CustomFieldDto.TargetType |
目标对象类型：
- `USER`: 用户
- `ROLE`: 角色
- `GROUP`: 分组
- `DEPARTMENT`: 部门
|
| CustomFieldI18n |
|
| CustomFieldSelectOption |
|
| DataPermissionRespDto.ResourceType |
数据权限所属的数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| DataPoliciesPaginatedRespDto |
|
| DataPoliciesSimplePaginatedRespDto |
|
| DataResourceActionListDto |
|
| DataResourcePolicyTreeStructs |
|
| DataResourceSimpleRespDto |
|
| DataResourcesPaginatedRespDto |
|
| DataResourceTreeStructs |
|
| DataStatementPermissionDto |
|
| DataStatementPermissionDto.Effect |
数据资源权限操作：ALLOW（允许）/DENY（拒绝）
|
| DataSubjectRespDto |
|
| DataSubjectRespDto.TargetType |
主体类型,包括 USER、GROUP、ROLE、ORG 四种类型
|
| DeleteAccountByEmailPassCodeDto |
|
| DeleteAccountByPasswordDto |
|
| DeleteAccountByPasswordDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| DeleteAccountByPhonePassCodeDto |
|
| DeleteApplicationPermissionRecordItem |
|
| DeleteApplicationPermissionRecordItem.TargetType |
主体类型
|
| DeleteAuthorizeDataPolicyDto.TargetType |
主体类型,包括 USER、GROUP、ROLE、ORG 四种类型
|
| DeleteDepartmentReqDto.DepartmentIdType |
此次调用中使用的部门 ID 的类型
|
| DeleteUsersBatchOptionsDto |
|
| DeleteUsersBatchOptionsDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| DepartmentDto |
|
| DepartmentI18nDto |
|
| DepartmentPagingDto |
|
| EmailProviderDto |
|
| EmailProviderDto.Type |
第三方邮件服务商类型:
- `custom`: 自定义 SMTP 邮件服务
- `ali`: [阿里企业邮箱](https://www.ali-exmail.cn/Land/)
- `qq`: [腾讯企业邮箱](https://work.weixin.qq.com/mail/)
- `sendgrid`: [SendGrid 邮件服务](https://sendgrid.com/)
|
| EmailTemplateCategoryDto |
|
| EmailTemplateDto |
|
| EmailTemplateDto.TplEngine |
模版渲染引擎。
|
| EmailTemplateDto.Type |
模版类型:
- `WELCOME_EMAIL`: 欢迎邮件
- `FIRST_CREATED_USER`: 首次创建用户通知
- `REGISTER_VERIFY_CODE`: 注册验证码
- `LOGIN_VERIFY_CODE`: 登录验证码
- `MFA_VERIFY_CODE`: MFA 验证码
- `INFORMATION_COMPLETION_VERIFY_CODE`: 注册信息补全验证码
- `FIRST_EMAIL_LOGIN_VERIFY`: 首次邮箱登录验证
- `CONSOLE_CONDUCTED_VERIFY`: 在控制台发起邮件验证
- `USER_PASSWORD_UPDATE_REMIND`: 用户到期提醒
- `ADMIN_RESET_USER_PASSWORD_NOTIFICATION`: 管理员重置用户密码成功通知
- `USER_PASSWORD_RESET_NOTIFICATION`: 用户密码重置成功通知
- `RESET_PASSWORD_VERIFY_CODE`: 重置密码验证码
- `SELF_UNLOCKING_VERIFY_CODE`: 自助解锁验证码
- `EMAIL_BIND_VERIFY_CODE`: 绑定邮箱验证码
- `EMAIL_UNBIND_VERIFY_CODE`: 解绑邮箱验证码
|
| EnrollFactorDto.FactorType |
MFA 认证要素类型：
- `OTP`: OTP
- `SMS`: 短信
- `EMAIL`: 邮件
- `FACE`: 人脸
|
| EnrollFactorEnrollmentDataDto |
|
| errorEmailMsg |
|
| EventAppDto |
|
| EventAppPagingDto |
|
| ExtIdpConnDetail |
|
| ExtIdpConnDetail.AssociationMode |
账号关联模式
|
| ExtIdpConnDetail.Type |
身份源连接类型
|
| ExtIdpDetail |
|
| ExtIdpDto |
|
| ExtIdpInfoDto |
|
| ExtIdpInfoDto.ExtIdpType |
认证类型
|
| ExtIdpInfoDto.Type |
身份源类型
|
| ExtIdpListPagingDto |
|
| FactorDto |
|
| FactorDto.FactorType |
MFA 认证要素类型
|
| FactorProfile |
|
| FactorToEnrollDto |
|
| FactorToEnrollDto.FactorType |
MFA Factor 类型
|
| FastpassQRCodeRelationAppDto |
|
| FastpassUserInfoDto |
|
| GeneFastpassQRCodeInfoDto |
|
| GenePushCodeDataDto |
|
| GeneQRCodeDataDto |
|
| GenerateBindExtIdpLinkDataDto |
|
| GenerateQrcodeDto.Type |
二维码类型。
|
| GeoIp |
|
| GeoIpLocation |
|
| GetAccessKeyRespDto |
|
| GetApplicationPermissionStrategyDataDto |
|
| GetApplicationPermissionStrategyDataDto.PermissionStrategy |
应用访问授权策略
|
| GetApplicationSecretDataDto |
|
| GetAsaAccountAssignedTargetDataDto |
|
| GetAuthorizedResourceActionDto |
|
| GetAuthorizedResourceActionDto.Op |
AND or OR
|
| GetAuthorizedTargetDataDto |
|
| GetAuthorizedTargetsDto.ResourceType |
资源类型
|
| GetAuthorizedTargetsDto.TargetType |
主体类型
|
| GetDataPolicyRespDto |
|
| GetDataResourceRespDto |
|
| GetDataResourceRespDto.Type |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| GetEmailTemplatesDataDto |
|
| GetExternalUserResourceStructDataDto |
|
| GetExternalUserResourceStructDataDto.ResourceType |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）三种类型，根据不同的类型返回不同的结构。
|
| GetFastpassQRCodeRelationAppsDto |
|
| GetOrdersRes |
|
| GetPermissionNamespaceRespDto |
|
| GetPushCodeRelationAppsDataDto |
|
| GetResourceAuthorizedTargetDataDto |
|
| GetResourceAuthorizedTargetsDto.TargetType |
目标对象类型：
- `USER`: 用户
- `ROLE`: 角色
- `GROUP`: 分组
- `DEPARTMENT`: 部门
|
| GetSecurityInfoDto |
|
| GetSubjectAuthDataDto |
|
| GetSubjectAuthDataDto.AuthType |
授权类型
|
| GetSubjectAuthDataDto.ReqTargetType |
请求的主体类型
|
| GetSubjectAuthDataDto.TargetType |
目标主体类型
|
| GetUserAuthResourceListDataDto |
|
| GetUserAuthResourcePermissionList |
|
| GetUserAuthResourcePermissionListDataDto |
|
| GetUserAuthResourceStructDataDto |
|
| GetUserAuthResourceStructDataDto.ResourceType |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）三种类型，根据不同的类型返回不同的结构。
|
| GetUserPasswordCiphertextDataDto |
|
| GetUserPasswordCiphertextDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| GetUserPermissionListDataDto |
|
| GetUserResourcePermissionList |
|
| GetUserResourcePermissionListDataDto |
|
| GetUserResourceStructDataDto |
|
| GetUserResourceStructDataDto.ResourceType |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）三种类型，根据不同的类型返回不同的结构。
|
| GetWebhooksData |
|
| GetWechatAccessTokenDataDto |
|
| GetWechatMiniProgramPhoneDataDto |
|
| GoodsPackageDto |
|
| GroupDto |
|
| GroupPagingDto |
|
| HasAnyRoleDto |
|
| HasAnyRoleOptionsDto |
|
| HasAnyRoleOptionsDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| HasRoleRolesDto |
|
| IdentityDto |
|
| IdentityDto.Provider |
外部身份源类型：
- `wechat`: 微信
- `qq`: QQ
- `wechatwork`: 企业微信
- `dingtalk`: 钉钉
- `weibo`: 微博
- `github`: GitHub
- `alipay`: 支付宝
- `baidu`: 百度
- `lark`: 飞书
- `welink`: Welink
- `yidun`: 网易易盾
- `qingcloud`: 青云
- `google`: Google
- `gitlab`: GitLab
- `gitee`: Gitee
- `twitter`: Twitter
- `facebook`: Facebook
- `slack`: Slack
- `linkedin`: Linkedin
- `instagram`: Instagram
- `oidc`: OIDC 型企业身份源
- `oauth2`: OAuth2 型企业身份源
- `saml`: SAML 型企业身份源
- `ldap`: LDAP 型企业身份源
- `ad`: AD 型企业身份源
- `cas`: CAS 型企业身份源
- `azure-ad`: Azure AD 型企业身份源
|
| ImportOtpItemDataDto |
|
| ImportOtpItemDto |
|
| InviteTenantUserRecord |
|
| InviteTenantUserRecordListDto |
|
| InviteTenantUsersDto |
|
| IsActionAllowedDataDto |
|
| ISsoPageCustomizationSettingsDto |
|
| IsSuccessDto |
|
| IsUserExistsDto |
|
| IsUserInDepartmentDataDto |
|
| KickUsersOptionsDto |
|
| KickUsersOptionsDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| LangObject |
|
| LanguageCoinfigDto |
|
| LanguageCoinfigGlobalDto |
|
| LangUnit |
|
| ListAccessKeyRespDto |
|
| ListApplicationActiveUsersOptionsDto |
|
| ListApplicationAuthDataDto |
|
| ListApplicationAuthDataDto.Effect |
主体类型，ALLOW/DENY
|
| ListApplicationAuthDataDto.PermissionType |
授权类型, ALL:所有人 SUBJECT:主体
|
| ListApplicationAuthDataDto.TargetType |
主体类型，USER/ORG/GROUP/ROLE
|
| ListApplicationAuthDto.Effect |
操作，ALLOW/DENY
|
| ListApplicationAuthPaginatedDataDto |
|
| ListApplicationSubjectDataDto |
|
| ListApplicationSubjectDataDto.AppType |
应用类型：集成应用/自建应用
|
| ListApplicationSubjectDataDto.Effect |
允许/拒绝
|
| ListApplicationSubjectDataListDto |
|
| ListArchivedUsersRespDto |
|
| ListAuthSubjectDto.TargetType |
主体类型
|
| ListDataPoliciesRespDto |
|
| ListDataPolicySubjectPageDto |
|
| ListDataResourcesRespDto |
|
| ListDataResourcesRespDto.Type |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| ListResourceTargetsDataDto |
|
| ListResourceTargetsDtoResp |
|
| ListRoleAssignmentsDto |
|
| ListSimpleDataPoliciesRespDto |
|
| ListTenantUsersOptionsDto |
|
| ListUsersAdvancedFilterItemDto |
|
| ListUsersAdvancedFilterItemDto.Operator |
运算符，可选值为：
- `EQUAL`: 全等，适用于数字和字符串的全等匹配
- `NOT_EQUAL`: 不等于，适用于数字和字符串的匹配
- `CONTAINS`: 字符串包含
- `NOT_CONTAINS`: 字符串不包含
- `IS_NULL`: 为空
- `NOT_NULL`: 不为空
- `IN`: 为某个数组中的元素
- `GREATER`: 大于或等于，适用于数字、日期类型数据的比较
- `LESSER`: 小于或等于，适用于数字、日期类型数据的比较
- `BETWEEN`: 介于什么什么之间，适用于数字、日期类型数据的比较
|
| ListUsersOptionsDto |
|
| ListWebhookLogsData |
|
| ListWebhooksDto |
|
| LoggedInAppsDto |
|
| LoginAnomalyDetectionConfigDto |
|
| LoginAnomalyDetectionConfigDto.LoginFailStrategy |
登录安全策略。
|
| LoginByCredentialsDto.Connection |
认证方式：
- `PASSWORD`: 使用密码方式进行认证。
|
| LoginFailCheckConfigDto |
|
| LoginHistoryDto |
|
| LoginHistoryPaginatedRespDto |
|
| LoginIpWhitelistCheckConfigDto |
|
| LoginPassowrdFailCheckConfigDto |
|
| LoginTokenResponseDataDto |
|
| MauPeriodUsageHistory |
|
| MauPeriodUsageHistoryDto |
|
| MFASettingsDto |
|
| MobileSignInDto.Connection |
移动端社会化登录类型：
- `wechat`: 微信移动应用
- `alipay`: 支付宝移动应用
- `wechatwork`: 企业微信移动应用
- `wechatwork_agency`: 企业微信移动应用（代开发模式）
- `lark_internal`: 飞书移动端企业自建应用
- `lark_public`: 飞书移动端应用商店应用
- `yidun`: 网易易盾一键登录
- `wechat_mini_program_code`: 微信小程序使用 code 登录
- `wechat_mini_program_phone `: 微信小程序使用手机号登录
|
| MultipleTenantAdminDto |
|
| MultipleTenantAdminListPagingDto |
|
| NamespaceDto |
|
| NamespaceListPagingDto |
|
| NamespaceRolesListRespDto |
|
| NamespacesListRespDto |
|
| OauthIdpConfig |
|
| OIDCConfig |
|
| OpenEventDto |
|
| OpenEventPagingDto |
|
| OpenResource |
|
| OpenResource.ResourceType |
数据策略下所授权的数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）三种类型，根据不同的类型返回不同的结构。
|
| OrderItem |
|
| OrganizationDto |
|
| OrganizationNameI18nDto |
|
| OrganizationPagingDto |
|
| OtpSecretRespDto |
|
| OtpVerityRespDto |
|
| PaginationDto |
|
| ParsedUserAgent |
|
| PermissionNamespaceListPagingDto |
|
| PermissionNamespaceRolesListPagingDto |
|
| PermissionNamespaceRolesListRespDto |
|
| PermissionNamespacesListRespDto |
|
| PipelineFunctionDto |
|
| PipelineFunctionDto.Scene |
函数的触发场景：
- `PRE_REGISTER`: 注册前
- `POST_REGISTER`: 注册后
- `PRE_AUTHENTICATION`: 认证前
- `POST_AUTHENTICATION`: 认证后
- `PRE_OIDC_ID_TOKEN_ISSUED`: OIDC ID Token 签发前
- `PRE_OIDC_ACCESS_TOKEN_ISSUED`: OIDC Access Token 签发前
- `PRE_COMPLETE_USER_INFO`: 补全用户信息前
|
| PipelineFunctionDto.Status |
函数当前状态：
- `uploading`: 上传中
- `success`: 上传成功
- `failed`: 上传失败
|
| PipelineFunctionPagingDto |
|
| PolicyCondition |
|
| PolicyCondition.Operator |
Condition Operator
|
| PolicyCondition.Param |
Condition Param
|
| PostDto |
|
| PostInfoDto |
|
| PostItemDto |
|
| PostPagingDto |
|
| PreCheckCodeDataDto |
|
| PreCheckCodeDto.CodeType |
验证码类型
|
| PreCheckEmailCodeDto |
|
| PreCheckEmailCodeDto.Channel |
短信通道，指定发送此短信的目的，如 CHANNEL_LOGIN 用于登录、CHANNEL_REGISTER 用于注册。
|
| PreCheckSmsCodeDto |
|
| PreCheckSmsCodeDto.Channel |
短信通道，指定发送此短信的目的，如 CHANNEL_LOGIN 用于登录、CHANNEL_REGISTER 用于注册。
|
| PreviewEmailTemplateDataDto |
|
| PreviewEmailTemplateDto.TplEngine |
模版渲染引擎。
|
| PreviewEmailTemplateDto.Type |
模版类型:
- `WELCOME_EMAIL`: 欢迎邮件
- `FIRST_CREATED_USER`: 首次创建用户通知
- `REGISTER_VERIFY_CODE`: 注册验证码
- `LOGIN_VERIFY_CODE`: 登录验证码
- `MFA_VERIFY_CODE`: MFA 验证码
- `INFORMATION_COMPLETION_VERIFY_CODE`: 注册信息补全验证码
- `FIRST_EMAIL_LOGIN_VERIFY`: 首次邮箱登录验证
- `CONSOLE_CONDUCTED_VERIFY`: 在控制台发起邮件验证
- `USER_PASSWORD_UPDATE_REMIND`: 用户到期提醒
- `ADMIN_RESET_USER_PASSWORD_NOTIFICATION`: 管理员重置用户密码成功通知
- `USER_PASSWORD_RESET_NOTIFICATION`: 用户密码重置成功通知
- `RESET_PASSWORD_VERIFY_CODE`: 重置密码验证码
- `SELF_UNLOCKING_VERIFY_CODE`: 自助解锁验证码
- `EMAIL_BIND_VERIFY_CODE`: 绑定邮箱验证码
- `EMAIL_UNBIND_VERIFY_CODE`: 解绑邮箱验证码
|
| PrincipalAuthenticationInfoDto |
|
| PrincipalAuthenticationInfoPagingDto |
|
| PubEventRespDataDto |
|
| PublicKeyCredentialCreationOptionsDto |
|
| PublicKeyCredentialDescriptorDto |
|
| PublicKeyCredentialParametersDto |
|
| PublicKeyCredentialRequestOptionsDto |
|
| PublicKeyCredentialRpEntityDto |
|
| PublicKeyCredentialUserEntityDto |
|
| QrcodeLoginStrategyDto |
|
| QRCodeStatusBriefUserInfoDto |
|
| RefreshApplicationSecretDataDto |
|
| RegisterAnomalyDetectionConfigDto |
|
| RegistrationCredentialDto |
|
| RegistrationOptionsDto |
|
| RemoveDepartmentMembersReqDto.DepartmentIdType |
此次调用中使用的部门 ID 的类型
|
| RemoveTenantDepartmentMembersReqDto.DepartmentIdType |
此次调用中使用的部门 ID 的类型
|
| ResetPasswordByEmailPassCodeDto |
|
| ResetPasswordByPhonePassCodeDto |
|
| ResetPasswordDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| ResetPasswordVerify |
|
| ResetUserPrincipalAuthenticationInfoOptionsDto |
|
| ResetUserPrincipalAuthenticationInfoOptionsDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| ResGroupDto |
|
| ResignUserBatchReqDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| ResignUserDataDto |
|
| ResignUserReqDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| ResourceAction |
|
| ResourceAuthorizedTargetDto |
|
| ResourceAuthorizedTargetDto.TargetType |
主体类型
|
| ResourceDto |
|
| ResourceDto.Type |
资源类型，如数据、API、按钮、菜单
|
| ResourceItemDto |
|
| ResourceItemDto.ResourceType |
资源类型，如数据、API、按钮、菜单
|
| ResourcePagingDto |
|
| ResourcePermissionAssignmentDto |
|
| ResourcePermissionAssignmentDto.TargetType |
主体类型
|
| Result |
|
| RightItemDto |
|
| RightItemRes |
|
| RoleAuthorizedResourcePagingDto |
|
| RoleAuthorizedResourcesRespDto |
|
| RoleAuthorizedResourcesRespDto.ResourceType |
资源类型
|
| RoleCodeAndNamespaceDto |
|
| RoleDepartmentListPagingDto |
|
| RoleDepartmentRespDto |
|
| RoleDto |
|
| RoleListItem |
|
| RoleListPageDto |
|
| RolePagingDto |
|
| RolePermissionListDto |
|
| RoleWithMembersDto |
|
| SamlIdpConfig |
|
| SearchDepartmentsFilterItemDto |
|
| SearchDepartmentsFilterItemDto.Operator |
运算符，可选值为：
- `EQUAL`: 全等，适用于数字和字符串的全等匹配
- `IN`: 为某个数组中的元素
- `GREATER`: 大于或等于，适用于数字、日期类型数据的比较
- `LESSER`: 小于或等于，适用于数字、日期类型数据的比较
- `BETWEEN`: 介于什么什么之间，适用于数字、日期类型数据的比较
- `CONTAINS`: 字符串包含
|
| SearchDepartmentsListReqDto.OrderBy |
增序或降序
|
| SearchDepartmentsListReqDto.SortBy |
排序依据，如 更新时间或创建时间
|
| SecuritySettingsDto |
|
| SelfUnlockAccountConfigDto |
|
| SelfUnlockAccountConfigDto.Strategy |
自助解锁方式，目前支持原密码 + 验证码和验证码两种方式。
|
| SendCreateAccountNotificationDto |
|
| SendEmailDto.Channel |
短信通道，指定发送此短信的目的：
- `CHANNEL_LOGIN`: 用于用户登录
- `CHANNEL_REGISTER`: 用于用户注册
- `CHANNEL_RESET_PASSWORD`: 用于重置密码
- `CHANNEL_VERIFY_EMAIL_LINK`: 用于验证邮箱地址
- `CHANNEL_UPDATE_EMAIL`: 用于修改邮箱
- `CHANNEL_BIND_EMAIL`: 用于绑定邮箱
- `CHANNEL_UNBIND_EMAIL`: 用于解绑邮箱
- `CHANNEL_VERIFY_MFA`: 用于验证 MFA
- `CHANNEL_UNLOCK_ACCOUNT`: 用于自助解锁
- `CHANNEL_COMPLETE_EMAIL`: 用于注册/登录时补全邮箱信息
- `CHANNEL_DELETE_ACCOUNT`: 用于注销账号
|
| SendEnrollFactorRequestDataDto |
|
| SendEnrollFactorRequestDto.FactorType |
MFA 认证要素类型：
- `OTP`: OTP
- `SMS`: 短信
- `EMAIL`: 邮件
- `FACE`: 人脸
|
| SendEnrollFactorRequestOtpDataDto |
|
| SendGridEmailProviderConfig |
|
| SendGridEmailProviderConfigInput |
|
| SendResetPasswordNotificationDto |
|
| SendSMSDto.Channel |
短信通道，指定发送此短信的目的：
- `CHANNEL_LOGIN`: 用于用户登录
- `CHANNEL_REGISTER`: 用于用户注册
- `CHANNEL_RESET_PASSWORD`: 用于重置密码
- `CHANNEL_BIND_PHONE`: 用于绑定手机号
- `CHANNEL_UNBIND_PHONE`: 用于解绑手机号
- `CHANNEL_BIND_MFA`: 用于绑定 MFA
- `CHANNEL_VERIFY_MFA`: 用于验证 MFA
- `CHANNEL_UNBIND_MFA`: 用于解绑 MFA
- `CHANNEL_COMPLETE_PHONE`: 用于在注册/登录时补全手机号信息
- `CHANNEL_IDENTITY_VERIFICATION`: 用于进行用户实名认证
- `CHANNEL_DELETE_ACCOUNT`: 用于注销账号
|
| SendTenantEmailDto |
|
| SendTenantSmsDto |
|
| SetCustomDataDto |
|
| SetCustomDataReqDto.TargetType |
目标对象类型：
- `USER`: 用户
- `ROLE`: 角色
- `GROUP`: 分组
- `DEPARTMENT`: 部门
|
| SetCustomFieldDto |
|
| SetCustomFieldDto.DataType |
数据类型，**设置之后将不能进行修改**。
|
| SetCustomFieldDto.TargetType |
主体类型，目前支持用户、角色、分组和部门
|
| SetUserBaseFieldDto |
|
| SetUserCustomDataDto |
|
| SetUserDepartmentDto |
|
| SetUserDepartmentsOptionsDto |
|
| SetUserDepartmentsOptionsDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| SignInByAdPayloadDto |
|
| SignInByAlipayPayloadDto |
|
| SignInByApplePayloadDto |
|
| SignInByBaiduPayloadDto |
|
| SigninByCredentialsDto.Connection |
认证方式：
- `PASSWORD`: 使用密码方式进行认证。
|
| SignInByDingTalkPayloadDto |
|
| SignInByDouyinPayloadDto |
|
| SignInByFacebookPayloadDto |
|
| SignInByGiteePayloadDto |
|
| SignInByGithubPayloadDto |
|
| SignInByGitlabPayloadDto |
|
| SignInByGooglePayloadDto |
|
| SignInByKuaishouPayloadDto |
|
| SignInByLarkInternalPayloadDto |
|
| SignInByLarkPublicPayloadDto |
|
| SignInByLdapPayloadDto |
|
| SignInByLinkedInPayloadDto |
|
| SigninByMobileDto.Connection |
移动端社会化登录类型：
- `apple`: Apple 移动端应用
- `wechat`: 微信移动应用
- `alipay`: 支付宝移动应用
- `wechatwork`: 企业微信移动应用
- `wechatwork_agency`: 企业微信移动应用（代开发模式）
- `lark_internal`: 飞书移动端企业自建应用
- `lark_public`: 飞书移动端应用商店应用
- `yidun`: 网易易盾一键登录
- `wechat_mini_program_code`: 微信小程序使用 code 登录
- `wechat_mini_program_phone `: 微信小程序使用手机号登录
- `wechat_mini_program_code_and_phone `: 微信小程序使用 code 和手机号登录
- `google`: Google 移动端社会化登录
- `facebook`: Facebook 移动端社会化登录
- `qq`: QQ 移动端社会化登录
- `weibo`: 新浪微博移动端社会化登录
- `baidu`: 百度移动端社会化登录
- `linkedin`: LinkedIn 移动端社会化登录
- `dingtalk`: 钉钉移动端社会化登录
- `github`: Github 动端社会化登录
- `gitee`: Gitee 移动端社会化登录
- `gitlab`: GitLab 移动端社会化登录
- `douyin`: 抖音移动端社会化登录
- `kuaishou`: 快手移动端社会化登录
- `xiaomi`: 小米移动端社会化登录
|
| SignInByMobileOptionsDto |
|
| SignInByPassCodePayloadDto |
|
| SignInByPasswordPayloadDto |
|
| SignInByPushOptionsDto |
|
| SignInByQQPayloadDto |
|
| SignInByWebAuthnOptionsDto |
|
| SignInByWechatMiniProgramCodeAndPhonePayloadDto |
|
| SignInByWechatMiniProgramCodePayloadDto |
|
| SignInByWechatMiniProgramPhoneInfoPayloadDto |
|
| SignInByWechatMiniProgramPhonePayloadDto |
|
| SignInByWechatPayloadDto |
|
| SignInByWechatworkAgencyPayloadDto |
|
| SignInByWechatworkDto |
|
| SignInByWeiboPayloadDto |
|
| SignInByXiaomiPayloadDto |
|
| SignInByYidunPayloadDto |
|
| SignInFastpassOptionsDto |
|
| SignInOptionsDto |
|
| SignInOptionsDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| SignUpByPassCodeDto |
|
| SignUpByPasswordDto |
|
| SignUpDto.Connection |
注册方式：
- `PASSWORD`: 邮箱密码方式
- `PASSCODE`: 邮箱/手机号验证码方式
|
| SignUpOptionsDto |
|
| SignUpOptionsDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| SignUpProfileDto |
|
| SignUpProfileDto.Gender |
性别 W : 女性; M : 男性
|
| SMTPEmailProviderConfig |
|
| SMTPEmailProviderConfigInput |
|
| SortingDto |
|
| SortingDto.Field |
进行排序的字段，可选值为：
- `createdAt`: 创建时间
- `updatedAt`: 修改时间
- `email`: 邮箱
- `phone`: 手机号
- `username`: 用户名
- `externalId`: 外部 ID
- `status`: 用户状态
- `statusChangedAt`: 状态修改时间
- `passwordLastSetAt`: 密码修改时间
- `loginsCount`: 登录次数
- `gender`: 性别
- `lastLogin`: 上次登录时间
- `userSourceType`: 用户注册来源
- `lastMfaTime`: 上次 MFA 认证时间
- `passwordSecurityLevel`: 密码安全等级
- `phoneCountryCode`: 手机区号
- `lastIp`: 上次登录时使用的 IP
|
| SortingDto.Order |
排序顺序：
- `desc`: 按照从大到小降序。
|
| StrAuthorize |
|
| StrResourceAuthAction |
|
| SubjectDto |
|
| SubjectDto.Type |
主体类型,包括 USER、GROUP、ROLE、ORG 四种类型
|
| SubjectRespDto |
|
| SubjectRespDto.Type |
主体类型,包括 USER、GROUP、ROLE、ORG 四种类型
|
| SyncJobDto |
|
| SyncJobDto.SyncFlow |
同步任务数据流向：
- `upstream`: 作为上游，将数据同步到 Authing
- `downstream`: 作为下游，将 Authing 数据同步到此系统
|
| SyncJobDto.SyncStatus |
当前同步状态:
- `free`: 空闲状态，从未执行
- `pending`: 等待系统执行
- `onProgress`: 正在执行
- `success`: 成功
- `failed`: 失败
|
| SyncJobDto.SyncTrigger |
同步任务触发类型：
- `manually`: 手动触发执行
- `timed`: 定时触发
- `automatic`: 根据事件自动触发
|
| SyncJobPagingDto |
|
| SyncRiskOperationDto |
|
| SyncRiskOperationDto.ObjectType |
操作对象类型:
- `department`: 部门
- `user`: 用户
|
| SyncRiskOperationDto.Status |
执行状态:
- `PENDING`: 待执行
- `SUCCESS`: 成功
- `FAILED`: 失败
- `CANCELED`: 已取消
- `EXECUTING`: 执行中
|
| SyncRiskOperationPagingDto |
|
| SyncTaskActiveDirectoryClientConfig |
|
| SyncTaskClientConfig |
|
| SyncTaskDingtalkClientConfig |
|
| SyncTaskDto |
|
| SyncTaskDto.LastSyncStatus |
最近一次同步状态:
- `free`: 空闲状态，从未执行
- `pending`: 等待系统执行
- `onProgress`: 正在执行
- `success`: 成功
- `failed`: 失败
|
| SyncTaskDto.SyncFlow |
同步任务数据流向：
- `upstream`: 作为上游，将数据同步到 Authing
- `downstream`: 作为下游，将 Authing 数据同步到此系统
|
| SyncTaskDto.SyncTaskType |
同步任务类型:
- `lark`: 飞书
- `lark-international`: 飞书国际版
- `wechatwork`: 企业微信
- `dingtalk`: 钉钉
- `active-directory`: Windows AD
- `ldap`: LDAP
- `italent`: 北森
- `maycur`: 每刻报销
- `moka`: Moka
- `fxiaoke`: 纷享销客
- `xiaoshouyi`: 销售易
- `kayang`: 嘉扬 HR
- `scim`: 自定义同步源
|
| SyncTaskDto.SyncTrigger |
同步任务触发类型：
- `manually`: 手动触发执行
- `timed`: 定时触发
- `automatic`: 根据事件自动触发
|
| SyncTaskFieldMapping |
|
| SyncTaskFxiaokeClientConfig |
|
| SyncTaskItalentClientConfig |
|
| SyncTaskKayangClientConfig |
|
| SyncTaskLarkClientConfig |
|
| SyncTaskLdapClientConfig |
|
| SyncTaskMaycurClientConfig |
|
| SyncTaskMokaClientConfig |
|
| SyncTaskPagingDto |
|
| SyncTaskProvisioningScope |
|
| SyncTaskScimClientConfig |
|
| SyncTaskTimedScheduler |
|
| SyncTaskTimedScheduler.Cycle |
定时周期：
- `month`: 每个月执行一次
- `week`: 每周执行一次
- `days`: 每天执行一次
- `sixHours`: 每六小时执行一次
- `twoHours`: 每两小时执行一次
|
| SyncTaskWechatworkClientConfig |
|
| SyncTaskXiaoshouyiClientConfig |
|
| SystmeInfoRSAConfig |
|
| SystmeInfoSM2Config |
|
| SystmeInfoVersion |
|
| TabConfigDto |
|
| TargetDto |
|
| TargetDto.TargetType |
目标对象类型：
- `USER`: 用户
- `ROLE`: 角色
- `GROUP`: 分组
- `DEPARTMENT`: 部门
|
| TenantApplicationDto |
|
| TenantApplicationListPagingDto |
|
| TenantCooperatorDto |
|
| TenantCooperatorListPagingDto |
|
| TenantCooperatorSingleDto |
|
| TenantDto |
|
| TenantListPagingDto |
|
| TenantRespDto |
|
| TenantUserDto |
|
| TenantUserDto.Gender |
性别:
- `M`: 男性，`male`
- `F`: 女性，`female`
- `U`: 未知，`unknown`
|
| TenantUserListPagingDto |
|
| TencentExmailEmailProviderConfig |
|
| TencentExmailEmailProviderConfigInput |
|
| TokenEndPointParams.Grant_type |
授权模式：
- `authorization_code`: 使用一次性授权码 `code` 换取。
|
| TreeAuthBo |
|
| TreeAuthorize |
|
| TreeResourceAuthAction |
|
| TreeStructs |
|
| TriggerSyncRiskOperationsDataDto |
|
| TriggerSyncTaskDataDto |
|
| TriggerWebhookData |
|
| UpdateApplicationPermissionStrategyDataDto.PermissionStrategy |
应用访问授权策略
|
| UpdateDataPolicyRespDto |
|
| UpdateDataResourceRespDto |
|
| UpdateDataResourceRespDto.Type |
数据资源类型，目前支持树结构（TREE）、字符串（STRING）、数组（ARRAY）
|
| UpdateDepartmentReqDto.DepartmentIdType |
此次调用中使用的部门 ID 的类型
|
| UpdateEmailByEmailPassCodeDto |
|
| UpdateEmailTemplateDto.TplEngine |
模版渲染引擎。
|
| UpdateEmailTemplateDto.Type |
模版类型:
- `WELCOME_EMAIL`: 欢迎邮件
- `FIRST_CREATED_USER`: 首次创建用户通知
- `REGISTER_VERIFY_CODE`: 注册验证码
- `LOGIN_VERIFY_CODE`: 登录验证码
- `MFA_VERIFY_CODE`: MFA 验证码
- `INFORMATION_COMPLETION_VERIFY_CODE`: 注册信息补全验证码
- `FIRST_EMAIL_LOGIN_VERIFY`: 首次邮箱登录验证
- `CONSOLE_CONDUCTED_VERIFY`: 在控制台发起邮件验证
- `USER_PASSWORD_UPDATE_REMIND`: 用户到期提醒
- `ADMIN_RESET_USER_PASSWORD_NOTIFICATION`: 管理员重置用户密码成功通知
- `USER_PASSWORD_RESET_NOTIFICATION`: 用户密码重置成功通知
- `RESET_PASSWORD_VERIFY_CODE`: 重置密码验证码
- `SELF_UNLOCKING_VERIFY_CODE`: 自助解锁验证码
- `EMAIL_BIND_VERIFY_CODE`: 绑定邮箱验证码
- `EMAIL_UNBIND_VERIFY_CODE`: 解绑邮箱验证码
|
| UpdateEmailVerifyRequestDto.VerifyMethod |
修改当前邮箱使用的验证手段：
- `EMAIL_PASSCODE`: 通过邮箱验证码进行验证，当前只支持这种验证方式。
|
| UpdateLoginConfig |
|
| UpdateNamespaceDto |
|
| UpdatePasswordDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| UpdatePermissionNamespaceRespDto |
|
| UpdatePhoneByPhonePassCodeDto |
|
| UpdatePipelineOrderDto.Scene |
函数的触发场景：
- `PRE_REGISTER`: 注册前
- `POST_REGISTER`: 注册后
- `PRE_AUTHENTICATION`: 认证前
- `POST_AUTHENTICATION`: 认证后
- `PRE_OIDC_ID_TOKEN_ISSUED`: OIDC ID Token 签发前
- `PRE_OIDC_ACCESS_TOKEN_ISSUED`: OIDC Access Token 签发前
- `PRE_COMPLETE_USER_INFO`: 补全用户信息前
|
| UpdateResourceDto.Type |
资源类型，如数据、API、按钮、菜单
|
| UpdateSyncTaskDto.SyncTaskFlow |
同步任务数据流向：
- `upstream`: 作为上游，将数据同步到 Authing
- `downstream`: 作为下游，将 Authing 数据同步到此系统
|
| UpdateSyncTaskDto.SyncTaskTrigger |
同步任务触发类型：
- `manually`: 手动触发执行
- `timed`: 定时触发
- `automatic`: 根据事件自动触发
|
| UpdateSyncTaskDto.SyncTaskType |
同步任务类型:
- `lark`: 飞书
- `lark-international`: 飞书国际版
- `wechatwork`: 企业微信
- `dingtalk`: 钉钉
- `active-directory`: Windows AD
- `ldap`: LDAP
- `italent`: 北森
- `maycur`: 每刻报销
- `moka`: Moka
- `fxiaoke`: 纷享销客
- `xiaoshouyi`: 销售易
- `kayang`: 嘉扬 HR
- `scim`: 自定义同步源
|
| UpdateUserBatchOptionsDto |
|
| UpdateUserBatchOptionsDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| UpdateUserInfoDto |
|
| UpdateUserInfoDto.Gender |
性别
|
| UpdateUserInfoDto.Status |
账户当前状态
|
| UpdateUserOptionsDto |
|
| UpdateUserOptionsDto.PasswordEncryptType |
密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。
|
| UpdateUserOptionsDto.UserIdType |
用户 ID 类型，默认值为 `user_id`，可选值为：
- `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
- `phone`: 用户手机号
- `email`: 用户邮箱
- `username`: 用户名
- `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
- `identity`: 用户的外部身份源信息，格式为 `:`，其中 `` 为 Authing 身份源的 ID，`` 为用户在外部身份源的 ID。
|
| UpdateUserProfileDto.Gender |
性别
|
| UpdateUserReqDto.Gender |
性别
|
| UpdateUserReqDto.Status |
账户当前状态
|
| UpdateWebhookDto.ContentType |
请求数据格式
|
| UploadDataDto |
|
| User |
|
| UserActionLogDto |
|
| UserActionLogDto.EventType |
事件类型：
- `login`: 登录
- `logout`: 登出
- `register`: 注册
- `verifyMfa`: 验证 MFA
- `updateUserProfile`: 修改用户信息
- `updateUserPassword`: 修改密码
- `updateUserEmail`: 修改邮箱
- `updateUserPhone`: 修改手机号
- `bindMfa`: 绑定 MFA
- `bindEmail`: 绑定邮箱
- `bindPhone`: 绑定手机号
- `unbindPhone`: 解绑手机号
- `unbindEmail`: 解绑邮箱
- `unbindMFA`: 解绑 MFA
- `deleteAccount`: 注销账号
- `verifyFirstLogin`: 首次登录验证
|
| UserActionLogRespData |
|
| UserAuthResourceListDto |
|
| UserDepartmentPagingDto |
|
| UserDepartmentRespDto |
|
| UserDto |
|
| UserDto.Gender |
性别:
- `M`: 男性，`male`
- `F`: 女性，`female`
- `U`: 未知，`unknown`
|
| UserDto.Status |
账户当前状态
|
| UserDto.UserSourceType |
来源类型:
- `excel`: 通过 excel 导入
- `register`: 用户自主注册
- `adminCreated`: 管理员后台手动创建（包含使用管理 API 创建用户 ）
- `syncTask`: 同步中心的同步任务
|
| UserDto.WorkStatus |
账户当前工作状态
|
| UserInfoDto |
|
| UserInfoDto.Gender |
性别
|
| UserLoggedInAppsDto |
|
| UserLoggedInIdentitiesDto |
|
| UserLoginHistoryDto |
|
| UserLoginHistoryPagingDto |
|
| UserMfaRespDto |
|
| UserPagingDto |
|
| UserPermissionListDto |
|
| UserPoolTenantConfigDto |
|
| UserPoolTenantConfigDto.EnableSwitchType |
允许切换的类型
|
| UserTenantListDto |
|
| VerifyAuthenticationResultDto |
|
| VerifyDeleteAccountRequestDataDto |
|
| VerifyDeleteAccountRequestDto.VerifyMethod |
注销账号的验证手段：
- `PHONE_PASSCODE`: 使用手机号验证码方式进行验证。
|
| VerifyRegistrationDto.AuthenticatorCode |
凭证信息类型：
- `FINGERPRINT`: 指纹
- `FACE`: 人脸
- `OTHER` 其他
|
| VerifyRegistrationResultDto |
|
| VerifyResetPasswordRequestDto.VerifyMethod |
忘记密码请求使用的验证手段：
- `EMAIL_PASSCODE`: 通过邮箱验证码进行验证
- `PHONE_PASSCODE`: 通过手机号验证码进行验证
|
| VerifyUpdateEmailRequestData |
|
| VerifyUpdateEmailRequestDto.VerifyMethod |
修改当前邮箱使用的验证手段：
- `EMAIL_PASSCODE`: 通过邮箱验证码进行验证，当前只支持这种验证方式。
|
| VerifyUpdatePhoneRequestData |
|
| VerifyUpdatePhoneRequestDto.VerifyMethod |
修改手机号的验证方式：
- `PHONE_PASSCODE`: 使用短信验证码的方式进行验证，当前仅支持这一种方式。
|
| WebhookCategoryDto |
|
| WebhookDto |
|
| WebhookDto.ContentType |
请求数据格式
|
| WebhookEventDto |
|
| WebhookEventListData |
|
| WebhookLogDto |
|
| WechatIdentityResolveRespDataDto |
|