Single Sign-On Settings API

SSO Settings APIでは、SSO統合設定の作成・参照・更新・削除を行うことができます。

弊社経由でご契約いただいたアカウントでは、signout_url（サインアウト後の遷移先URL）を指定しても機能しません。サインアウト後は必ず弊社マイページのログイン画面に遷移します。

completed_integrationは、SSO統合設定の進捗状況を管理するためにユーザ自身が指定するパラメータです。設定が全て完了している場合はtrueを、未完了の場合はfalseをユーザ自身で指定することを推奨します。SendGridがこのパラメータの値を変更することや、値によってSSO統合設定やSSOログインの挙動が変わることはありません。

Create an SSO Integration [POST]

SSOの統合設定を作成します。

Request

1

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

Request Body

JSONパラメータ 型 必須 制限 詳細
name string Yes
作成する統合設定の名前
enabled boolean Yes
統合設定の有効状態
signin_url string Yes
IdPのSAML POSTエンドポイント
※SendGridダッシュボードでは「Embed Link」と呼称します（各IdPでの呼称はこちらを参照）
signout_url string No
サインアウト後の遷移先URL（ページ冒頭の注記参照）
entity_id string Yes
IdPが発行する、SendGridからの認証要求を識別するためのID
※SendGridダッシュボードでは「SAML Issuer ID」と呼称します（各IdPでの呼称はこちらを参照）
completed_integration boolean No
統合設定の進捗状況をユーザ側で管理するためのフラグ（ページ冒頭の注記参照） 
1
2
3
4
5
6

{
  "name": "Twilio SendGrid",
  "enabled": false,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "entity_id": "http://www.okta.com/${org.externalKey}"
}

Response

JSONパラメータ 型 制限 詳細
name string
作成された統合設定の名前
enabled boolean
統合設定の有効状態
signin_url string
IdPのSAML POSTエンドポイント
※SendGridダッシュボードでは「Embed Link」と呼称します（各IdPでの呼称はこちらを参照）
signout_url string
サインアウト後の遷移先URL（ページ冒頭の注記参照）
entity_id string
IdPが発行する、SendGridからの認証要求を識別するためのID
※SendGridダッシュボードでは「SAML Issuer ID」と呼称します（各IdPでの呼称はこちらを参照）
completed_integration boolean
統合設定の進捗状況をユーザ側で管理するためのフラグ（ページ冒頭の注記参照）
last_updated number UNIXタイムスタンプ
設定の最終更新時刻
id string
統合設定に割り当てられた一意のID
single_signon_url string audience_urlと同じURL
IdPがSAMLレスポンスをPOSTするURL（SAMLアサーションを受信して解析するためのSendGridのURL）
audience_url string single_signon_urlと同じURL
IdPがアプリケーション（SendGrid）を特定するために使われるURL 
1
2
3
4
5
6
7
8
9
10
11
12

