SAML applications

Create SAML application

Changed on

Create a new SAML application with the given configuration. A default signing certificate with 3 years lifetime will be automatically created.

post/api/saml-applications

Request

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

Request body

namestring required

The name of the SAML application.

descriptionstring nullable

Optional description of the SAML application.

customDataobject

Optional custom data for the application.

entityIdstring nullable
acsUrlstring nullable

The Assertion Consumer Service (ACS) URL where the SAML response will be sent.

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' required

Response

The SAML application was created 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