Login
Authenticates a user to the iHub System.
Request schema
<xsd:complexType name="Login">
<xsd:sequence>
<xsd:element name="User" type="xsd:string"/>
<xsd:element name="Password" type="xsd:string"
minOccurs="0"/>
<xsd:element name="EncryptedPwd" type="xsd:string"
minOccurs="0"/>
<xsd:element name="Credentials" type="xsd:base64Binary"
minOccurs="0"/>
<xsd:element name="Domain" type="xsd:string" minOccurs="0"/>
<xsd:element name="UserSetting" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="ValidateRoles" type="typens:ArrayOfString"
minOccurs="0"/>
<xsd:element name="RunAsUser" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
User
The name of the user to log in.
Password
The password of the user to log in. You must specify either Password or Credentials.
EncryptedPwd
The password in encrypted format.
Credentials
Extended credentials data. Used for Report Server Security Extension (RSSE) integration. You must specify Either Credentials or Password.
Domain
The Encyclopedia volume to which to log in. In Release 11, the Login message must specify the Encyclopedia volume name using TargetVolume in the SOAP header and Domain in the SOAP message body.
UserSetting
Specifies whether the response includes detailed user information. If True, the response includes all user attributes. If False, the response does not include detailed user information. The default value is False.
ValidateRole
Checks whether the user has the specified roles.
RunAsUser
Specifies the user name in the run-time environment.
Response schema
<xsd:complexType=” LoginResponse">
<xsd:sequence>
<xsd:element name="AuthId" type="xsd:string"/>
<xsd:element name="AdminRights" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Administrator"/>
<xsd:enumeration value="Operator"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="User" type="typens:User" minOccurs="0"/>
<xsd:element name="FeatureOptions"
type="typens:ArrayOfString" minOccurs=”0”/>
<xsd:element name="ValidRoles" type="typens:ArrayOfString"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
AuthId
The system-generated, encrypted, and authenticated token that the application uses in all subsequent requests.
AdminRights
Returned if the user has administrator rights.
User
All user attributes except the user’s password.
FeatureOptions
The features available to the user:
ReportGeneration
BIRT option
PageSecureViewing
BIRT Page Level Security option
ValidRoles
The user’s roles from the ValidateRoles list. Does not return the user’s roles that ValidateRoles does not specify. For example, if ValidateRoles specifies Sales, Marketing, and Engineering and the user has Sales and Accounting roles, the response contains only Sales.