Mobile SDK

iOS or Android

API Reference - pims.authentication.account-username

Info: Stellantis Mobile SDK is not publicly available.
Tutorial: check-out Authentication.
SDK Version: v2.2
API Available since: v2.0
API Last update: v2.0
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:

Returns the user login email.

Input Parameters Object
Param name Description Type Unit/Values Example Required
actionType

Action Name, in this case basic.

String

basic

basic true
type

Retrieve username (email).

String

username

username true
Output Data Object
Data name Description Type Unit/Values Example
username

User account email.

String

user@provider.tld

myname@mail.com
Error
No errors
Code Example
1
2
3
4
5
6
7
8
9
10
pims.get("pims.authentication.account",
  mapOf( /* parameters */  
    Pair("actionType", "basic"),
    Pair("type", "username")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }
1
2
3
4
5
6
7
8
9
10
pims.get(api: "pims.authentication.account",
  parameters: [  
    "actionType": "basic",
    "type": "username"
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 
1
2
3
4
5
6
7
8
// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": {
    "username": "myname@mail.com"
  }
}

false