GET Authentication

Retrieves an Authentication definition, by name, from Sterling External Authentication Server.

With the getauthentication/{authenticationName} method, you can retrieve a predefined Authentication definition on SEAS.

This API method requires authentication. The authentication token generated at login must be passed in through the "X-Authentication" header.

Table 1. GET Authentication names request details
Method	Resource	URI	Description
`GET`	`AuthenticationName`	/seasrest/seas/authentication/{authenticationName}	Get an Authentication object, by name, defined with in IBM SEAS.

Table 2. GET Authentication input parameters
Parameter	Required or Optional	Description	Validation	Valid values
Authentication Name	Required	The name of the Authentication definition as is defined with in SEAS.	Must be a non-empty string	A-Z a-z 0-9 ._-

Table 3. Get Authentication response body parameters
Parameter	Description
XML	The XML corresponding to the Authentication definition.

HTTP Authentication request

The following example shows the HTTP request:

GET https://localhost:9080/seasrest/seas/authentication/{authenticationName}
“X-Authentication”:“61504f4a524b48532b776a3467643733374b526368513d3d” 
"X-Passphrase": "userPassPhrasetoEncrypt_Decrypt_configurationData"

XML Authentication response

The following example shows the XML response.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <XmlResponse>
  <httpCode>200</httpCode>
  <httpStatus>OK</httpStatus>
  <action>None</action>
  <messageLevel>INFO</messageLevel>
  <useraction>None</useraction>
  <results>
  <entry>
  <key>XML</key>
  <value>
  <ldapAuthDef>
  <applicationOutputs>
  </applicationOutputs>
  <assertionDefs></assertionDefs>
  <attributeQueryDefs></attributeQueryDefs>
  <authType>LDAP</authType>
  <bindType>direct</bindType>
  <description>description</description>
  <forceToUnlock>false</forceToUnlock>
  <formatVersion>2</formatVersion>
  <name>user_profile_5</name>
  <ldapBindDef>
  <authMethod>simple</authMethod>
  <host>localhost</host>
  <port>389</port>
  <principal>{userId}</principal>
  <protocol>ldap</protocol>
  <referral>follow</referral>
  <sslInfo>
  <clientAlias></clientAlias>
  <forceToUnlock>false</forceToUnlock>
  <formatVersion>2</formatVersion>
  </sslInfo>
  <startTls>false</startTls>
  </ldapBindDef>
  <verStamp>2</verStamp>
  </ldapAuthDef>
</value>
</entry>
</results>
</XmlResponse>