Multiple Credentials

このAPIはMultiple Credentials機能の管理を行うために使用します。

get

全認証情報の一覧を取得するか、指定した認証情報の権限を取得します。

URI引数 必須 条件 説明
username No 英数字 usernameが指定された場合、APIは指定したユーザの権限を返します
Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/credentials/get.json?api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
  {
    "id": 4,
    "name": "johnsmith",
    "permissions": {
      "email": 0,
      "api": 1
    }
  },
  {
    "id": 15,
    "name": "joewrigley",
    "permissions": {
      "web": 1,
      "api": 0
    }
  }
]

Call

GET https://api.sendgrid.com/api/credentials/get.xml?api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<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>

Add

新しい認証情報を追加することができます。SendGridのパスワードポリシーについては こちら を参照してください。

URI引数 必須 条件 説明
username Yes 英数字 新しいアカウントのusername
password Yes 英数字 新しいアカウントのpassword
permissions No JSON配列によるビット JSONを使って認証情報が指定されます。3つのキーがあります。email : SMTPによるアクセス、api : プログラムからのアクセス、web : 管理、各ビットの値は、0:OFF、1:ON。以下の例は、指定したusername/passwordに対してダッシュボードへのログインを許可しますが、メールの送信とAPIへのアクセスを 禁止 します。{"email": 0, "web": 1, "api": 0}
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/credentials/add.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name&password=password&permissions={"email":

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/credentials/add.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name&password=password&permissions={"email":

Response

1
2
3
<result>
   <count>4</count>
</result>

Edit

SendGridのパスワードポリシーについては SendGrid password requirements も参照してください。

URI引数 必須 条件 説明
username Yes 英数字 編集対象の認証情報
password No 英数字 パスワードの更新
permissions No JSON配列によるビット JSONを使って認証情報が指定されます。3つのキーがあります。email : SMTPによるアクセス、api : プログラムからのアクセス、web : 管理、各ビットの値は、0:OFF、1:ON。以下の例は、指定したusername/passwordに対してダッシュボードへのログインを許可しますが、メールの送信とAPIへのアクセスを 禁止 します。{"email": 0, "web": 1, "api": 0}パラメータ(i.e.email, web, api)を指定しなかった場合、権限は変更されません。この挙動は現在適用されているアクセス権を取得すること無しにパスワードの変更を可能します。
Parameter Value Requirements Description

Call

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

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/credentials/edit.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name&password=password&permissions={"email":0,"web":1,"api":0}

Response

1
2
3
<result>
   <count>4</count>
</result>

Delete

URI引数 必須 条件 説明
username Yes 英数字 削除対象の認証情報
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/credentials/remove.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/credentials/remove.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name

Response

1
2
3
<result>
   <count>4</count>
</result>