Identity Federation

Update an Identity Federation app

patch/api/v1/identity-federation

Request body

tenantstring

Tenant

productstring

Product

namestring

Name

acsUrlstring

ACS URL

entityIdstring

Entity ID

logoUrlstring

Logo URL

faviconUrlstring

Favicon URL

primaryColorstring

Primary color

tenantsstring[]

Mapping of tenants whose connections will be grouped under this Identity Federation app

typestring[]

If creating an OIDC app, this should be set to 'oidc' otherwise it defaults to 'saml'

redirectUrlstring[]

If creating an OIDC app, provide the redirect URL

samlAudienceOverridestring

Override the SAML Audience on a per app basis

includeOidcTokensInAssertionboolean

Include OIDC tokens in the SAML assertion

ttlInMinutesnumber

Time-to-live in minutes for the SAML assertion, does not apply to OIDC flows

idstring required

App ID

Response

Success

Changes

Changed in 8 of the 50 revisions of this API.81913

Feb 3, 202604750dcfd4872See the full diff
- ○
  added the new optional request property allOf[IdentityFederationAppCreate]/includeOidcTokensInAssertion
  new-optional-request-property
- ○
  added the optional property data/allOf[IdentityFederationAppCreate]/includeOidcTokensInAssertion to the response with the 200 status
  response-optional-property-added
Jan 18, 2026b0303bb023ff2See the full diff
- ○
  added the new optional request property allOf[IdentityFederationAppCreate]/ttlInMinutes
  new-optional-request-property
- ○
  added the optional property data/allOf[IdentityFederationAppCreate]/ttlInMinutes to the response with the 200 status
  response-optional-property-added
Jun 12, 20250b40e4fcf46924See the full diff
- ▲
  the allOf[IdentityFederationAppCreate]/mappings/items/ request property type/format changed from string/ to object/
  request-property-type-changed
- ▲
  the data/allOf[IdentityFederationAppCreate]/mappings/items/ response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ○
  added the new optional request property allOf[IdentityFederationAppCreate]/mappings/items/key
  new-optional-request-property
- ○
  added the new optional request property allOf[IdentityFederationAppCreate]/mappings/items/value
  new-optional-request-property
- ○
  added the optional property data/allOf[IdentityFederationAppCreate]/mappings/items/key to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/allOf[IdentityFederationAppCreate]/mappings/items/value to the response with the 200 status
  response-optional-property-added
Jun 10, 20258164fb8aa9f52See the full diff
- ○
  added the new optional request property allOf[IdentityFederationAppCreate]/samlAudienceOverride
  new-optional-request-property
- ○
  added the optional property data/allOf[IdentityFederationAppCreate]/samlAudienceOverride to the response with the 200 status
  response-optional-property-added
Apr 30, 20250c7cf3c5abc62192See the full diff
- ▲
  added IdentityFederationAppCreate subschema #2 to the request body allOf list
  request-body-all-of-added
- ▲
  the request's body type/format changed from object/ to /
  request-body-type-changed
- ●
  removed the request property acsUrl
  request-property-removed
- ●
  removed the request property faviconUrl
  request-property-removed
- ●
  removed the request property id
  request-property-removed
- ●
  removed the request property logoUrl
  request-property-removed
- ●
  removed the request property mappings
  request-property-removed
- ●
  removed the request property name
  request-property-removed
- ●
  removed the request property primaryColor
  request-property-removed
- ●
  removed the request property product
  request-property-removed
- ●
  removed the request property tenant
  request-property-removed
- ●
  removed the request property tenants
  request-property-removed
- ●
  removed the optional property acsUrl from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property entityId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property faviconUrl from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property logoUrl from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property primaryColor from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property product from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tenant from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property data to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 200 status
  response-optional-property-added
Mar 20, 2025beea10f3e7fb1See the full diff
- ▲
  removed the media type application/x-www-form-urlencoded from the request body
  request-body-media-type-removed
Feb 5, 2025f02a45abeffc11See the full diff
- ▲
  added required request body
  request-body-added-required
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 22, 2024d49c203898c22See the full diff
- ▲
  removed the request body
  request-body-removed
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history