Small changes to README.

This commit is contained in:
Markus Birth 2021-08-23 00:24:13 +02:00
parent 1ca9a23ad0
commit 2612993760
Signed by: mbirth
GPG Key ID: A9928D7A098C3A9A

View File

@ -18,67 +18,69 @@ Basic 1Password 1PIF structure
```json ```json
{ {
'contentsHash': 'cf89d854', "contentsHash": "cf89d854",
'createdAt': 1617646219, "createdAt": 1617646219,
'location': 'https://domain.com/', "location": "https://domain.com/",
'locationKey': 'domain.com', "locationKey": "domain.com",
'openContents': { "openContents": {
'tags': ['Tag1', 'Tag2'] "tags": ["Tag1", "Tag2"]
}, },
'secureContents': { "secureContents": {
'URLs': [ "URLs": [
{'label': 'website', 'url': 'https://domain.com/'} {"label": "website", "url": "https://domain.com/"}
], ],
'fields': [ "fields": [
{ {
'designation': 'username', "designation": "username",
'name': 'name_of_username_field_on_website', "name": "name_of_username_field_on_website",
'type': 'T', "type": "T",
'value': 'john.doe' "value": "john.doe"
}, },
{ {
'designation': 'password', "designation": "password",
'name': 'name_of_password_field_on_website', "name": "name_of_password_field_on_website",
'type': 'P', "type": "P",
'value': 'ultrasecurepassword' "value": "ultrasecurepassword"
} }
], ],
'notesPlain': 'This is a note.', "notesPlain": "This is a note.",
'sections': [ "sections": [
{ {
'fields': [ "fields": [
{ {
'inputTraits': {'autocapitalization': 'Words'}, "inputTraits": {"autocapitalization": "Words"},
'k': 'string', "k": "string",
'n': 'org_name', "n": "org_name",
't': 'group', "t": "group",
'v': 'My Organisation' "v": "My Organisation"
}, },
{ {
'inputTraits': {'autocapitalization': 'Words'}, "inputTraits": {"autocapitalization": "Words"},
'k': 'string', "k": "string",
'n': 'member_name', "n": "member_name",
't': 'member name', "t": "member name",
'v': 'John Doe' "v": "John Doe"
} }
] ],
'name': '', "name": "",
'title': '' "title": ""
}, },
{ {
'name': 'linked items', "name": "linked items",
'title': 'Related Items' "title": "Related Items"
// no "fields" structure = empty section // no "fields" structure = empty section
} }
] ]
}, },
'scope': 'Never', "scope": "Never",
'securityLevel': 'SL5', "securityLevel": "SL5",
'title': 'My secret password', "title": "My secret password",
'typeName': 'webforms.WebForm', "typeName": "webforms.WebForm",
'updatedAt': 1618176026, "updatedAt": 1618176026,
'uuid': 'ysd77pxq4zghhodfbo47cewudy'} "uuid": "ysd77pxq4zghhodfbo47cewudy"
}
``` ```
Fields inside the secureContents --> fields structure are to be filled on web-forms. "designation" can be "username" or "password" and means the standard input fields in a 1P record. They are then mapped into the website's form fields via the "name" value.
Fields inside sections can be of various types: text, url, email, address, date, month/year, otp, password or a phone number. Fields inside sections can be of various types: text, url, email, address, date, month/year, otp, password or a phone number.