Multiple User Credentials

Multiple User Credentialsは同じサブユーザアカウントで異なるユーザ名とパスワードを利用して複数の利用者がログインを可能にするためのものです。 例えば、ある利用者が退職などをした場合でも、そのアカウントのアクセスを制御することができます。

Get All Subuser Multiple Credentials

サブユーザの認証情報を取得します。

URI引数 必須 条件 説明
task Yes getを指定します サブユーザの全認証情報を取得します
user Yes サブユーザ名 Multiple User Credentialsを取得するサブユーザ
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.credential.json.json
POST Data api_user=apikey&api_key=your_sendgrid_password&task=get&user=subuser_name

Response

1
2
3
4
[
    {"id":12345,"name":"subuser_cred_1","permissions":{"web":1,"api":0,"mail":1}},
    {"id":67890,"name":"subuser_cred_2","permissions":{"mail":1,"api":1,"web":1}}
]

Call

POST https://api.sendgrid.com/apiv2/customer.credential.json.xml
POST Data api_user=apikey&api_key=your_sendgrid_password&task=get&user=subuser_name

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
<result>
        <credential>
            <id>12345</id>
            <name>subuser_cred_1</name>
            <permissions>
                <permission>
                    <web>1</web>
                    <api>0</api>
                    <mail>1</mail>
                </permission>
            </permissions>
        </credential>
        <credential>
            <id>67890</id>
            <name>subuser_cred_2</name>
            <permissions>
                <permission>
                    <web>1</web>
                    <api>1</api>
                    <mail>1</mail>
                </permission>
            </permissions>
        </credential>
    </result>

Add a Subuser Multiple Credential

サブユーザの新しい認証情報を生成します。

URI引数 必須 条件 説明
task Yes addを指定します サブユーザの認証情報を生成します
user Yes サブユーザ名 Multiple User Credentialsを生成するサブユーザ
credential_name Yes 新しいユニークなユーザ名 Multiple User Credentialsを生成したいサブユーザ
credential_password Yes パスワード。パスワードポリシーについては SendGrid password requirementsを参照してください 新しく生成する認証情報のパスワード
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.credential.json.json
POST Data api_user=apikey&api_key=your_sendgrid_password&task=create&user=subuser_name&credential=new_user_name&credential_password=new_credential_password

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.credential.json.xml
POST Data api_user=apikey&api_key=your_sendgrid_password&task=create&user=subuser_name&credential=new_user_name&credential_password=new_credential_password

Response

1
2
3
<result>
      <message>success</message>
   </result>

Edit Subuser Multiple Credential

サブユーザの認証情報を編集します。

URI引数 必須 条件 説明
task Yes editを指定します サブユーザの認証情報を編集します
user Yes サブユーザ名 Multiple User Credentialsを編集するサブユーザ
credential_name Yes ユーザ名 現在のユーザ名
new_credential_password Yes 新しいパスワード。パスワードポリシーについては SendGrid password requirementsを参照してください 新しいパスワード
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.credential.json.json
POST Data api_user=apikey&api_key=your_sendgrid_password&task=edit&user=subuser_name&credential_name=credential_name&new_credential_password=credential_password

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.credential.json.xml
POST Data api_user=apikey&api_key=your_sendgrid_password&task=edit&user=subuser_name&credential_name=credential_name&new_credential_password=credential_password

Response

1
2
3
<result>
      <message>success</message>
   </result>

Delete Subuser Multiple Credential

サブユーザの認証法を削除します。

URI引数 必須 条件 説明
task Yes deleteを指定します サブユーザの認証情報を削除します
user Yes サブユーザ名 Multiple User Credentialsを削除するサブユーザ
credential_name Yes ユーザ名 現在のユーザ名
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.credential.json.json
POST Data api_user=apikey&api_key=your_sendgrid_password&task=delete&user=subuser_name&credential_name=credential_name

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.credential.json.xml
POST Data api_user=apikey&api_key=your_sendgrid_password&task=delete&user=subuser_name&credential_name=credential_name

Response

1
2
3
<result>
      <message>success</message>
   </result>