Dataset: Credentials

Dataset name: ds_credentials

Description

Details of the member's credentials (passwords) and associated details.

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Autofill	cred_autofill	Flag set if the details are used to autofill the website page	text	Yes
Date Created	cred_date_created	Date the record was created	date	1638375529
Date Modified	cred_date_modified	Date when the record was last modified	date	1638375529
Email	cred_email	email address, if different from the username	text	john@email.com
Notes	cred_notes	Additional notes	text	Notes
Passphrase	cred_passphrase	A unique code the member has set up for an account (distinct from password)	text	987654DGF
Password	cred_password	Member's password on the website	text	*password*
Recovery Email	cred_recovery_email	Email address used for account recovery (not the one registered for the service)	text	john@email-recovery.com
Recovery Phone	cred_recovery_phone	Telephone number used for account recovery	text	07123456789
Title	cred_title	Identifying name for the record	text	Google
URL	cred_url	Web site to which the password applies	text	www.google.com
Username	cred_username	Member's username on the website	text	JohnyD
ID	id	Reference number for the record	number	21
Credentials Instance	instance	The instance this record relates to.	int	2
Credentials Source	source	The source of the data - user or connection.	varchar

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_credentials
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "21": {
    "id": "21",
    "ds_id": "21",
    "cred_autofill": "Yes",
    "cred_date_created": "1638375529",
    "cred_date_modified": "1638375529",
    "cred_email": "john@email.com",
    "cred_notes": "Notes",
    "cred_passphrase": "987654DGF",
    "cred_password": "*password*",
    "cred_recovery_email": "john@email-recovery.com",
    "cred_recovery_phone": "07123456789",
    "cred_title": "Google",
    "cred_url": "www.google.com",
    "cred_username": "JohnyD"
  }
}