Single Sign-On Teammates API

SSO Teammates APIでは、SSO Teammateの作成および設定変更を行うことができます。

Create SSO Teammate [POST]

SSO Teammateを作成します。

Request

1

POST https://api.sendgrid.com/v3/sso/teammates HTTP/1.1

Request Body

JSONパラメータ 型 必須 制限 詳細
email string Yes
Teammateのメールアドレス
※IdPでユーザに割り当てられたメールアドレスと一致する必要があります。Teammate作成後にメールアドレスを変更することはできません
first_name string Yes
Teammateの名
last_name string Yes
Teammateの姓
is_admin boolean No
管理者権限を付与する場合はtrue
persona string No accountant, developer, marketer, observerのいずれか
職種ごとの権限セット
※詳細はこちらを参照してください
scopes string配列 No
各機能へのアクセス権限
※指定可能な権限はこちらを参照してください。is_adminがtrueまたはpersonaを指定する場合、scopesは指定できません

親アカウント用のSSO Teammateを作成する場合、is_admin・persona・scopesのどれか1つを指定してください。

1
2
3
4
5
6

{
  "email": "jane_doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "is_admin": true
}

また、以下のパラメータをリクエストに含めるとSSO Teammateのサブユーザへのアクセス権限を設定できます。

JSONパラメータ 型 必須 制限 詳細
has_restricted_subuser_access boolean No
サブユーザ用のSSO Teammateかどうか
※trueを指定すると、サブユーザにのみアクセス可能なTeammateを作成します。subuser_accessパラメータを指定する場合、必ずtrueにしてください。trueの場合、is_admin・persona・scopesは指定できません
subuser_access オブジェクト配列 No
Teammateがアクセス可能なサブユーザ
id integer Yes
サブユーザのID
permission_type string Yes adminまたはrestricted
サブユーザの管理者権限を付与する場合はadmin、権限を限定する場合はrestricted
scopes string配列 No
各機能へのアクセス権限
※permission_typeがrestrictedの場合、機能ごとに権限を指定します。指定可能な権限はこちらを参照してください		 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
  "email": "jane_doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "is_admin": false,
  "has_restricted_subuser_access": true,
  "subuser_access": [
    {
      "id": 12345678,
      "permission_type": "restricted",
      "scopes": [
        "mail.send",
        "mail.batch.create",
        "mail.batch.delete",
        "mail.batch.read",
        "mail.batch.update"
      ]
    }
  ]
}

Response

JSONパラメータ 型 制限 詳細
username string
Teammateのユーザ名
first_name string
Teammateの名
last_name string
Teammateの姓
email string メールアドレス
Teammateのメールアドレス
is_admin boolean
Teammateに管理者権限が付与されているかどうか
is_sso boolean
SSO Teammateかどうか（常にtrue）
scopes string配列
Teammateに割り当てられている権限
has_restricted_subuser_access boolean
サブユーザ用のSSO Teammateかどうか
※trueの場合、Teammateはサブユーザにのみアクセスできます（親アカウントにはアクセスできません）
subuser_access オブジェクト配列
Teammateがアクセス可能なサブユーザ
id integer
サブユーザのID
username string
サブユーザ名
email string メールアドレス
サブユーザのメールアドレス
disabled boolean
サブユーザがアクティブかどうか
permission_type string adminまたはrestricted
Teammateに割り当てられた、サブユーザに対する権限のレベル
scopes string配列
Teammateに割り当てられた、サブユーザに対する権限の一覧 
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

HTTP/1.1 201
{
  "username": "jane_doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "is_admin": false,
  "is_sso": true,
  "has_restricted_subuser_access": true,
  "subuser_access": [
    {
      "id": 12345678,
      "username": "subuser@example.com",
      "email": "subuser@example.com",
      "disabled": false,
      "permission_type": "restricted",
      "scopes": [
        "mail.batch.create",
        "mail.batch.delete",
        "mail.batch.read",
        "mail.batch.update",
        "mail.send"
      ]
    }
  ]
}

Edit an SSO Teammate [PATCH]

SSO Teammateの設定を更新します。

URI引数 必須 条件 説明
username Yes string SSO Teammateのメールアドレス

Request

1

PATCH https://api.sendgrid.com/v3/sso/teammates/{username} HTTP/1.1

Request Body

JSONパラメータ 型 必須 制限 詳細
first_name string Yes
Teammateの名
last_name string Yes
Teammateの姓
is_admin boolean No
管理者権限を付与する場合はtrue
persona string No accountant, developer, marketer, observerのいずれか
職種ごとの権限セット
※詳細はこちらを参照してください
scopes string配列 No
各機能へのアクセス権限
※指定可能な権限はこちらを参照してください。is_adminがtrueまたはpersonaを指定する場合、scopesは指定できません
has_restricted_subuser_access boolean No
サブユーザ用のSSO Teammateかどうか
※trueを指定すると、サブユーザにのみアクセス可能なTeammateを作成します。subuser_accessパラメータを指定する場合、必ずtrueにしてください。このプロパティがtrueの場合、is_admin・persona・scopesは指定できません
subuser_access オブジェクト配列 No
Teammateがアクセス可能なサブユーザ
id integer Yes
サブユーザのID
permission_type string Yes adminまたはrestricted
サブユーザの管理者権限を付与する場合はadmin、権限を限定する場合はrestricted
scopes string配列 No
各機能へのアクセス権限
※permission_typeがrestrictedの場合、機能ごとに権限を指定します。指定可能な権限はこちらを参照してください		 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
  "first_name": "Jane",
  "last_name": "Doe",
  "is_admin": false,
  "has_restricted_subuser_access": true,
  "subuser_access": [
    {
      "id": 12345678,
      "permission_type": "restricted",
      "scopes": [
        "mail.send",
        "mail.batch.create",
        "mail.batch.delete",
        "mail.batch.read",
        "mail.batch.update"
      ]
    }
  ]
}

Response

JSONパラメータ 型 制限 詳細
username string
Teammateのユーザ名
user_type string adminまたはteammate
Teammateに管理者権限が割り当てられている場合はadmin、権限が限定されている場合はteammate
first_name string
Teammateの名
last_name string
Teammateの姓
email string
Teammateのメールアドレス
is_admin boolean
Teammateに管理者権限が付与されているかどうか
is_sso boolean
SSO Teammateかどうか（常にtrue）
scopes string配列
Teammateに割り当てられている権限
has_restricted_subuser_access boolean
trueの場合、Teammateはサブユーザにのみアクセスできます（親アカウントにはアクセスできません）
subuser_access オブジェクト配列
Teammateがアクセス可能なサブユーザ
id integer
サブユーザのID
username string
サブユーザのユーザ名
email string メールアドレス
サブユーザのメールアドレス
disabled boolean
サブユーザがアクティブかどうか
permission_type string adminまたはrestricted
Teammateに割り当てられた、サブユーザに対する権限のレベル
scopes string配列
Teammateに割り当てられた、サブユーザに対する権限の一覧 
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

HTTP/1.1 200
{
  "username": "jane_doe@example.com",
  "user_type": "teammate",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "is_admin": false,
  "is_sso": true,
  "scopes": [
    "user.profile.read"
  ],
  "has_restricted_subuser_access": true,
  "subuser_access": [
    {
      "id": 12345678,
      "username": "subuser@example.com",
      "email": "subuser@example.com",
      "disabled": false,
      "permission_type": "restricted",
      "scopes": [
        "mail.batch.create",
        "mail.batch.delete",
        "mail.batch.read",
        "mail.batch.update",
        "mail.send"
      ]
    }
  ]
}