onepasswordDetailsFields uuid [vault-uuid [account-name]]

onepasswordDetailsFields returns structured data from 1Password using the 1Password CLI (op). uuid is passed to op get item $UUID, the output from op is parsed as JSON, and elements of details.fields are returned as a map indexed by each field's id (if set) or label (if set and id is not present).

If there is no valid session in the environment, by default you will be interactively prompted to sign in.

Info

For 1Password CLI 1.x, the map is indexed by each field's designation.

The output from op is cached so calling onepasswordDetailsFields multiple times with the same uuid will only invoke op once. If the optional vault-uuid is supplied, it will be passed along to the op get call, which can significantly improve performance. If the optional account-name is supplied, it will be passed along to the op get call, which will help it look in the right account, in case you have multiple accounts (e.g. personal and work accounts).

Example

{{ (onepasswordDetailsFields "$UUID").password.value }}
{{ (onepasswordDetailsFields "$UUID" "$VAULT_UUID").password.value }}
{{ (onepasswordDetailsFields "$UUID" "$VAULT_UUID" "$ACCOUNT_NAME").password.value }}
{{ (onepasswordDetailsFields "$UUID" "" "$ACCOUNT_NAME").password.value }}

Example

Given the output from op:

{
    "uuid": "$UUID",
    "details": {
        "fields": [
            {
                "designation": "username",
                "name": "username",
                "type": "T",
                "value": "exampleuser"
            },
            {
                "designation": "password",
                "name": "password",
                "type": "P",
                "value": "examplepassword"
            }
        ]
    }
}

the return value of onepasswordDetailsFields will be the map:

{
    "username": {
        "designation": "username",
        "name": "username",
        "type": "T",
        "value": "exampleuser"
    },
    "password": {
        "designation": "password",
        "name": "password",
        "type": "P",
        "value": "examplepassword"
    }
}

Warning

When using 1Password CLI 2.0, note that the structure of the data returned by the onepasswordDetailsFields template function is different and your templates will need updating.

You may wish to use onepassword, onepasswordItemFields, or onepasswordRead instead of this function, as it may not return expected values. Testing the output of this function is recommended:

$ chezmoi execute-template "{{ onepasswordDetailsFields \"$UUID\" | toJson }}" | jq .