How should the header X-DocuSign-Authentication be used for REST and SOAP?

by

X-DocuSign-Authentication [HTTP HEADER]

  • Best Practice: Use an obfuscated username and password in the api authentication header
  • Definition: Send On Behalf Of Rights (API) is SOBO.

Given the following values:

  • Username == API Service User ==
    “[email protected]” == USERID
    “cdcd3fc7-2b3c-40d4-98ed-ff90add317ca”
  • Password == “yourpassword” = EncryptedAPIPassword ==
    “/A5hpPhSczID+JNEKZbg5mYf7+7=”
  • SOBOUser == “[email protected]” == USERID
    “eacd3fc7-2b3c-40d4-98ed-ff90add317ff“
  • Integratorkey == “YDMN-339fa93c-fcf0-4390-8141-2e0f071ffa2e”

Your code needs to result in a http header value for the HTTP header
X-DocuSign-Authentication of:

XML format:

NON-SOBO

<DocuSignCredentials><Username>cdcd3fc7-2b3c-40d4-98ed-ff90add317ca</Username><Password>/A5hpPhSczID+JNEKZbg5mYf7+7=</Password><IntegratorKey>YDMN-339fa93c-fcf0-4390-8141-2e0f071ffa2e </IntegratorKey></DocuSignCredentials>

SOBO

<DocuSignCredentials><Username>cdcd3fc7-2b3c-40d4-98ed-ff90add317ca</Username><Password>/A5hpPhSczID+JNEKZbg5mYf7+7=</Password><IntegratorKey>YDMN-339fa93c-fcf0-4390-8141-2e0f071ffa2e</IntegratorKey><SendOnBehalfOf>eacd3fc7-2b3c-40d4-98ed-ff90add317ff </SendOnBehalfOf></DocuSignCredentials>

JSON format:

NON-SOBO

{"Username":"cdcd3fc7-2b3c-40d4-98ed-ff90add317ca","Password":"/A5hpPhSczID+JNEKZbg5mYf7+7=","IntegratorKey":"YDMN-339fa93c-fcf0-4390-8141-2e0f071ffa2e"}

SOBO

{"Username":"cdcd3fc7-2b3c-40d4-98ed-ff90add317ca","Password":"/A5hpPhSczID+JNEKZbg5mYf7+7=","SendOnBehalfOf":"eacd3fc7-2b3c-40d4-98ed-ff90add317ff","IntegratorKey":"YDMN-339fa93c-fcf0-4390-8141-2e0f071ffa2e"}

API Service user
Service Account doesn’t need to be Admin, unless you are creating users, but must have SOBO and Account Wide rights.

SOBO User
SOBO User doesn’t need to be Admin, but must have the permission to send and be a user in the account of the Service Account user. You only use this userid when you are doing an action as that user like sending or voiding.

Here is a link to the full sized Infographic I created to assist with this shown below

X-DocuSign-Authentication Inforgraphic

More Related Contents:

  1. SOAP vs REST (differences)
  2. Representational state transfer (REST) and Simple Object Access Protocol (SOAP)
  3. RESTful URL design for search
  4. REST API – why use PUT DELETE POST GET?
  5. What is the proper REST response code for a valid request but an empty data?
  6. HTTP response code for POST when resource already exists
  7. Security of REST authentication schemes
  8. How to make remote REST call inside Node.js? any CURL?
  9. Secure Web Services: REST over HTTPS vs SOAP + WS-Security. Which is better? [closed]
  10. Best practice for partial updates in a RESTful service
  11. Groovy built-in REST/HTTP client?
  12. Unable to upload zip file through karate framework
  13. API pagination best practices
  14. How to use cURL to send Cookies?
  15. Querystring in REST Resource url
  16. How to construct a REST API that takes an array of id’s for the resources
  17. Spring @ExceptionHandler does not work with @ResponseBody
  18. Update an entire resource collection in a REST way
  19. What are the best/common RESTful url verbs and actions?
  20. Should I use Singular or Plural name convention for REST resources?
  21. How to download excel (.xls) file from API in postman?
  22. Where can I find jenkins restful api reference? [closed]
  23. Is it correct to return 404 when a REST resource is not found?
  24. When is it appropriate to respond with a HTTP 412 error?
  25. Websocket vs REST when sending data to server
  26. Can I change the headers of the HTTP request sent by the browser?
  27. When in my REST API should I use an envelope? If I use it in one place, should I always use it?
  28. Swagger UI passing authentication token to API call in header
  29. Hyphen, underscore, or camelCase as word delimiter in URIs?
  30. REST API DESIGN – Getting a resource through REST with different parameters but same url pattern

Leave a Comment