名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アプリケーションまたは agentIdentityBlueprint のフェデレーション ID 資格情報を参照します。 これらのフェデレーション ID 資格情報は、信頼できる発行者からのトークンをアプリケーションまたはエージェント ID ブループリントにリンクされたアクセス トークンと交換するときに、 ワークロード ID フェデレーション で使用されます。
エンティティ から継承します。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | federatedIdentityCredential のコレクション | フェデレーテッド ID 資格情報オブジェクトとそのプロパティの一覧を取得します。 |
| Create | federatedIdentityCredential | 新しい federatedIdentityCredential オブジェクトを作成します。 |
| Get | federatedIdentityCredential | フェデレーション ID 資格情報オブジェクトのプロパティと関係を読み取ります。 |
| Update | なし | フェデレーション ID 資格情報オブジェクトのプロパティを更新します。 |
| Upsert | federatedIdentityCredential | 新しい federatedIdentityCredential が存在しない場合は作成するか、既存の federatedIdentityCredential オブジェクトのプロパティを更新します。 |
| Delete | なし | フェデレーション ID 資格情報オブジェクトを削除します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| 対象ユーザー | String collection | 外部トークンに表示できる対象ユーザー。 このフィールドは必須であり、Microsoft Entra IDには api://AzureADTokenExchange に設定する必要があります。 これは、受信トークンの aud クレームで受け入れるMicrosoft ID プラットフォーム内容を示します。 この値は、外部 ID プロバイダーの Microsoft Entra ID を表し、ID プロバイダー間で固定された値はありません。このトークンの対象ユーザーとして機能するには、ID プロバイダーで新しいアプリケーション登録を作成する必要がある場合があります。 このフィールドは 1 つの値のみを受け入れることができ、600 文字の制限があります。 必須です。 |
| claimsMatchingExpression | federatedIdentityExpression | Null 許容型。 既定値は null (設定されていない場合) になります。 指定された要求に対して式を一致させる要求の使用を有効にします。
claimsMatchingExpression が定義されている場合、subject は null である必要があります。 サポートされている式の構文と要求の一覧については、 フレキシブル FIC リファレンスを参照してください。 |
| 説明 | String | ユーザーが指定した、検証されていないフェデレーション ID 資格情報の説明。 600 文字の制限があります。 省略可能。 |
| id | 文字列 | フェデレーション ID の一意識別子。 必須です。 読み取り専用です。 |
| 発行者 | 文字列 | 外部 ID プロバイダーの URL。交換される外部トークンの issuer クレームと一致する必要があります。
発行者とサブジェクトの値の組み合わせは、アプリ上で一意である必要があります。 600 文字の制限があります。 必須です。 |
| name | String | フェデレーション ID 資格情報の一意識別子。120 文字の制限があり、URL 対応である必要があります。 一度作成すると変更できません。 代替キー。 必須です。 null 許容ではありません。
$filter (eq)をサポートしています。 |
| subject | 文字列 | Null 許容型。 既定値は null (設定されていない場合) になります。 外部 ID プロバイダー内の外部ソフトウェア ワークロードの識別子。 対象ユーザーの値と同様に、各 ID プロバイダーが独自の形式 (GUID、コロンで区切られた識別子、任意の文字列) を使用するため、固定の形式はありません。 ここでの値は、Microsoft Entra ID に提示されたトークン内のsubクレームと一致する必要があります。
発行者とサブジェクトの組み合わせは、アプリ上で一意である必要があります。 600 文字の制限があります。
subject が定義されている場合は、claimsMatchingExpression がnullである必要があります。
$filter (eq)をサポートしています。 |
リレーションシップ
なし
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.federatedIdentityCredential",
"id": "String (identifier)",
"name": "String",
"issuer": "String",
"subject": "String",
"description": "String",
"audiences": [
"String"
],
"claimsMatchingExpression": {
"@odata.type": "microsoft.graph.federatedIdentityExpression"
}
}