HTTP/1.1 200
{
   "name": "Twilio SendGrid",
   "enabled": true,
   "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
   "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
   "entity_id": "http://www.okta.com/${org.externalKey}",
   "last_updated": 1714129053,
   "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
   "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
   "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

レスポンスパラメータ「single_signon_url」や「audience_url」で返却されるSendGridのURLは、IdP側でSAMLを設定する際に必要となります（各IdPでの呼称はこちらを参照）。

Get an SSO Integration [GET]

SSO統合設定の情報を取得します。

URI引数 必須 条件 説明
id Yes string SSO統合設定のID
si No boolean trueを指定すると、completed_integrationの値がレスポンスに含まれます

SSO統合設定のIDは、Create an SSO Integration [POST]もしくはGet All SSO Integrations [GET]のレスポンスから取得できます。

Request

1

GET https://api.sendgrid.com/v3/sso/integrations/{id}?si=true HTTP/1.1

Response

JSONパラメータ 型 制限 詳細
name string
作成された統合設定の名前
enabled boolean
統合設定の有効状態
signin_url string
IdPのSAML POSTエンドポイント
※SendGridダッシュボードでは「Embed Link」と呼称します（各IdPでの呼称はこちらを参照）
signout_url string
サインアウト後の遷移先URL（ページ冒頭の注記参照）
entity_id string
IdPが発行する、SendGridからの認証要求を識別するためのID
※SendGridダッシュボードでは「SAML Issuer ID」と呼称します（各IdPでの呼称はこちらを参照）
completed_integration boolean
統合設定の進捗状況をユーザ側で管理するためのフラグ（ページ冒頭の注記参照）
last_updated number UNIXタイムスタンプ
設定の最終更新時刻
id string
統合設定のID
single_signon_url string audience_urlと同じURL
IdPがSAMLレスポンスをPOSTするURL（SAMLアサーションを受信して解析するためのSendGridのURL）
audience_url string single_signon_urlと同じURL
IdPがアプリケーション（SendGrid）を特定するために使われるURL 
1
2
3
4
5
6
7
8
9
10
11
12
13

HTTP/1.1 200
{
   "name": "Twilio SendGrid",
   "enabled": true,
   "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
   "signout_url": "",
   "entity_id": "http://www.okta.com/${org.externalKey}",
   "completed_integration": true,
   "last_updated": 1714129053,
   "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
   "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
   "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Get All SSO Integrations [GET]

アカウントに作成された全てのSSO統合設定の情報を取得します。

URI引数 必須 条件 説明
si No boolean trueを指定すると、completed_integrationの値がレスポンスに含まれます

Request

1

GET https://api.sendgrid.com/v3/sso/integrations?si=true HTTP/1.1

Response

JSONパラメータ 型 制限 詳細
name string
作成された統合設定の名前
enabled boolean
統合設定の有効状態
signin_url string
IdPのSAML POSTエンドポイント
※SendGridダッシュボードでは「Embed Link」と呼称します（各IdPでの呼称はこちらを参照）
signout_url string
サインアウト後の遷移先URL（ページ冒頭の注記参照）
entity_id string
IdPが発行する、SendGridからの認証要求を識別するためのID
※SendGridダッシュボードでは「SAML Issuer ID」と呼称します（各IdPでの呼称はこちらを参照）
completed_integration boolean
統合設定の進捗状況をユーザ側で管理するためのフラグ（ページ冒頭の注記参照）
last_updated number UNIXタイムスタンプ
設定の最終更新時刻
id string
統合設定のID
single_signon_url string audience_urlと同じURL
IdPがSAMLレスポンスをPOSTするURL（SAMLアサーションを受信して解析するためのSendGridのURL）
audience_url string single_signon_urlと同じURL
IdPがアプリケーション（SendGrid）を特定するために使われるURL 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

HTTP/1.1 200
[
  {
    "name": "Twilio SendGrid",
    "enabled": true,
    "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
    "signout_url": "",
    "entity_id": "http://www.okta.com/${org.externalKey}",
    "completed_integration": true,
    "last_updated": 1714129053,
    "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
    "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
    "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
  }
]

Update an SSO Integration [PATCH]

SSO統合設定を更新します。

URI引数 必須 条件 説明
id Yes string SSO統合設定のID
si No boolean trueを指定すると、completed_integrationの値がレスポンスに含まれます

SSO統合設定のIDは、Create an SSO Integration [POST]もしくはGet All SSO Integrations [GET]のレスポンスから取得できます。

Request

1

PATCH https://api.sendgrid.com/v3/sso/integrations/{id}?si=true HTTP/1.1

Request Body

JSONパラメータ 型 必須 制限 詳細
name string Yes
作成された統合設定の名前
enabled boolean Yes
統合設定の有効状態
signin_url string Yes
IdPのSAML POSTエンドポイント
※SendGridダッシュボードでは「Embed Link」と呼称します（各IdPでの呼称はこちらを参照）
signout_url string Yes
サインアウト後の遷移先URL（ページ冒頭の注記参照）
entity_id string Yes
IdPが発行する、SendGridからの認証要求を識別するためのID
※SendGridダッシュボードでは「SAML Issuer ID」と呼称します（各IdPでの呼称はこちらを参照）
completed_integration boolean No
統合設定の進捗状況をユーザ側で管理するためのフラグ（ページ冒頭の注記参照） 
1
2
3
4
5
6

{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "entity_id": "http://www.okta.com/${org.externalKey}"
}

Response

JSONパラメータ 型 制限 詳細
name string
作成された統合設定の名前
enabled boolean
統合設定の有効状態
signin_url string
IdPのSAML POSTエンドポイント
※SendGridダッシュボードでは「Embed Link」と呼称します（各IdPでの呼称はこちらを参照）
signout_url string
サインアウト後の遷移先URL（ページ冒頭の注記参照）
entity_id string
IdPが発行する、SendGridからの認証要求を識別するためのID
※SendGridダッシュボードでは「SAML Issuer ID」と呼称します（各IdPでの呼称はこちらを参照）
completed_integration boolean
統合設定の進捗状況をユーザ側で管理するためのフラグ（ページ冒頭の注記参照）
last_updated number UNIXタイムスタンプ
設定の最終更新時刻
id string
統合設定のID
single_signon_url string audience_urlと同じURL
IdPがSAMLレスポンスをPOSTするURL（SAMLアサーションを受信して解析するためのSendGridのURL）
audience_url string single_signon_urlと同じURL
IdPがアプリケーション（SendGrid）を特定するために使われるURL 
1
2
3
4
5
6
7
8
9
10
11
12
13

HTTP/1.1 200
{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "completed_integration": true,
  "last_updated": 1714129053,
  "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
  "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
  "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Delete an SSO Integration [DELETE]

SSO統合設定を削除します。

URI引数 必須 条件 説明
id Yes string SSO統合設定のID

SSO統合設定のIDは、Create an SSO Integration [POST]もしくはGet All SSO Integrations [GET]のレスポンスから取得できます。

Request

1

DELETE https://api.sendgrid.com/v3/sso/integrations/{id} HTTP/1.1

Response

1

HTTP/1.1 204