Single Sign-On Certificates API

SSO Certificates APIでは、SSO証明書の作成・更新・削除を行うことができます。

Create an SSO Certificate [POST]

SSO証明書を作成します。

Request

1

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

Request Body

JSONパラメータ 型 必須 制限 詳細
public_certificate string Yes
IdPで発行したX.509証明書
enabled boolean No
証明書が有効かどうか
integration_id string Yes
証明書に関連付けられたSSO統合設定のID 
1
2
3
4
5

{
  "public_certificate": "<IdPで発行したX.509証明書>",
  "enabled": false,
  "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

「integration_id」には、Create an SSO IntegrationエンドポイントでSSO統合設定を作成した際に返却される「id」パラメータの値を指定します。

Response

JSONパラメータ 型 制限 詳細
id number
証明書のID
public_certificate string
IdPで発行したX.509証明書
not_before number UNIXタイムスタンプ
証明書の有効期間の開始日時
not_after number UNIXタイムスタンプ
証明書の有効期間の終了日時
integration_id string
証明書に関連付けられたSSO統合設定のID 
1
2
3
4
5
6
7
8

HTTP/1.1 200
{
  "id": 66138975,
  "public_certificate": "<IdPで発行したX.509証明書>",
  "not_before": 1767193200,
  "not_after": 1798729199,
  "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

レスポンスパラメータ「id」の値は、Get an SSO Certificate [GET]やUpdate SSO Certificate [PATCH]でのリクエスト時に「cert_id」として利用します。

Get an SSO Certificate [GET]

特定のSSO証明書の情報を取得します。

URI引数 必須 条件 説明
cert_id Yes number 証明書のID（証明書作成時にSendGridから付与される）

Request

1

GET https://api.sendgrid.com/v3/sso/certificates/{cert_id} HTTP/1.1

Response

JSONパラメータ 型 制限 詳細
id number
証明書のID
public_certificate string
IdPで発行したX.509証明書
not_before number UNIXタイムスタンプ
証明書の有効期間の開始日時
not_after number UNIXタイムスタンプ
証明書の有効期間の終了日時
integration_id string
証明書に関連付けられたSSO統合設定のID 
1
2
3
4
5
6
7
8

HTTP/1.1 200
{
  "id": 66138975,
  "public_certificate": "<IdPで発行したX.509証明書>",
  "not_before": 1650529139,
  "not_after": 1808295539,
  "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Get All SSO Certificates by Integration [GET]

各SSO統合設定で使用されている全ての証明書の情報を取得します。

URI引数 必須 条件 説明
integration_id Yes string SSO統合設定のID（SSO統合設定の作成時にSendGridから付与される）

Request

1

GET https://api.sendgrid.com/v3/sso/integrations/{integration_id}/certificates HTTP/1.1

Response

JSONパラメータ 型 制限 詳細
id number
証明書のID
public_certificate string
IdPで発行したX.509証明書
not_before number UNIXタイムスタンプ
証明書の有効期間の開始日時
not_after number UNIXタイムスタンプ
証明書の有効期間の終了日時
integration_id string
証明書に関連付けられたSSO統合設定のID 
1
2
3
4
5
6
7
8
9
10

HTTP/1.1 200
[
  {
    "id": 66138975,
    "public_certificate": "<IdPで発行したX.509証明書>",
    "not_before": 1650529139,
    "not_after": 1808295539,
    "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
  }
]

Update SSO Certificate [PATCH]

SSO証明書の情報を更新します。

URI引数 必須 条件 説明
cert_id Yes number 証明書のID（証明書発行時にSendGridから付与される）

Request

1

PATCH https://api.sendgrid.com/v3/sso/certificates/{cert_id} HTTP/1.1

Request Body

JSONパラメータ 型 必須 制限 詳細
public_certificate string No
IdPで発行したX.509証明書
enabled boolean No
証明書が有効かどうか
integration_id string No
証明書に関連付けられたSSO統合設定のID 
1
2
3
4
5

{
  "public_certificate": "<IdPで発行したX.509証明書>",
  "enabled": false,
  "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Response

JSONパラメータ 型 制限 詳細
id number
証明書のID
public_certificate string
IdPで発行したX.509証明書
not_before number UNIXタイムスタンプ
証明書の有効期間の開始日時
not_after number UNIXタイムスタンプ
証明書の有効期間の終了日時
integration_id string
証明書に関連付けられたSSO統合設定のID 
1
2
3
4
5
6
7
8

HTTP/1.1 200
{
  "id": 66138975,
  "public_certificate": "<IdPで発行したX.509証明書>",
  "not_before": 1650529139,
  "not_after": 1808295539,
  "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Delete an SSO Certificate [DELETE]

SSO証明書を削除します。

URI引数 必須 条件 説明
cert_id Yes number 証明書のID（証明書発行時にSendGridから付与される）

Request

1

DELETE https://api.sendgrid.com/v3/sso/certificates/{cert_id} HTTP/1.1

Response

1

HTTP/1.1 204