Federated Authentication to Role Mapping API フェデレーション認証メカニズムを使用する場合、この API を利用することにより、Datadog 内で ID プロバイダーから送信される属性を使用してユーザーグループをロールに自動的にマッピングできます。API を使用して認証マッピングを作成および管理するには、ユーザーはアクセス管理許可を持つ所有者のいるアプリケーションキーを使用する必要があります。
注 : SAML ユーザーであり、既存のベータ版フェデレーションマッピングメカニズム (roles_v2_saml) を使用している方には、この API に移行することを強くお勧めします。
Datadog UI では、ユーザー管理の Mappings タブでマッピングを作成および管理することもできます。詳細については、SAML グループマッピング を参照してください。
下記のすべての API エンドポイントで、次のホストエンドポイントを使用できます。
Datadog リージョンには https://api.datadoghq.com /api/ 。 AuthN Mapping を JSON の本文から新しく作成します。新規作成された AuthN Mapping を返します。
メソッド エンドポイントのパス ペイロードの要件 POST/v2/authn_mappingsJSON
role["data"]["id"]必須 , デフォルトなし]:
マッピング先のロールの ID。Roles API は、Datadog ロール、ロールに付与するグローバルアクセス許可、そのロールに属するユーザーを作成し、管理するために使用できます。
注 : この属性はリクエストされた role 関係を有するブロックの一部として提示する必要があります。詳しくは以下の例を参照してください。作成するロールには ID が割り当てられます。マッピングするロールの ID を探す方法について詳しくは、Role API ドキュメント を参照してください。attributes["attribute_key"]必須 , デフォルトなし]:
attribute_key は、ID プロバイダーから送信される属性を表すキー/値ペアのキーの部分です。各ユーザーのユースケースに合わせてこの 2 つを定義できます。たとえば、attribute_key は member-of に、attribute_value は Development に定義できます。attributes["attribute_value"]必須 , デフォルトなし]:
attribute_value は、ID プロバイダーから送信される属性を表すキー/値ペアの値の部分です。それぞれのユースケースに合わせてこの 2 つを定義できます。たとえば、attribute_key は member-of に、attribute_value は Development に定義できます。curl -X POST \
"https://api.<YOUR_DD_SITE>/api/v2/authn_mappings" \
"Content-Type: application/json" \
"DD-API-KEY: <YOUR_DATADOG_API_KEY>" \
"DD-APPLICATION-KEY: <YOUR_DATADOG_APPLICATION_KEY>" \
'{
"data": {
"type": "authn_mappings",
"attributes": {
"attribute_key": "member-of",
"attribute_value": "Development"
},
"relationships": {
"role": {
"data": {
"id": "123e4567-e89b-12d3-a456-426655445555",
"type": "roles"
}
}
}
}
}'
<YOUR_DATADOG_API_KEY> と <YOUR_DATADOG_APPLICATION_KEY> を、組織の対応するAPI キーとアプリケーションキー に置き換えます。<YOUR_DD_SITE> を datadoghq.com に置き換えます{
"data" : {
"attributes" : {
"created_at" : "2019-11-04 17:41:29.015504" ,
"modified_at" : "2019-11-04 17:41:29.015504" ,
"role_uuid" : "00000000-0000-0000-0000-000000000000" ,
"saml_assertion_attribute_id" : 0
},
"type" : "authn_mappings" ,
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"relationships" : {
"saml_assertion_attribute" : {
"data" : {
"id" : 0 ,
"type" : "saml_assertion_attributes"
}
},
"role" : {
"data" : {
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "roles"
}
}
}
},
"included" : [
{
"data" : {
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "roles" ,
"attributes" : {
"created_at" : "2019-11-04 17:41:29.015504" ,
"modified_at" : "2019-11-06 17:41:29.015504" ,
"name" : "Developer Role"
},
"relationships" : {
"permissions" : {
"data" : [
{
"id" : "123e4567-e89b-12d3-a456-426655441000" ,
"type" : "permissions"
}
]
}
}
}
},
{
"data" : {
"id" : 6 ,
"type" : "saml_assertion_attributes" ,
"attributes" : {
"id" : 6 ,
"attribute_key" : "member-of" ,
"attribute_value" : "Development"
}
}
}
]
}
Copy
AuthN Mapping のリストを返します
メソッド エンドポイントのパス ペイロードの要件 GET/v2/authn_mappingsオプションのクエリパラメーター
sortオプション , デフォルト =created_at ]:
属性を指定した方向で並べ替えます。デフォルトでは昇順に、-<attribute> を指定すると降順に並べ替えます。また、関連属性 role.name、saml_assertion_attribute.attribute_key、saml_assertion_attribute.attribute_value でも並べ替えが可能です。page[number]任意 , デフォルト =0 , 最小値 =0 ]:
結果を返すページの数です。page[サイズ]任意 、デフォルト =10 ]:
各ページに表示する結果の数です。filterオプション , デフォルト =none]:
タグの文字列 (Billing Users など) でフィルタリングします。curl -X GET "https://api.<YOUR_DD_SITE>/api/v2/authn_mappings" \
"DD-API-KEY: <YOUR_DATADOG_API_KEY>" \
"DD-APPLICATION-KEY: <YOUR_DATADOG_APPLICATION_KEY>"
<YOUR_DATADOG_API_KEY> と <YOUR_DATADOG_APPLICATION_KEY> を、組織の対応するAPI キーとアプリケーションキー に置き換えます。<YOUR_DD_SITE> を datadoghq.com に置き換えます{
"data" : [
{
"type" : "authn_mapping" ,
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"relationships" : {
"saml_assertion_attribute" : {
"data" : { "id" : 0 , "type" : "saml_assertion_attributes" }
},
"role" : {
"data" : {
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "roles"
}
}
},
"attributes" : {
"created_at" : "2019-11-04 17:41:29.015504" ,
"modified_at" : "2019-11-04 17:41:29.015504" ,
"saml_assertion_attribute_id" : 0
}
}
],
"included" : [
{
"data" : {
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "roles" ,
"attributes" : {
"created_at" : "2019-11-04 17:41:29.015504" ,
"modified_at" : "2019-11-06 17:41:29.015504" ,
"name" : "Developer Role"
},
"relationships" : {
"permissions" : {
"data" : [
{
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "permissions"
}
]
}
}
}
},
{
"data" : {
"id" : 6 ,
"type" : "saml_assertion_attributes" ,
"attributes" : {
"id" : 6 ,
"attribute_key" : "member-of" ,
"attribute_value" : "Developer"
}
}
}
],
"meta" : {
"page" : {
"total_count" : 1 ,
"total_filtered_count" : 1 ,
}
}
}
Copy
UUID で指定した AuthN Mapping を返します。
メソッド エンドポイントのパス ペイロードの要件 GET/authn_mappings/{authn_mapping_id}URL パラメーター
{authn_mapping_id}必須 , デフォルトなし]:
{authn_mapping_id} を、参照したい AuthN Mapping の ID に置き換えます。curl -X GET "https://api.<YOUR_DD_SITE>/api/v2/authn_mappings/{authn_mapping_id}" \
"DD-API-KEY: <YOUR_DATADOG_API_KEY>" \
"DD-APPLICATION-KEY: <YOUR_DATADOG_APPLICATION_KEY>"
<YOUR_DATADOG_API_KEY> と <YOUR_DATADOG_APPLICATION_KEY> を、組織の対応するAPI キーとアプリケーションキー に置き換えます。<YOUR_DD_SITE> を datadoghq.com に置き換えます{
"data" : {
"attributes" : {
"created_at" : "2019-11-04 17:41:29.015504" ,
"modified_at" : "2019-11-04 17:41:29.015504" ,
"uuid" : "123e4567-e89b-12d3-a456-426655440000" ,
"saml_assertion_attribute_id" : 0
},
"type" : "authn_mappings" ,
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"relationships" : {
"saml_assertion_attribute" : {
"data" : {
"id" : 0 ,
"type" : "saml_assertion_attributes"
}
},
"role" : {
"data" : {
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "roles"
}
}
}
},
"included" : [
{
"data" : {
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "roles" ,
"attributes" : {
"created_at" : "2019-11-04 17:41:29.015504" ,
"modified_at" : "2019-11-06 17:41:29.015504" ,
"uuid" : "123e4567-e89b-12d3-a456-426655440000" ,
"name" : "Developer Role"
},
"relationships" : {
"permissions" : {
"data" : [
{
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "permissions"
}
]
}
}
}
},
{
"data" : {
"id" : 6 ,
"type" : "saml_assertion_attributes" ,
"attributes" : {
"id" : 6 ,
"attribute_key" : "member-of" ,
"attribute_value" : "Developer"
}
}
}
]
}
Copy
AuthN Mapping の role、saml_assertion_attribute_id、あるいはその両方を JSON の本文から更新します。更新された AuthN Mapping を返します。
メソッド エンドポイントのパス ペイロードの要件 PATCH/v2/authn_mappings/{authn_mapping_id}URL パラメーター、JSON
{authn_mapping_id}必須 , デフォルトなし]:
{authn_mapping_id} を、更新したい AuthN Mapping の ID に置き換えます。リクエストのパスと、リクエスト本文の両方でこの設定を行ってください。role["data"]["id"]オプション , デフォルト =none]:
マッピング先のロールの ID。Roles API は、Datadog ロール、ロールに付与するグローバルアクセス許可、そのロールに属するユーザーを作成し、管理するために使用できます。
注 : この属性はリクエストされた role 関係を有するブロックの一部として提示する必要があります。詳しくは以下の例を参照してください。作成するロールには ID が割り当てられます。マッピングするロールの ID を探す方法について詳しくは、Role API ドキュメント を参照してください。attributes["attribute_key"]オプション , デフォルト =none]:
attribute_key は、ID プロバイダーから送信される属性を表すキー/値ペアのキーの部分です。各ユーザーのユースケースに合わせてこの 2 つを定義できます。たとえば、attribute_key は member-of に、attribute_value は Development に定義できます。attributes["attribute_value"]オプション , デフォルト =none]:
attribute_value は、ID プロバイダーから送信される属性を表すキー/値ペアの値の部分です。それぞれのユースケースに合わせてこの 2 つを定義できます。たとえば、attribute_key は member-of に、attribute_value は Development に定義できます。curl -X PATCH \
"https://api.<YOUR_DD_SITE>/api/v2/authn_mappings/{UUID}" \
"Content-Type: application/json" \
"DD-API-KEY: <YOUR_DATADOG_API_KEY>" \
"DD-APPLICATION-KEY: <YOUR_DATADOG_APPLICATION_KEY>" \
'{
"data": {
"type": "authn_mappings",
"id": "{authn_mapping_id}",
"attributes": {
"attribute_key": "member-of",
"attribute_value": "Developer"
}
"relationships": {
"role": {
"data": {
"id": "123e4567-e89b-12d3-a456-426655440000",
"type": "roles"
}
}
}
}
}'
<YOUR_DATADOG_API_KEY> と <YOUR_DATADOG_APPLICATION_KEY> を、組織の対応するAPI キーとアプリケーションキー に置き換えます。<YOUR_DD_SITE> を datadoghq.com に置き換えます{
"data" : {
"attributes" : {
"created_at" : "2019-11-04 17:41:29.015504" ,
"modified_at" : "2019-11-04 17:41:29.015504" ,
"saml_assertion_attribute_id" : 0
},
"type" : "authn_mappings" ,
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"relationships" : {
"saml_assertion_attribute" : {
"data" : {
"id" : 0 ,
"type" : "saml_assertion_attributes"
}
},
"role" : {
"data" : {
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "roles"
}
}
}
},
"included" : [
{
"data" : {
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "roles" ,
"attributes" : {
"created_at" : "2019-11-04 17:41:29.015504" ,
"modified_at" : "2019-11-06 17:41:29.015504" ,
"uuid" : "123e4567-e89b-12d3-a456-426655440000" ,
"name" : "Developer Role"
},
"relationships" : {
"data" : [
{
"id" : "123e4567-e89b-12d3-a456-426655440000" ,
"type" : "permissions"
}
]
}
}
},
{
"data" : {
"id" : 6 ,
"type" : "saml_assertion_attributes" ,
"attributes" : {
"id" : 6 ,
"attribute_key" : "member-of" ,
"attribute_value" : "Developer"
}
}
}
]
}
Copy
指定した AuthN Mapping を削除します。
メソッド エンドポイントのパス ペイロードの要件 DELETE/v2/authn_mappings/{authn_mapping_id}URL パラメーター
{authn_mapping_id}必須 , デフォルトなし]:
{authn_mapping_id} を、削除したい AuthN Mapping の ID に置き換えます。curl -X DELETE "https://api.<YOUR_DD_SITE>/api/v2/authn_mappings/{UUID}" \
"Content-Type: application/json" \
"DD-API-KEY: <YOUR_DATADOG_API_KEY>" \
"DD-APPLICATION-KEY: <YOUR_DATADOG_APPLICATION_KEY>"
<YOUR_DATADOG_API_KEY> と <YOUR_DATADOG_APPLICATION_KEY> を、組織の対応するAPI キーとアプリケーションキー に置き換えます。<YOUR_DD_SITE> を datadoghq.com に置き換えますAuthN Mappings が有効/無効であることを確認します。
メソッド エンドポイントのパス ペイロードの要件 GET/v1/org_preferencesなし
curl -X GET \
"https://api.<YOUR_DD_SITE>/api/v1/org_preferences" \
"Content-Type: application/json" \
"DD-API-KEY: <YOUR_DATADOG_API_KEY>" \
"DD-APPLICATION-KEY: <YOUR_DATADOG_APPLICATION_KEY>" \
<YOUR_DATADOG_API_KEY> と <YOUR_DATADOG_APPLICATION_KEY> を、組織の対応するAPI キーとアプリケーションキー に置き換えます。<YOUR_DD_SITE> を datadoghq.com に置き換えます{
"data" : {
"attributes" : {
"preference_data" : "saml_authn_mapping_roles" ,
"preference_type" : true
},
"type" : "org_preferences" ,
"id" : 1 ,
},
}
Copy
マッピングを有効にすると、SAML でログインしているすべてのユーザーのロールが消去され、各 SAML のアサーション値に基づいてロールの再割り当てが行われます。マッピング機能を有効化する前に、ログインで想定通りの SAML アサーションを受信していることを必ず確認してください。
すべての AuthN マッピングの実行を有効/無効にします。
メソッド エンドポイントのパス ペイロードの要件 POST/v1/org_preferencesJSON
{preference_type}必須 , デフォルトなし]:
アップデートに関する設定です。値は “saml_authn_mapping_roles” となります。{preference_data}必須 , デフォルトなし]:
設定を更新するデータで、true または false を設定します。true の場合はすべてのマッピングを有効化し、false だと無効化します。curl -X POST \
"https://api.<YOUR_DD_SITE>/api/v1/org_preferences" \
"Content-Type: application/json" \
"DD-API-KEY: <YOUR_DATADOG_API_KEY>" \
"DD-APPLICATION-KEY: <YOUR_DATADOG_APPLICATION_KEY>" \
'{
"data": {
"type": "org_preferences",
"attributes": {
"preference_type": "saml_authn_mapping_roles",
"preference_data": true
}
}
}'
`
<YOUR_DATADOG_API_KEY> と <YOUR_DATADOG_APPLICATION_KEY> を、組織の対応するAPI キーとアプリケーションキー に置き換えます。<YOUR_DD_SITE> を datadoghq.com に置き換えます{
"data" : {
"attributes" : {
"preference_type" : "saml_authn_mapping_roles" ,
"preference_data" : true
},
"type" : "org_preferences" ,
"id" : 1 ,
},
}
Copy
