getAuthentication

Purpose

Returns the default authentication profile for the tenant. This method is only available for Platform Private Cloud.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getAuthentication

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

Full administrative privileges.

Response

The authentication for the tenant in XML or JSON format.

Examples

Output example in XML format:

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="ok">
<authType>0</authType>
<authDescription>Password</authDescription>
<APIAuthType>0</APIAuthType>
<authAPIDescription>Password</authAPIDescription>
<useSecQuestions>false</useSecQuestions>
<securityLevel>Low</securityLevel>
<expirPolicy>0</expirPolicy>
<enablePasswordHistory>false</enablePasswordHistory>
<passwordHistoryLimit>1</passwordHistoryLimit>
<passwordActivationContextExpiry>2</passwordActivationContextExpiry>
<useKnowledgeFactorToken>true</useKnowledgeFactorToken>
<knowledgeFactorToken>email</knowledgeFactorToken>
<newUserPasswordActivationContextExpiry>2</newUserPasswordActivationContextExpiry>
</resp>

SAML Authentication response:

<resp status="ok">
<authType>9</authType>
<authDescription>SAML/ADFS</authDescription>
<APIAuthType>10</APIAuthType>
<authAPIDescription>API Token</authAPIDescription>
<samlName>Salesforce</samlName>
<issuer>https://rmateti-dev-ed.my.salesforce.com</issuer>
<entityId>
http://nbhydrmateti.bedford.progress.com:8830
</entityId>
<samlIdpLoginUrl>
http://nbhydrmateti.bedford.progress.com:8830/router/login/loginSaml
</samlIdpLoginUrl>
<samlIdpLogoutUrl>https://www.twitter.com</samlIdpLogoutUrl>
<samlAttributeMap>
firstName=givenName|lastName=sn|loginName=uid|city=city
</samlAttributeMap>
<samlAuthnContextComparison>minimum</samlAuthnContextComparison>
 </resp>

Response when viewing the default authentication profile of a customer

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="ok">
<authProfileId>6fba7e5a-64ab-47e8-ba4b-c360c482e280</authProfileId>
<authType>0</authType>
<authDescription>Password</authDescription>
<APIAuthType>0</APIAuthType>
<authAPIDescription>Password</authAPIDescription>
<useSecQuestions>false</useSecQuestions>
<securityLevel>Low</securityLevel>
<expirPolicy>0</expirPolicy>
<enablePasswordHistory>false</enablePasswordHistory>
<passwordHistoryLimit>1</passwordHistoryLimit>
<passwordActivationContextExpiry>2</passwordActivationContextExpiry>
<newUserPasswordActivationContextExpiry>2</newUserPasswordActivationContextExpiry>
<useKnowledgeFactorToken>false</useKnowledgeFactorToken>
</resp>