LoginData Object
Contains data associated with a user's login.
This object is used by the following operations:
The properties included in the LoginData object are listed below. Different properties are used in different scenarios; also, the properties returned vary depending on the login option selected by the user, as defined in GET /api/login/ssoLoginInstructions.
| Property | Type | Description |
|---|---|---|
| cookie | string | A cookie that includes updated user signup information. |
| cookieHeader | string | The cookie, sent as a header. |
| authToken | string | Authorization token. |
| authTokenString | string | Authorization token string. |
| LoginResponse | LoginResponse | Contains information returned as a result of logging in. |
| state | string | The current signup state of the user; for example, pending_validation. For a list of valid values, see User Signup State Values. |
| status | string |
Indicates the user's status in terms of login. For valid values, see Login Status. In the response to the POST /api/login operation, you can ignore this value. |
| instructionType | string | Indicates the type of information needed to complete the user login. Required. For valid values, see Login Instruction Types. |
| redirectUrl | string | Required when the value for instructionType is NeedRedirect: the redirect URL the user is sent to for login. |
| identityAttributesNeeded | string | Required when the value for instructionType is NeedCredentials: the identity attributes (for example, Google ID) to be collected from the user for authentication. |
| secretAttributesNeeded | string | Required when the value for instructionType is NeedCredentials: the secret attributes (for example, password) to be collected from the user for authentication. |
| signupCode | string | A unique code generated for the user to complete the signup process. |
| userState | string | The user's signup state. For values, see User Signup State Values. |
