Skip to main content

Create SAML App​

Select

SaaS
Customer Managed

Creates SAML app

Request Body
  • name string required

    SAML name.

  • description string required

    SAML description

  • identityProviderMetaData object required

    SAML IDP meta data request

  • entityId string required

    Identity provider entity ID

  • redirectUrl string required

    Identity provider redirect URL

  • logoutUrl string required

    Identity Provider log-out URL

  • certificateData string required

    IDP certificate public key

  • secondaryCertificateData string

    IDP's secondary certificate

  • SAMLProtocolVersion string required

    SAML Protocol version

  • serviceProviderMetaData object

    SAML service provider meta data

  • serviceProviderEndpoint string required

    Service provider endpoint/entity ID.

  • spAliases string[]

    Service provider endpoint URL list.

  • autoGenerateSPMetaData boolean

    true to generate SP metadata automatically, if false then either [certificateData and JKSPrivateKey] or [jksFileContents, aliasName, privateKeyPassword and keyStorePassword] is required

  • certificateData string

    SP certificate key.

  • JKSPrivateKey string

    SP JKS private key.

  • jksFileContents string[]

    JKS file contents as byte array

  • aliasName string

    certificate alias name

  • privateKeyPassword string

    certificate private key password

  • keyStorePassword string

    JKS contents key store password.

  • associations object
  • emailSuffixes string[]

    Email suffixes associated with SAML

  • companies object[]

    Companies associated with SAML app

  • id int32
  • name string
  • domains object[]

    Domains associated with SAML app

  • id int32
  • name string
  • userGroups object[]

    user groups associated with SAML app

  • id int32
  • name string
  • users object[]

    users associated with SAML app

  • id int32
  • name string
Responses

OK

Schema
  • errorMessage string
  • errorCode int32
Loading...