Package com.tencentcloudapi.essbasic.v20210526.models

Class CreateConsoleLoginUrlRequest

  • public class CreateConsoleLoginUrlRequest
extends AbstractModel

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Agent getAgent()
      Get 应用信息 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent.
      Long[] getAuthorizationTypes()
      Get 可选的企业授权方式: 1：上传授权书 2：转法定代表人授权 4：企业实名认证（信任第三方认证源）（此项仅支持单选） 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不生效；选择信任第三方认证源时，请先通过“同步企业信息”接口同步信息。 该参数仅在企业激活场景生效
      String getAutoJumpBackEvent()
      Get 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
      String getEndpoint()
      Get 生成链接的类型： "PC"：PC控制台链接 "CHANNEL"：H5跳转到电子签小程序链接 "APP"：第三方APP或小程序跳转电子签小程序链接 默认将生成PC控制台链接
      String getMenuStatus()
      Get 是否展示左侧菜单栏 "ENABLE": 是，展示 “DISABLE”: 否，不展示 默认值为ENABLE 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。
      String getModule()
      Get PC控制台登录后进入该参数指定的模块，如果不传递，将默认进入控制台首页。支持的模块包括： 1、DOCUMENT:合同管理模块， 2、TEMPLATE:企业模板管理模块， 3、SEAL:印章管理模块， 4、OPERATOR:组织管理模块， 默认将进入企业中心模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数仅在企业和员工激活完成，登录控制台场景才生效。
      String getModuleId()
      Get 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同。当前支持： 1、如果Module="SEAL"，ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。 2、如果Module="TEMPLATE"，ModuleId代表模版Id，登录链接将直接查看指定模版的详情。 3、如果Module="1、DOCUMENT"，ModuleId代表合同Id，登录链接将直接查看指定合同的详情。 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。 2、ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到。
      UserInfo getOperator()
      Deprecated. 
      String getProxyOperatorName()
      Get 子客企业经办人的姓名，最大长度50个字符 注意： 1、若经办人已经实名，这里修改经办人名字传入将不会生效。 2、该名称需要和Agent.
      String getProxyOrganizationName()
      Get 子客企业名称，最大长度64个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
      String getUniformSocialCreditCode()
      Get 子客企业统一社会信用代码，最大长度200个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。
      void setAgent​(Agent Agent)
      Set 应用信息 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent.
      void setAuthorizationTypes​(Long[] AuthorizationTypes)
      Set 可选的企业授权方式: 1：上传授权书 2：转法定代表人授权 4：企业实名认证（信任第三方认证源）（此项仅支持单选） 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不生效；选择信任第三方认证源时，请先通过“同步企业信息”接口同步信息。 该参数仅在企业激活场景生效
      void setAutoJumpBackEvent​(String AutoJumpBackEvent)
      Set 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
      void setEndpoint​(String Endpoint)
      Set 生成链接的类型： "PC"：PC控制台链接 "CHANNEL"：H5跳转到电子签小程序链接 "APP"：第三方APP或小程序跳转电子签小程序链接 默认将生成PC控制台链接
      void setMenuStatus​(String MenuStatus)
      Set 是否展示左侧菜单栏 "ENABLE": 是，展示 “DISABLE”: 否，不展示 默认值为ENABLE 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。
      void setModule​(String Module)
      Set PC控制台登录后进入该参数指定的模块，如果不传递，将默认进入控制台首页。支持的模块包括： 1、DOCUMENT:合同管理模块， 2、TEMPLATE:企业模板管理模块， 3、SEAL:印章管理模块， 4、OPERATOR:组织管理模块， 默认将进入企业中心模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数仅在企业和员工激活完成，登录控制台场景才生效。
      void setModuleId​(String ModuleId)
      Set 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同。当前支持： 1、如果Module="SEAL"，ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。 2、如果Module="TEMPLATE"，ModuleId代表模版Id，登录链接将直接查看指定模版的详情。 3、如果Module="1、DOCUMENT"，ModuleId代表合同Id，登录链接将直接查看指定合同的详情。 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。 2、ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到。
      void setOperator​(UserInfo Operator)
      Deprecated. 
      void setProxyOperatorName​(String ProxyOperatorName)
      Set 子客企业经办人的姓名，最大长度50个字符 注意： 1、若经办人已经实名，这里修改经办人名字传入将不会生效。 2、该名称需要和Agent.
      void setProxyOrganizationName​(String ProxyOrganizationName)
      Set 子客企业名称，最大长度64个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
      void setUniformSocialCreditCode​(String UniformSocialCreditCode)
      Set 子客企业统一社会信用代码，最大长度200个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • CreateConsoleLoginUrlRequest

        public CreateConsoleLoginUrlRequest()

      • CreateConsoleLoginUrlRequest

        public CreateConsoleLoginUrlRequest​(CreateConsoleLoginUrlRequest source)
        NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

    • Method Detail

      • getAgent

        public Agent getAgent()
        Get 应用信息 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
        Returns:
        Agent 应用信息 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填

      • setAgent

        public void setAgent​(Agent Agent)
        Set 应用信息 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
        Parameters:
        Agent - 应用信息 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填

      • getProxyOrganizationName

        public String getProxyOrganizationName()
        Get 子客企业名称，最大长度64个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
        Returns:
        ProxyOrganizationName 子客企业名称，最大长度64个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。

      • setProxyOrganizationName

        public void setProxyOrganizationName​(String ProxyOrganizationName)
        Set 子客企业名称，最大长度64个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
        Parameters:
        ProxyOrganizationName - 子客企业名称，最大长度64个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。

      • getUniformSocialCreditCode

        public String getUniformSocialCreditCode()
        Get 子客企业统一社会信用代码，最大长度200个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。
        Returns:
        UniformSocialCreditCode 子客企业统一社会信用代码，最大长度200个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。

      • setUniformSocialCreditCode

        public void setUniformSocialCreditCode​(String UniformSocialCreditCode)
        Set 子客企业统一社会信用代码，最大长度200个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。
        Parameters:
        UniformSocialCreditCode - 子客企业统一社会信用代码，最大长度200个字符 注意： 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。

      • getProxyOperatorName

        public String getProxyOperatorName()
        Get 子客企业经办人的姓名，最大长度50个字符 注意： 1、若经办人已经实名，这里修改经办人名字传入将不会生效。 2、该名称需要和Agent. ProxyOperator.OpenId相匹配
        Returns:
        ProxyOperatorName 子客企业经办人的姓名，最大长度50个字符 注意： 1、若经办人已经实名，这里修改经办人名字传入将不会生效。 2、该名称需要和Agent. ProxyOperator.OpenId相匹配

      • setProxyOperatorName

        public void setProxyOperatorName​(String ProxyOperatorName)
        Set 子客企业经办人的姓名，最大长度50个字符 注意： 1、若经办人已经实名，这里修改经办人名字传入将不会生效。 2、该名称需要和Agent. ProxyOperator.OpenId相匹配
        Parameters:
        ProxyOperatorName - 子客企业经办人的姓名，最大长度50个字符 注意： 1、若经办人已经实名，这里修改经办人名字传入将不会生效。 2、该名称需要和Agent. ProxyOperator.OpenId相匹配

      • getModule

        public String getModule()
        Get PC控制台登录后进入该参数指定的模块，如果不传递，将默认进入控制台首页。支持的模块包括： 1、DOCUMENT:合同管理模块， 2、TEMPLATE:企业模板管理模块， 3、SEAL:印章管理模块， 4、OPERATOR:组织管理模块， 默认将进入企业中心模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数仅在企业和员工激活完成，登录控制台场景才生效。
        Returns:
        Module PC控制台登录后进入该参数指定的模块，如果不传递，将默认进入控制台首页。支持的模块包括： 1、DOCUMENT:合同管理模块， 2、TEMPLATE:企业模板管理模块， 3、SEAL:印章管理模块， 4、OPERATOR:组织管理模块， 默认将进入企业中心模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数仅在企业和员工激活完成，登录控制台场景才生效。

      • setModule

        public void setModule​(String Module)
        Set PC控制台登录后进入该参数指定的模块，如果不传递，将默认进入控制台首页。支持的模块包括： 1、DOCUMENT:合同管理模块， 2、TEMPLATE:企业模板管理模块， 3、SEAL:印章管理模块， 4、OPERATOR:组织管理模块， 默认将进入企业中心模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数仅在企业和员工激活完成，登录控制台场景才生效。
        Parameters:
        Module - PC控制台登录后进入该参数指定的模块，如果不传递，将默认进入控制台首页。支持的模块包括： 1、DOCUMENT:合同管理模块， 2、TEMPLATE:企业模板管理模块， 3、SEAL:印章管理模块， 4、OPERATOR:组织管理模块， 默认将进入企业中心模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数仅在企业和员工激活完成，登录控制台场景才生效。

      • getModuleId

        public String getModuleId()
        Get 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同。当前支持： 1、如果Module="SEAL"，ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。 2、如果Module="TEMPLATE"，ModuleId代表模版Id，登录链接将直接查看指定模版的详情。 3、如果Module="1、DOCUMENT"，ModuleId代表合同Id，登录链接将直接查看指定合同的详情。 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。 2、ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到。
        Returns:
        ModuleId 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同。当前支持： 1、如果Module="SEAL"，ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。 2、如果Module="TEMPLATE"，ModuleId代表模版Id，登录链接将直接查看指定模版的详情。 3、如果Module="1、DOCUMENT"，ModuleId代表合同Id，登录链接将直接查看指定合同的详情。 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。 2、ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到。

      • setModuleId

        public void setModuleId​(String ModuleId)
        Set 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同。当前支持： 1、如果Module="SEAL"，ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。 2、如果Module="TEMPLATE"，ModuleId代表模版Id，登录链接将直接查看指定模版的详情。 3、如果Module="1、DOCUMENT"，ModuleId代表合同Id，登录链接将直接查看指定合同的详情。 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。 2、ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到。
        Parameters:
        ModuleId - 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同。当前支持： 1、如果Module="SEAL"，ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。 2、如果Module="TEMPLATE"，ModuleId代表模版Id，登录链接将直接查看指定模版的详情。 3、如果Module="1、DOCUMENT"，ModuleId代表合同Id，登录链接将直接查看指定合同的详情。 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。 2、ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到。

      • getMenuStatus

        public String getMenuStatus()
        Get 是否展示左侧菜单栏 "ENABLE": 是，展示 “DISABLE”: 否，不展示 默认值为ENABLE 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。
        Returns:
        MenuStatus 是否展示左侧菜单栏 "ENABLE": 是，展示 “DISABLE”: 否，不展示 默认值为ENABLE 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。

      • setMenuStatus

        public void setMenuStatus​(String MenuStatus)
        Set 是否展示左侧菜单栏 "ENABLE": 是，展示 “DISABLE”: 否，不展示 默认值为ENABLE 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。
        Parameters:
        MenuStatus - 是否展示左侧菜单栏 "ENABLE": 是，展示 “DISABLE”: 否，不展示 默认值为ENABLE 注意： 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。

      • getEndpoint

        public String getEndpoint()
        Get 生成链接的类型： "PC"：PC控制台链接 "CHANNEL"：H5跳转到电子签小程序链接 "APP"：第三方APP或小程序跳转电子签小程序链接 默认将生成PC控制台链接
        Returns:
        Endpoint 生成链接的类型： "PC"：PC控制台链接 "CHANNEL"：H5跳转到电子签小程序链接 "APP"：第三方APP或小程序跳转电子签小程序链接 默认将生成PC控制台链接

      • setEndpoint

        public void setEndpoint​(String Endpoint)
        Set 生成链接的类型： "PC"：PC控制台链接 "CHANNEL"：H5跳转到电子签小程序链接 "APP"：第三方APP或小程序跳转电子签小程序链接 默认将生成PC控制台链接
        Parameters:
        Endpoint - 生成链接的类型： "PC"：PC控制台链接 "CHANNEL"：H5跳转到电子签小程序链接 "APP"：第三方APP或小程序跳转电子签小程序链接 默认将生成PC控制台链接

      • getAutoJumpBackEvent

        public String getAutoJumpBackEvent()
        Get 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
        Returns:
        AutoJumpBackEvent 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序

      • setAutoJumpBackEvent

        public void setAutoJumpBackEvent​(String AutoJumpBackEvent)
        Set 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
        Parameters:
        AutoJumpBackEvent - 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序

      • getAuthorizationTypes

        public Long[] getAuthorizationTypes()
        Get 可选的企业授权方式: 1：上传授权书 2：转法定代表人授权 4：企业实名认证（信任第三方认证源）（此项仅支持单选） 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不生效；选择信任第三方认证源时，请先通过“同步企业信息”接口同步信息。 该参数仅在企业激活场景生效
        Returns:
        AuthorizationTypes 可选的企业授权方式: 1：上传授权书 2：转法定代表人授权 4：企业实名认证（信任第三方认证源）（此项仅支持单选） 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不生效；选择信任第三方认证源时，请先通过“同步企业信息”接口同步信息。 该参数仅在企业激活场景生效

      • setAuthorizationTypes

        public void setAuthorizationTypes​(Long[] AuthorizationTypes)
        Set 可选的企业授权方式: 1：上传授权书 2：转法定代表人授权 4：企业实名认证（信任第三方认证源）（此项仅支持单选） 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不生效；选择信任第三方认证源时，请先通过“同步企业信息”接口同步信息。 该参数仅在企业激活场景生效
        Parameters:
        AuthorizationTypes - 可选的企业授权方式: 1：上传授权书 2：转法定代表人授权 4：企业实名认证（信任第三方认证源）（此项仅支持单选） 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不生效；选择信任第三方认证源时，请先通过“同步企业信息”接口同步信息。 该参数仅在企业激活场景生效

      • getOperator

        @Deprecated
public UserInfo getOperator()
        Deprecated.
        Get 暂未开放
        Returns:
        Operator 暂未开放

      • setOperator

        @Deprecated
public void setOperator​(UserInfo Operator)
        Deprecated.
        Set 暂未开放
        Parameters:
        Operator - 暂未开放