Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
LoginResult
The login() call returns a LoginResult object, which has the following properties:
| Name | Type | Description |
|---|---|---|
| metadataServerUrl | string | URL of the endpoint that will process subsequent metadata API calls. Your client application needs to set the endpoint. |
| passwordExpired | boolean | Indicates 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. |
| serverUrl | string | URL of the endpoint that will process subsequent API calls. Your client application needs to set the endpoint. |
| sessionId | string | Unique ID associated with this session. Your client application needs to set this value in the session header. |
| userId | ID | ID of the user associated with the specified username and password. |
| userInfo | getUserInfoResult | User information fields. For a list of these fields, see getUserInfoResult. |