Logging in as a report user
The Login request authenticates a user to BIRT iHub. A request to log in must include the user’s login name. It also can include:
A password or other credentials.
A domain, the Encyclopedia volume that the user wants to access.
An indicator of whether to return the user’s setting information. The user’s settings include such details as the user’s name or ID number on BIRT iHub System, default printer, e‑mail address, home folder, and viewing preferences. The user’s viewing preference can be either DHTML, LRX, or the default setting for the Encyclopedia volume to which the user logs in.
A list of security roles to validate for the user. You can validate any standard or custom security role by listing the role as a string in ValidateRoles.
The Login response always returns the following elements:
A required AuthId to authenticate the user to BIRT iHub System. All subsequent requests in the current session must include the AuthId in the SOAP header.
A list of BIRT iHub options available for the Encyclopedia volume to which the user is logging in.
The Login response also can return:
The Encyclopedia volume to which the user is logging in. Specify the Encyclopedia volume in the Domain element.
A list of administrative privileges, if the user is an Encyclopedia volume administrator.
Details about the user’s settings, if you set the optional UserSetting request element to True.
The user’s valid security roles from the list provided in Validate Roles request parameter.
The following example shows a request to log in to the Fairfield Encyclopedia volume using a password. The request asks for user settings and provides a list of security roles to verify.
<SOAP-ENV:Body>
<Login>
<User>Kevin Belden</User>
<EncryptedPwd>5hvmuDgEw3E=</EncryptedPwd>
<Domain>Fairfield</Domain>
<UserSetting>true</UserSetting>
<ValidateRoles>
<String>all</String>
<String>Active Portal Intermediate</String>
<String>Regional Managers</String>
</ValidateRoles>
</Login>
</SOAP-ENV:Body>
The preceding request returns the AuthId, the user’s privileges, details about the user, and the BIRT iHub options available. It also returns the security roles that are valid for this user from the list provided in ValidateRoles.
<SOAP-ENV:Body>
<LoginResponse>
<AuthId>m4yxAKHFdgedY0AlOQBTDAZc==</AuthId>
<User>
<Name>Kevin Belden</Name>
<Id>3022</Id>
<Description>Southwest Regional Manager</Description>
<IsLoginDisabled>false</IsLoginDisabled>
<EmailAddress>kbelden@corpus.com</EmailAddress>
<HomeFolder>/Belden</HomeFolder>
<ViewPreference>DHTML</ViewPreference>
<MaxJobPriority>500</MaxJobPriority>
<SuccessNoticeExpiration>14400</SuccessNoticeExpiration>
<FailureNoticeExpiration>14400</FailureNoticeExpiration>
<SendEmailForSuccess>true</SendEmailForSuccess>
<AttachReportInEmail>true</AttachReportInEmail>
<SendNoticeForSuccess>true</SendNoticeForSuccess>
<SendEmailForFailure>true</SendEmailForFailure>
<SendNoticeForFailure>true</SendNoticeForFailure>
<DefaultPrinterName>Sandoval</DefaultPrinterName>
</User>
<FeatureOptions>
<String>ReportGeneration</String>
<String>PageSecureViewing</String>
</FeatureOptions>
<ValidRoles>
<String>all</String>
<String>Regional Managers</String>
</ValidRoles>
</LoginResponse>
</SOAP-ENV:Body>