Get SAML Server
Gets details of SAML app based on SAML app name
Path Parameters
- name string required
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
- name string
SAML name.
- appKey string
Unique key for the SAML app
- 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.
userGroup object
id int32name stringcreatedForCompany object
id int32name stringattributeMappings 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 Identity provider meta data response
entityId stringIdentity provider entity
redirectUrl stringIdentity provider redirect URL
logoutUrl stringIdentity Provider log-out URL
serviceProviderMetaData object
entityId stringService provider entity
singleSignOnUrl stringsingle sign on URL
singleLogoutUrl stringsingle log out url
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
{
"name": "string",
"appKey": "string",
"description": "string",
"enabled": true,
"autoCreateUser": true,
"userGroups": [
{
"companyInfo": {
"id": 0,
"name": "string"
},
"userGroupInfo": {
"id": 0,
"name": "string"
}
}
],
"nameIDAttribute": "string",
"userGroup": {
"id": 0,
"name": "string"
},
"createdForCompany": {
"id": 0,
"name": "string"
},
"attributeMappings": [
{
"customAttribute": "COMPANY_NAME",
"SAMLAttribute": "string"
}
],
"identityProviderMetaData": {
"entityId": "string",
"redirectUrl": "string",
"logoutUrl": "string"
},
"serviceProviderMetaData": {
"entityId": "string",
"singleSignOnUrl": "string",
"singleLogoutUrl": "string"
},
"associations": {
"emailSuffixes": [
"string"
],
"companies": [
{
"id": 0,
"name": "string"
}
],
"domains": [
{
"id": 0,
"name": "string"
}
],
"userGroups": [
{
"id": 0,
"name": "string"
}
]
}
}