---
title: "Update an Identity Federation app"
method: PATCH
path: "/api/v1/identity-federation"
tags: ["Identity Federation"]
---

# Update an Identity Federation app

`PATCH /api/v1/identity-federation`

## Request body

- IdentityFederationApp
  - `tenant` string — Tenant
  - `product` string — Product
  - `name` string — Name
  - `acsUrl` string — ACS URL
  - `entityId` string — Entity ID
  - `logoUrl` string — Logo URL
  - `faviconUrl` string — Favicon URL
  - `primaryColor` string — Primary color
  - `tenants` string[] — Mapping of tenants whose connections will be grouped under this Identity Federation app
  - `mappings` AttributeMapping[] — Mapping of attributes from the IdP to SP
    - `key` string — SP attribute
    - `value` string — IdP attribute
  - `type` string[] — If creating an OIDC app, this should be set to 'oidc' otherwise it defaults to 'saml'
  - `redirectUrl` string[] — If creating an OIDC app, provide the redirect URL
  - `samlAudienceOverride` string — Override the SAML Audience on a per app basis
  - `includeOidcTokensInAssertion` boolean — Include OIDC tokens in the SAML assertion
  - `ttlInMinutes` number — Time-to-live in minutes for the SAML assertion, does not apply to OIDC flows
  - `id` string, required — App ID

## Response `200`

Success

- IdentityFederationResponse
  - `data` IdentityFederationApp
    - `tenant` string — Tenant
    - `product` string — Product
    - `name` string — Name
    - `acsUrl` string — ACS URL
    - `entityId` string — Entity ID
    - `logoUrl` string — Logo URL
    - `faviconUrl` string — Favicon URL
    - `primaryColor` string — Primary color
    - `tenants` string[] — Mapping of tenants whose connections will be grouped under this Identity Federation app
    - `mappings` AttributeMapping[] — Mapping of attributes from the IdP to SP
      - `key` string — SP attribute
      - `value` string — IdP attribute
    - `type` string[] — If creating an OIDC app, this should be set to 'oidc' otherwise it defaults to 'saml'
    - `redirectUrl` string[] — If creating an OIDC app, provide the redirect URL
    - `samlAudienceOverride` string — Override the SAML Audience on a per app basis
    - `includeOidcTokensInAssertion` boolean — Include OIDC tokens in the SAML assertion
    - `ttlInMinutes` number — Time-to-live in minutes for the SAML assertion, does not apply to OIDC flows
    - `id` string, required — App ID
  - `error` IdentityFederationError
    - `message` string

## Changes

- **2026-02-03** `04750dcfd487` — 2 info
  - added the new optional request property `allOf[#/components/schemas/IdentityFederationAppCreate]/includeOidcTokensInAssertion`
  - added the optional property `data/allOf[#/components/schemas/IdentityFederationAppCreate]/includeOidcTokensInAssertion` to the response with the `200` status
- **2026-01-18** `b0303bb023ff` — 2 info
  - added the new optional request property `allOf[#/components/schemas/IdentityFederationAppCreate]/ttlInMinutes`
  - added the optional property `data/allOf[#/components/schemas/IdentityFederationAppCreate]/ttlInMinutes` to the response with the `200` status
- **2025-06-12** `0b40e4fcf469` — 2 breaking, 4 info
  - the `allOf[#/components/schemas/IdentityFederationAppCreate]/mappings/items/` request property type/format changed from `string`/`` to `object`/``
  - the `data/allOf[#/components/schemas/IdentityFederationAppCreate]/mappings/items/` response's property type/format changed from `string`/`` to `object`/`` for status `200`
  - added the new optional request property `allOf[#/components/schemas/IdentityFederationAppCreate]/mappings/items/key`
  - added the new optional request property `allOf[#/components/schemas/IdentityFederationAppCreate]/mappings/items/value`
  - …2 more
- …earlier changes not shown

[Full history](https://skmtc.dev/ory/apis/enterprise-sso-directory-sync/changes/api/v1/identity-federation/patch.md)

---

[API](https://skmtc.dev/ory/apis/enterprise-sso-directory-sync.md) · [All operations](https://skmtc.dev/ory/apis/enterprise-sso-directory-sync/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ory/enterprise-sso-directory-sync/revisions/d92c991ace28/schema)