Modify SAML App Details
Select
Updates details of existing SAML app
Path Parameters
- name string required
- application/json
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 int32name stringuserGroupInfo object
id int32name string- nameIDAttribute string
nameID in SAML assertion subject is used to perform login.
attributeMappings object[]
attribute mapping details
customAttribute SAMLCustomAttributesPossible values: [
COMPANY_NAME
,EMAIL
,SID
,USER_GROUPS
,USER_GUID
,USER_NAME
]SAML custom attribute types
SAMLAttribute stringSAML attribute
identityProviderMetaData object
SAML IDP meta data request
entityId string requiredIdentity provider entity
redirectUrl string requiredIdentity provider redirect URL
logoutUrl string requiredIdentity Provider log-out URL
certificateData string requiredIDP certificate public key
secondaryCertificateData stringIDP's secondary certificate
SAMLProtocolVersion string requiredSAML Protocol version
serviceProviderMetaData object
SAML service provider meta data
serviceProviderEndpoint string requiredweb console URL.
spAliases string[]web console URL list.
autoGenerateSPMetaData boolean requiredcertificateData stringcertificate alias name.
JKSPrivateKey stringkey store password.
jksFileContents string[]jks file contents as byte array
aliasName stringcertificate alias name
privateKeyPassword stringcertificate private key password
keyStorePassword stringjks contents key store password.
associations object
emailSuffixes string[]Email suffixes associated with SAML
companies object[]
Companies associated with SAML
id int32name stringdomains object[]
Domains associated with SAML
id int32name stringuserGroups object[]
user groups associated with SAML
id int32name string
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}