Unified Authorization Suite Front-End SDK

​

Expected Results

​

Personal Authorization

​

Organization Authorization

​

Admin Authorization

​

Non-Admin Authorization

​

Version Requirements

import { getENV, } from 'dingtalk-jsapi/lib/env';
import { compareVersion, } from 'dingtalk-jsapi/lib/sdk/sdkLib';

const { platform, version, appType, } = getENV();
/**
 * Check whether the current app version supports the SDK
 * @return {boolean}
 */
function isAuthSDKSupport() {
  return compareVersion(version, '6.3.35');
}

​

1. Install the Authorization Suite SDK

1. Run the following command to download and install the SDK (dingtalk-design-libs must be version 0.1.0 or later).
   npm install dingtalk-design-libs --save
   
2. After the download completes, import the SDK directly into your code.
   import { openAuth } from 'dingtalk-design-libs/biz/openAuth';
   

​

2. Integrate App Authorization

1. Import the DingTalk Unified Authorization Suite SDK.
   import { openAuth } from 'dingtalk-design-libs/biz/openAuth';
   
2. When user authorization is required, call openAuth directly. The request example is as follows:
   openAuth({
     clientId:'dingwlanwxxx', // App ID (unique identifier)
     corpId:'', // The organization ID of the current organization
     rpcScope:'Calendar.Event.Write,Calendar.Event.Read,Contact.User.Read', 
     fieldScope:'Contact.User.mobile',
     type:0 // 0 indicates authorizing the profile; 1 indicates authorizing organization information
   }).then((res)=>{
   // Process the returned data
   })
   

​

Request Parameters

​

3. Response Information

​

The Response Example Is as Follows:

• Authorization completed
  {
   status: 'ok',
   result: {
   authCode:'xxxxxxx' // This value is not returned for organization authorization (type=1)
   }
  }
  
• Authorization declined
  {
      status: 'cancel',
      result: null
  }
  
• An authorization request was sent to the admin, awaiting authorization (occurs only in organization authorization scenarios)
  {
      status: 'toAdmin',
      result: null
  }
  
• Authorization error
  {
      status: 'failed',
      result: null
  }
  

​

Response Parameters

​

Error Codes

​

Parameter Errors

​

Permission Scope Errors

​

App Errors

​

Authorization Errors

​

Authorization Validity Period