LoginResult

The login() call returns a LoginResult object, which has the following properties:

NameTypeDescription
metadataServerUrlstringURL of the endpoint that will process subsequent metadata API calls. Your client application needs to set the endpoint.
passwordExpiredbooleanIndicates whether the password used during the login attempt is expired (true) or not (false). If the password has expired, then the API returns a valid sessionId, but the only allowable operation is the setPassword() call.
serverUrlstringURL of the endpoint that will process subsequent API calls. Your client application needs to set the endpoint.
sessionIdstringUnique ID associated with this session. Your client application needs to set this value in the session header.
userIdIDID of the user associated with the specified username and password.
userInfogetUserInfoResultUser information fields. For a list of these fields, see getUserInfoResult.