Updated on 2024-12-30 GMT+08:00

DingTalk Gateway

If SMS and voice verification codes fall short of your needs, you can configure the DingTalk gateway to send verification codes for various scenarios, such as user portal login, password recovery, two factor authentication, password resetting, and risk warning.

This section describes how to configure the DingTalk gateway in OneAccess.

Prerequisites

  • You have administrator permissions for the DingTalk open platform. For details, see the documentation of the DingTalk open platform.
  • You have permissions to access the administrator portal of OneAccess.

Configuring DingTalk Authentication in OneAccess

To ensure that a user can receive verification codes from DingTalk, configure a DingTalk authentication provider in OneAccess and bind the OneAccess user to DingTalk.

Creating a Mini App on the DingTalk Open Platform

You can create a mini app on the DingTalk open platform and grant API permissions to establish a connection between your app and the DingTalk authentication provider.

  1. Log in to the DingTalk open platform.
  2. On the DingTalk open platform, choose App Development > Organization Internal App > Mini App, set app parameters, and click Create. The AgentId, AppKey, and AppSecret are automatically generated. For details, see the documentation of the DingTalk open platform.
  3. Go to the permission management area and add the API permission Address book read-only.

Configuring DingTalk Gateway in OneAccess

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Settings > Enterprise Settings.
  3. On the Enterprise Settings page, choose DingTalk Gateway in the left-hand navigation pane. On the displayed page, click to enable the DingTalk gateway and set basic parameters.

    Table 1 Basic settings

    Parameter

    Description

    * Agent ID

    AgentId of an app created on the DingTalk open platform.

    * AppKey

    AppKey of an app created on the DingTalk open platform.

    * AppSecret

    AppSecret of an app created on the DingTalk open platform.

  4. (Optional) Click Test in the Operation column of the target scenario, specify a user, and click Test to check whether the DingTalk gateway configuration is successful.

    If you see an error message stating that the verification code failed to be sent because the user is not bound to a DingTalk account, you will need to bind the DingTalk account by referring to Configuring DingTalk Authentication in OneAccess.