Skip to content
This repository
branch: develop
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 340 lines (294 sloc) 7.884 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
---
layout: page
weight: 0
title: Multiple Credentials
navigation:
  show: true
---

{% anchor h2 %}
get
{% endanchor %}
<p>Retrieve a list of all credentials, or permissions for a specific credential.</p>

<table class="table table-bordered table-striped">
    <tbody>
      <tr>
        <th>Parameter</th>
        <th>Required</th>
<th>Requirements</th>
        <th>Description</th>
      </tr>
      <tr>
        <td>api_user</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The primary account holder's user ID creating the new
        account</td>
      </tr>
      <tr>
        <td>api_key</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The primary account holder's password</td>
      </tr>
      <tr>
        <td>username</td>
<td>No</td>
        <td>alphanumeric</td>
        <td>If a username is supplied, the API returns the JSON permissions for that user</td>
      </tr>
</tbody>
</table>

{% apiexample get GET https://api.sendgrid.com/api/credentials/get api_user=your_sendgrid_username&api_key=your_sendgrid_password %}
  {% response json %}
//success
[
  {
    "id": 4,
    "name": "johnsmith",
    "permissions": {
      "email": 0,
      "api": 1
    }
  },
  {
    "id": 15,
    "name": "joewrigley",
    "permissions": {
      "web": 1,
      "api": 0
    }
  }
]

//error
{
  "error": "error reason"
}

  {% endresponse %}

  {% response xml %}
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- success -->
<credentials>
   <credential>
      <created_at>2013-01-21 16:52:01</created_at>
      <permissions>
         {"web": 1, "api": 0, "email": 0}
         <permissions>
            <id>13243</id>
            <name>John Smith</name>
            <updated_at>2013-01-21 16:52:01</updated_at>
         </permissions>
         <credential>
            <created_at>2013-01-21 16:52:01</created_at>
            <permissions>
               {"web": 1, "api": 1, "email": 0}
               <permissions>
                  <id>13243</id>
                  <name>Joe Wrigley</name>
                  <updated_at>2013-01-21 16:52:01</updated_at>
               </permissions>
            </permissions>
         </credential>
      </permissions>
   </credential>
</credentials>

<!-- error -->
<result>
   <message>error: reason</message>
</result>

  {% endresponse %}

{% endapiexample %}

<hr/>

<h2>Add</h2>
<p>This API call allows user to add a new set of credentials to their account.</p>

<table class="table table-bordered table-striped">
    <tbody>
      <tr>
        <th>Parameter</th>
        <th>Required</th>
<th>Requirements</th>
        <th>Description</th>
      </tr>
      <tr>
        <td>api_user</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The primary account holder's user ID creating the new
        account</td>
      </tr>
      <tr>
        <td>api_key</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The primary account holder's password</td>
      </tr>

      <tr>
        <td>username</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>Enter a username for the new account</td>
      </tr>

      <tr>
        <td>password</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>Enter a password for the new account</td>
      </tr>

      <tr>
        <td>permissions</td>
        <td>No</td>
<td>JSON array of bits</td>
<td>
<p>Credentials are specified using a JSON object. There are three key names: <strong>email</strong> for access to SMTP, <strong>api</strong> for programmatic access, and <strong>web</strong> for administration. The values for each are a bit, 0 for off or 1 for on.</p>

<p> The following example allows the specified username/password to log into the dashboard, but <em>not</em> send email or have access to any of the APIs:</p>

<code>{"email": 0, "web": 1, "api": 0}</code>
</td>
      </tr>
    </tbody>
  </table>

{% apiexample add POST https://api.sendgrid.com/api/credentials/add api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name&password=password&permissions={"email": 0, "web": 1, "api": 0} %}
  {% response json %}
//success
{
  "message": "success"
}

//error
{
  "error": "error reason"
}
  {% endresponse %}
  {% response xml %}
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- success -->
<result>
   <count>4</count>
</result>

<!-- error -->
<result>
   <message>error: reason</message>
</result>
  {% endresponse %}

{% endapiexample %}

<h2>Edit</h2>


<table class="table table-bordered table-striped">
    <tbody>
      <tr>
        <th>Parameter</th>
        <th>Required</th>
<th>Requirements</th>
        <th>Description</th>
      </tr>
      <tr>
        <td>api_user</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The primary account holder's user ID creating the new
        account</td>
      </tr>
      <tr>
        <td>api_key</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The primary account holder's password</td>
      </tr>

      <tr>
        <td>username</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The existing credentials to edit</td>
      </tr>

      <tr>
        <td>password</td>
<td>No</td>
        <td>alphanumeric</td>
        <td>Optionally update the password</td>
      </tr>

      <tr>
        <td>permissions</td>
        <td>No</td>
<td>JSON array of bits</td>
<td>
<p>Credentials are specified using a JSON object. There are three key names: <strong>email</strong> for access to SMTP, <strong>api</strong> for programmatic access, and <strong>web</strong> for administration. The values for each are a bit, 0 for off or 1 for on.</p>

<p> The following example allows the specified username/password to log into the dashboard, but <em>not</em> send email or have access to any of the APIs:</p>

<code>{"email": 0, "web": 1, "api": 0}</code>

<p> If you do not specify any additional parameters (i.e., email, web, api), then no permissions will be changed. This behavior allows you to change passwords without having to lookup the current applied permissions.</p>
</td>
      </tr>
    </tbody>
  </table>

{% apiexample edit POST https://api.sendgrid.com/api/credentials/edit api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name&password=password&permissions={"email": 0, "web": 1, "api": 0} %}
  {% response json %}
//success
{
  "message": "success"
}

//error
{
  "error": "error reason"
}
  {% endresponse %}
  {% response xml %}
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- success -->
<result>
   <count>4</count>
</result>

<!-- error -->
<result>
   <message>error: reason</message>
</result>
  {% endresponse %}

{% endapiexample %}

<hr/>

<h2>Delete</h2>

<table class="table table-bordered table-striped">
    <tbody>
      <tr>
        <th>Parameter</th>
        <th>Required</th>
<th>Requirements</th>
        <th>Description</th>
      </tr>
      <tr>
        <td>api_user</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The primary account holder's user ID creating the new
        account</td>
      </tr>
      <tr>
        <td>api_key</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The primary account holder's password</td>
      </tr>
      <tr>
        <td>username</td>
<td>Yes</td>
        <td>alphanumeric</td>
        <td>The credential to remove</td>
      </tr>
</tbody>
</table>

{% apiexample remove POST https://api.sendgrid.com/api/credentials/remove api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name %}
  {% response json %}
//success
{
  "message": "success"
}

//error
{
  "error": "error reason"
}
  {% endresponse %}
  {% response xml %}
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- success -->
<result>
   <count>4</count>
</result>

<!-- error -->
<result>
   <message>error: reason</message>
</result>
  {% endresponse %}

{% endapiexample %}
Something went wrong with that request. Please try again.