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