Skip to main content

Modify SAML App Details​

Updates details of existing SAML app

Path Parameters
  • name string required
Request Body
  • description string

    SAML description

  • enabled boolean

    Boolean to indicate whether SAML is enabled.

  • autoCreateUser boolean

    This auto-creates non-existing user if the user detail match with the identity rule.

  • userGroups object[]

    By default, auto-created users will be associated to the Tenant Users group of the company. Add mapping to override this behaviour for a company.

  • companyInfo object
  • id int32
  • name string
  • userGroupInfo object
  • id int32
  • name string
  • nameIDAttribute string

    nameID in SAML assertion subject is used to perform login.

  • attributeMappings object[]

    attribute mapping details

  • customAttribute SAMLCustomAttributes

    Possible values: [COMPANY_NAME, EMAIL, SID, USER_GROUPS, USER_GUID, USER_NAME]

    SAML custom attribute types

  • SAMLAttribute string

    SAML attribute

  • identityProviderMetaData object

    SAML IDP meta data request

  • entityId string required

    Identity provider entity

  • redirectUrl string required

    Identity provider redirect URL

  • logoutUrl string required

    Identity Provider log-out URL

  • certificateData string required

    IDP certificate public key

  • SAMLProtocolVersion string required

    SAML Protocol version

  • serviceProviderMetaData object

    SAML service provider meta data

  • serviceProviderEndpoint string required

    web console URL.

  • spAliases string[]

    web console URL list.

  • autoGenerateSPMetaData boolean required
  • certificateData string

    certificate alias name.

  • JKSPrivateKey string

    key store password.

  • 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

  • id int32
  • name string
  • domains object[]

    Domains associated with SAML

  • id int32
  • name string
  • userGroups object[]

    user groups associated with SAML

  • id int32
  • name string
Responses

OK

Schema
  • errorMessage string
  • errorCode int32
Loading...