|
| 1 | +{ |
| 2 | + "authenticationTypes": [ |
| 3 | + { |
| 4 | + "name": "AuthCodeGrant", |
| 5 | + "displayName": "Authorization Code Grant JS", |
| 6 | + "description": "Choose this option if each user who sends DocuSign envelopes using \nthe eSignature API will login to DocuSign during each session.", |
| 7 | + "shortDescription": "Users will login to DocuSign during each session to send envelopes to eSignature API", |
| 8 | + "sources": [ |
| 9 | + { |
| 10 | + "source": "https://raw.githubusercontent.com/docusign/code-examples-node/master/lib/common/config.js", |
| 11 | + "folder": "DocuSign" |
| 12 | + }, |
| 13 | + { |
| 14 | + "source": "https://raw.githubusercontent.com/docusign/code-examples-node/master/lib/common/DSAuthCodeGrant.js", |
| 15 | + "folder": "DocuSign" |
| 16 | + } |
| 17 | + ], |
| 18 | + "parameters": [ |
| 19 | + { |
| 20 | + "key": "dsClientId", |
| 21 | + "inputType": "PlainText", |
| 22 | + "displayName": "Integration key", |
| 23 | + "placeHolder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", |
| 24 | + "mandatory": true, |
| 25 | + "validationRegEx": "^({{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}}{0,1})$", |
| 26 | + "validationMessage": "A correct integration key should be a GUID", |
| 27 | + "help": { |
| 28 | + "hint": "How to get an integration key?", |
| 29 | + "displayText": "Learn more", |
| 30 | + "URI": "https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant#prerequisites" |
| 31 | + } |
| 32 | + }, |
| 33 | + { |
| 34 | + "key": "RedirectURI", |
| 35 | + "inputType": "PlainText", |
| 36 | + "contentType": "URI", |
| 37 | + "displayName": "Redirect URI", |
| 38 | + "placeHolder": "http://example.com", |
| 39 | + "mandatory": true, |
| 40 | + "validationRegEx": "", |
| 41 | + "validationMessage": "A correct redirect URI should be a URI", |
| 42 | + "help": { |
| 43 | + "hint": "How to define a redirect URI?", |
| 44 | + "displayText": "Learn more", |
| 45 | + "URI": "https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant#prerequisites" |
| 46 | + } |
| 47 | + }, |
| 48 | + { |
| 49 | + "key": "dsClientSecret", |
| 50 | + "inputType": "PlainText", |
| 51 | + "displayName": "Secret key", |
| 52 | + "placeHolder": "", |
| 53 | + "mandatory": true, |
| 54 | + "validationRegEx": "", |
| 55 | + "help": { |
| 56 | + "hint": "How to get a secret key?", |
| 57 | + "displayText": "Learn more", |
| 58 | + "URI": "https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant#prerequisites" |
| 59 | + } |
| 60 | + }, |
| 61 | + { |
| 62 | + "key": "signerName", |
| 63 | + "placeHolder": "USER_FULLNAME", |
| 64 | + "displayInWizard": false |
| 65 | + }, |
| 66 | + { |
| 67 | + "key": "signerEmail", |
| 68 | + "placeHolder": "USER_EMAIL", |
| 69 | + "displayInWizard": false |
| 70 | + }, |
| 71 | + { |
| 72 | + "key": "roomsApiUrl", |
| 73 | + "defaultValue": "https://demo.rooms.docusign.com", |
| 74 | + "displayInWizard": false |
| 75 | + }, |
| 76 | + { |
| 77 | + "key": "clickAPIUrl", |
| 78 | + "defaultValue": "https://demo.docusign.net/clickapi", |
| 79 | + "displayInWizard": false |
| 80 | + }, |
| 81 | + { |
| 82 | + "key": "production", |
| 83 | + "defaultValue": "false", |
| 84 | + "displayInWizard": false |
| 85 | + } |
| 86 | + ], |
| 87 | + "help": { |
| 88 | + "hint": "How do I use Authorization Code Grant?", |
| 89 | + "displayText": "Learn more", |
| 90 | + "URI": "https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant" |
| 91 | + }, |
| 92 | + "applicableProjectType": "Web" |
| 93 | + }, |
| 94 | + { |
| 95 | + "name": "JWT", |
| 96 | + "displayName": "JSON Web Token (JWT) JS", |
| 97 | + "description": "Choose this option if a single login will be used to send all envelopes.", |
| 98 | + "sources": [ |
| 99 | + { |
| 100 | + "source": "https://raw.githubusercontent.com/docusign/code-examples-node/master/lib/common/config.js", |
| 101 | + "folder": "DocuSign" |
| 102 | + }, |
| 103 | + { |
| 104 | + "source": "https://raw.githubusercontent.com/docusign/code-examples-node/master/lib/common/DSJwtAuth.js", |
| 105 | + "folder": "DocuSign" |
| 106 | + } |
| 107 | + ], |
| 108 | + "parameters": [ |
| 109 | + { |
| 110 | + "key": "dsClientId", |
| 111 | + "inputType": "PlainText", |
| 112 | + "displayName": "Integration key", |
| 113 | + "placeHolder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", |
| 114 | + "mandatory": true, |
| 115 | + "validationRegEx": "^({{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}}{0,1})$", |
| 116 | + "validationMessage": "A correct integration key should be a GUID", |
| 117 | + "help": { |
| 118 | + "hint": "How to get an integration key?", |
| 119 | + "displayText": "Learn more", |
| 120 | + "URI": "https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken#prerequisites" |
| 121 | + } |
| 122 | + }, |
| 123 | + { |
| 124 | + "key": "impersonatedUserGuid", |
| 125 | + "inputType": "PlainText", |
| 126 | + "displayName": "DocuSign User ID", |
| 127 | + "placeHolder": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", |
| 128 | + "mandatory": true, |
| 129 | + "validationRegEx": "^({{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}}{0,1})$", |
| 130 | + "validationMessage": "A correct userId should be a GUID", |
| 131 | + "help": { |
| 132 | + "hint": "How to find the DocuSign userId", |
| 133 | + "displayText": "Learn more", |
| 134 | + "URI": "https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken#prerequisites" |
| 135 | + } |
| 136 | + }, |
| 137 | + { |
| 138 | + "key": "signerName", |
| 139 | + "placeHolder": "USER_FULLNAME", |
| 140 | + "displayInWizard": false |
| 141 | + }, |
| 142 | + { |
| 143 | + "key": "signerEmail", |
| 144 | + "placeHolder": "USER_EMAIL", |
| 145 | + "displayInWizard": false |
| 146 | + }, |
| 147 | + { |
| 148 | + "key": "roomsApiUrl", |
| 149 | + "defaultValue": "https://demo.rooms.docusign.com", |
| 150 | + "displayInWizard": false |
| 151 | + }, |
| 152 | + { |
| 153 | + "key": "clickAPIUrl", |
| 154 | + "defaultValue": "https://demo.docusign.net/clickapi", |
| 155 | + "displayInWizard": false |
| 156 | + }, |
| 157 | + { |
| 158 | + "key": "privateKeyLocation", |
| 159 | + "defaultValue": "private.key", |
| 160 | + "displayInWizard": false |
| 161 | + }, |
| 162 | + { |
| 163 | + "key": "production", |
| 164 | + "defaultValue": "false", |
| 165 | + "displayInWizard": false |
| 166 | + } |
| 167 | + ], |
| 168 | + "help": { |
| 169 | + "hint": "How do I use JSON Web Token (JWT) Grant?", |
| 170 | + "displayText": "Learn more", |
| 171 | + "URI": "https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken" |
| 172 | + }, |
| 173 | + "preferredConfigFile": "AppConfig" |
| 174 | + } |
| 175 | + ], |
| 176 | + "packages": [ |
| 177 | + { |
| 178 | + "name": "docusign-esign", |
| 179 | + "version": "5.9.0-rc1" |
| 180 | + }, |
| 181 | + { |
| 182 | + "name": "fs", |
| 183 | + "version": "0.0.1-security" |
| 184 | + }, |
| 185 | + { |
| 186 | + "name": "moment", |
| 187 | + "version": "^2.24.0" |
| 188 | + }, |
| 189 | + { |
| 190 | + "name": "passport", |
| 191 | + "version": "^0.4.0" |
| 192 | + } |
| 193 | + ], |
| 194 | + "supportedAPIs": [ |
| 195 | + { |
| 196 | + "apiType": "ESignature", |
| 197 | + "displayName": "ESignature", |
| 198 | + "packages": [ |
| 199 | + { |
| 200 | + "name": "docusign-esign", |
| 201 | + "version": "^5.10.0" |
| 202 | + } |
| 203 | + ], |
| 204 | + "scopes": [ |
| 205 | + "signature" |
| 206 | + ] |
| 207 | + }, |
| 208 | + { |
| 209 | + "apiType": "Rooms", |
| 210 | + "displayName": "Rooms", |
| 211 | + "packages": [ |
| 212 | + { |
| 213 | + "name": "docusign-rooms", |
| 214 | + "version": "^1.1.0" |
| 215 | + } |
| 216 | + ], |
| 217 | + "scopes": [ |
| 218 | + "dtr.rooms.read", |
| 219 | + "dtr.rooms.write", |
| 220 | + "dtr.documents.read", |
| 221 | + "dtr.documents.write", |
| 222 | + "dtr.profile.read", |
| 223 | + "dtr.profile.write", |
| 224 | + "dtr.company.read", |
| 225 | + "dtr.company.write", |
| 226 | + "room_forms" |
| 227 | + ] |
| 228 | + }, |
| 229 | + { |
| 230 | + "apiType": "Click", |
| 231 | + "displayName": "Click", |
| 232 | + "packages": [ |
| 233 | + { |
| 234 | + "name": "docusign-click", |
| 235 | + "version": "^1.0.0" |
| 236 | + } |
| 237 | + ], |
| 238 | + "scopes": [ |
| 239 | + "click.manage", |
| 240 | + "click.send" |
| 241 | + ] |
| 242 | + }, |
| 243 | + { |
| 244 | + "apiType": "Monitor", |
| 245 | + "displayName": "Monitor", |
| 246 | + "packages": [ |
| 247 | + { |
| 248 | + "name": "docusign-monitor", |
| 249 | + "version": "^1.0.0" |
| 250 | + } |
| 251 | + ] |
| 252 | + } |
| 253 | + ], |
| 254 | + "help": { |
| 255 | + "hint": "How do I identify OAuth Authentication Type?", |
| 256 | + "displayText": "Learn more", |
| 257 | + "URI": "https://developers.docusign.com/esign-rest-api/guides/authentication" |
| 258 | + } |
| 259 | +} |
0 commit comments