This shows you the differences between two versions of the page.
| — |
web_api:distributor:auth [2010/07/19 14:44] (current) Jose Lopez created |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Authenticate a user ====== | ||
| + | If you need to authenticate a user on your website before displaying their account information, you may do so with this api call. This way, you can truly have users manage their SendGrid account on your website completely. | ||
| + | ==== Parameters ==== | ||
| + | ^ Parameter ^ Required ^ Requirements ^ | ||
| + | | user | <html><span style="color:#FF0000">Required</span></html> | Subuser that is registered under you. | | ||
| + | | password | <html><span style="color:#FF0000">Required</span></html> | Password the subuser submitted | | ||
| + | |||
| + | =====Example Usage===== | ||
| + | ====XML==== | ||
| + | <code> | ||
| + | https://sendgrid.com/api/distributor.auth.xml?api_user=youremail@domain.com&api_key=secureSecret&user=yoursubuser@example.com&password=theirsubmittedpassword | ||
| + | </code> | ||
| + | |||
| + | **Return - Success** | ||
| + | <code xml> | ||
| + | <result> | ||
| + | <message>success</message> | ||
| + | </result> | ||
| + | </code> | ||
| + | |||
| + | **Return - Error** | ||
| + | <code xml> | ||
| + | <result> | ||
| + | <message>error</message> | ||
| + | <errors> | ||
| + | ... | ||
| + | <error>... error messages ...</error> | ||
| + | ... | ||
| + | </errors> | ||
| + | </result> | ||
| + | </code> | ||
| + | ====JSON==== | ||
| + | <code> | ||
| + | https://sendgrid.com/api/distributor.auth.json?api_user=youremail@domain.com&api_key=secureSecret&user=yoursubuser@example.com&password=theirsubmittedpassword | ||
| + | </code> | ||
| + | |||
| + | **Return - Success** | ||
| + | <code>{"message":"success"}</code> | ||
| + | |||
| + | ** Return - Error** | ||
| + | <code>{"message":"error","errors":[..."error messages"...]}</code> | ||