SAML applications

Update SAML application

Changed on

Update SAML application details by ID.

patch/api/saml-applications/{id}

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/saml-applications/{id}
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the saml application.

Request body

namestring

The name of the SAML application.

descriptionstring nullable

Description of the SAML application.

customDataobject

Custom data for the application.

appLevelAccessControlEnabledboolean

Whether app-level access control is enabled for this application.

entityIdstring nullable
acsUrlstring nullable

The Assertion Consumer Service (ACS) URL.

encryptionobject nullable

Validator function

nameIdFormat'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent' | 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress' | 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient' | 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'

Response

The SAML application was updated successfully.

tenantIdstring required
idstring required
namestring required
descriptionstring nullable required
type'Native' | 'SPA' | 'Traditional' | 'MachineToMachine' | 'Protected' | 'SAML' required
customDataobject required

arbitrary

isThirdPartyboolean required
appLevelAccessControlEnabledboolean required
createdAtnumber required
entityIdstring nullable required
encryptionobject nullable required

Validator function

authnRequestConfigobject nullable required

Validator function

nameIdFormat'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent' | 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress' | 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient' | 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified' required

Changes

  • f6be196bc327Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status