upsert federatedIdentityCredential

名前空間: microsoft.graph

アプリケーションまたは agentIdentityBlueprint の新しい federatedIdentityCredential オブジェクトを作成するか、存在しない場合は、既存の federatedIdentityCredential オブジェクトのプロパティを更新します。

Microsoft Entra アプリケーション登録または agentIdentityBlueprint とコンピューティング プラットフォームの ID プロバイダーの間に信頼関係を構成することで、そのプラットフォームによって発行されたトークンを使用して、Microsoft ID プラットフォームで認証し、Microsoft エコシステム内の API を呼び出すことができます。 アプリケーションまたは agentIdentityBlueprint には最大 20 個のオブジェクトを追加できます。

この API は、次の国内クラウド展開で使用できます。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アプリケーションのアクセス許可

agentIdentityBlueprint のアクセス許可

HTTP 要求

アプリケーションの場合:

• アプリケーションは、 ID または appId のいずれかを使用してアドレス指定できます。 id と appId は、Microsoft Entra 管理センターでのアプリの登録において、それぞれオブジェクト ID とアプリケーション (クライアント) ID と呼ばれます。

PATCH /applications/{id}/federatedIdentityCredentials(name='{name}')
PATCH /applications(appId='{appId}')/federatedIdentityCredentials(name='{name}')

agentIdentityBlueprint の場合:

PATCH /applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials(name='{name}')

要求ヘッダー

要求本文

要求の本文で、 federatedIdentityCredential オブジェクトの JSON 表現を指定します。

次の表に、 federatedIdentityCredential を作成するときに必要なプロパティの一覧を示します。 要求 URL の一部として name プロパティが必須であることに注意してください。

応答

成功した場合、 名前 を持つアプリケーション オブジェクトが存在しない場合、このメソッドは 201 Created 応答コードと応答本文の新しい FederatedIdentityCredential オブジェクトを返します。

名前を持つアプリケーション オブジェクトが既に存在する場合、このメソッドは federatedIdentityCredential オブジェクトを更新し、204 No Content応答コードを返します。

例

例 1: アプリケーションが存在しない場合は、アプリケーションの新しい federatedIdentityCredential を作成する

次の例では、指定された 名前 値を持つ federatedIdentityCredential が存在しないため、federatedIdentityCredential を作成します。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/federatedIdentityCredentials(name='fic01-app-65278')
Content-Type: application/json

{
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/$entity",
    "id": "d9b7bf1e-429e-4678-8132-9b00c9846cc4",
    "name": "testing02fic01-app-65278",
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "description": null,
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}

例 2: アプリケーションの既存の federatedIdentityCredential を更新する

次の例では、指定された 名前 値を持つ federatedIdentityCredential が存在するため、federatedIdentityCredential を更新します。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/federatedIdentityCredentials(name='fic01-app-65278')
Content-Type: application/json
Prefer: create-if-missing

{
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content

例 3: agentIdentityBlueprint に存在しない場合に、新しい federatedIdentityCredential を作成する

次の例では、指定された 名前 値を持つ federatedIdentityCredential が存在しないため、agentIdentityBlueprint の federatedIdentityCredential を作成します。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials(name='fic01-app-65278')
Content-Type: application/json

{
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/$entity",
    "id": "d9b7bf1e-429e-4678-8132-9b00c9846cc4",
    "name": "testing02fic01-app-65278",
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "description": null,
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}