Given an authSessionId identifying a valid AuthSession, returns the current status of the AuthSession identified by it.
If authentication is successful this method returns
Internally, what is returned is the value of the ReturnData column.
Parameters
| Name | Type | Description |
|---|---|---|
| authSessionId | String (UUID), required | Id of the auth session to return the status of |
Response Fields
| Name | Type | Description |
|---|---|---|
| authenticated | Boolean | Whether authentication was successful or not |
| providerName | String | Name of the provider the user successfully logged in with |
| actionError | Map | Not null if an error occurred (ie an exception was thrown that could not be recovered from){ |
| actionFailure | Map | Not null if an authentication failure occurred (i.e. wrong username/password){ |
| arbitraryReturnData | Map | Arbitrary information that can be returned from any AuthAction, e.g. token values. May be of use in the future. |
| userConsentedToDataStorage | Boolean | Whether the user consented to having their data from a third party stored or not. |
| siteUser | Map | Contains a single property, UserID |
| loggedinwith | Integer | The ID of the login user the user logged in with to start this session |
Example Request
{
"id": 295,
"jsonrpc": "2.0",
"method": "getAuthStatus",
"params": {
"authSessionId": "9ea979c2-c0da-456e-8ed4-235df4fac8d9"
}
}
Example Response
{
"result": {
"authenticated": true,
"actionError": null,
"arbitraryReturnData": {},
"loggedinwith": 113,
"siteUser": {
"UserID": 1
},
"providerName": "icmsiteuser",
"actionFailure": null
}
}
Share this page
