Skip to main content

Modify SAML App Details​

Select

SaaS
Customer Managed

Updates details of existing SAML app

Path Parameters
  • name string required

    name of SAML app

Request Body
  • description string

    SAML app description

  • enabled boolean

    Boolean to indicate whether SAML is enabled. if disabled then redirection won't happen.

  • autoCreateUser boolean

    This auto-creates non-existing user if the user detail match with the association rules

  • 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.[Email, User Principal Name]

  • 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 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...