1Password

App · 18 actions

Use 1Password in your workflows: read a secret or one-time password, find, create, update and delete items, download attached files, and watch sign-in attempts, item usage and audit events.

Actions

ActionWhat it does
Check Connect serverCheck your Connect server is up and in sync with 1Password: its version and the state of each part it relies on.
Check events accessCheck the Events Reporting bearer token works, and which events it can read: sign-in attempts, item usage and audit events.
Create itemSave a new login, password, API credential, secure note, database or server in a vault.
Delete itemDelete an item for good.
Download fileDownload a file attached to an item, such as a certificate or a key file, for later steps to send or read.
Find item by titleFind the item with this exact title, in one vault or every vault the token reaches, with its fields.
Get itemGet an item with every field and its value, such as its username and password.
Get one-time passwordGet the current code of an item's one-time password, for a two-step sign-in.
Get secretGet one field's value from an item, such as its password or an API key, ready to use in the next step.
Get vaultGet one vault's details: its name, kind and item count.
List audit eventsList what team members did in your 1Password account over a time range, such as inviting people, changing vault access or exporting data.
List Connect activityList recent requests to your Connect server, newest first: which token read, created, changed or deleted which vault or item, and whether it was allowed.
List item filesList the files attached to an item, with their sizes.
List item usageList who used items in shared vaults over a time range, and how: revealed, copied, filled, edited or shared.
List itemsList the items in a vault by title, without their secrets.
List sign-in attemptsList attempts to sign in to your 1Password account over a time range, failed and successful: who, when, from where, and why a failed one failed.
List vaultsList the vaults your Connect server's access token can reach, with how many items each holds.
Update itemChange an item's title, username, password, website, notes, tags or any field by name, or give it a new made-up password.

Check Connect server

Check your Connect server is up and in sync with 1Password: its version and the state of each part it relies on.

Inputs

None.

Outputs

all_activetrue/false
True when every service is ACTIVE
dependencieslist
The services it relies on
nametext
The server's name
versiontext
The Connect server's version
Example output
{
  "all_active": true,
  "dependencies": [
    {
      "message": "",
      "service": "sync",
      "status": "ACTIVE"
    },
    {
      "message": "Connected to ~/1password.sqlite",
      "service": "sqlite",
      "status": "ACTIVE"
    }
  ],
  "name": "1Password Connect API",
  "version": "1.7.3"
}

Check events access

Check the Events Reporting bearer token works, and which events it can read: sign-in attempts, item usage and audit events.

Inputs

None.

Outputs

account_uuidtext
The 1Password account's ID
events_hosttext
Where your account's events are read, such as events.1password.com
featureslist
What it can read: signinattempts, itemusages, auditevents
integration_uuidtext
The Events Reporting integration's ID
issued_attext
When the token was issued
Example output
{
  "account_uuid": "M4E2SWNZAZFTRGQGDNS2E5A4MU",
  "events_host": "events.1password.com",
  "features": [
    "auditevents",
    "itemusages",
    "signinattempts"
  ],
  "integration_uuid": "OK41XEGLRTH4YKO5YRTCPNX3IU",
  "issued_at": "2023-03-05T16:32:50-03:00"
}

Create item

Save a new login, password, API credential, secure note, database or server in a vault. Leave the password empty to have a strong one made up.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
TitletitletextRequired
The item's title.
Kind of itemcategorytext
What the item is. Defaults to a login.One of: LOGIN, PASSWORD, API_CREDENTIAL (API credential), SECURE_NOTE (Secure note), DATABASE, SERVER. Default: LOGIN.
Usernameusernametext
The username or email address it signs in with.
Passwordpasswordtext
The password, or for an API credential the key itself. Leave empty to have one made up (not for an API credential or a secure note).
Password lengthpassword_lengthnumber
How long a made-up password is, 1 to 64 characters. Defaults to 32.From 1 to 64.
Websitewebsitetext
The website the item signs in to, such as https://github.com.
Notesnotestext
The item's notes.
Tagstagslist
Tags to find the item by.
Other fieldsother_fieldsobject
More fields by name and value, such as hostname or port for a database.

Outputs

itemobject
The item, with its fields
valuesobject
Each field's value by its name, such as username and password. A name used in two sections is given as Section.name.
Example output
{
  "item": {
    "category": "LOGIN",
    "createdAt": "2021-04-10T17:20:05.98944527Z",
    "favorite": false,
    "fields": [
      {
        "id": "username",
        "label": "username",
        "purpose": "USERNAME",
        "section": {
          "id": ""
        },
        "totp": "",
        "type": "STRING",
        "value": "wendy"
      },
      {
        "id": "password",
        "label": "password",
        "purpose": "PASSWORD",
        "section": {
          "id": ""
        },
        "totp": "",
        "type": "CONCEALED",
        "value": "mjXehR*uCj!aoe!iktt9KMtWb"
      },
      {
        "id": "boot3vsxwhuht6g7cmcx4m6rcm",
        "label": "Recovery Key",
        "purpose": "",
        "section": {
          "id": "95cdbc3b-7742-47ec-9056-44d6af82d562"
        },
        "totp": "",
        "type": "CONCEALED",
        "value": "s=^J@GhHP_isYP>LCq?vv8u7T:*wBP.c"
      }
    ],
    "files": [
      {
        "content_path": "v1/vaults/ytrfte14kw1uex5txaore1emkz/items/2fcbqwe9ndg175zg2dzwftvkpa/files/6r65pjq33banznomn7q22sj44e/content",
        "id": "6r65pjq33banznomn7q22sj44e",
        "name": "testfile.txt",
        "section": {
          "id": ""
        },
        "size": 35
      }
    ],
    "id": "2fcbqwe9ndg175zg2dzwftvkpa",
    "lastEditedBy": "LKGNQ7XGVBAJ7MMFLHOXKSYV2Q",
    "sections": [
      {
        "id": "95cdbc3b-7742-47ec-9056-44d6af82d562",
        "label": "Security Questions"
      }
    ],
    "state": "",
    "tags": [
      "connect"
    ],
    "title": "Secrets Automation Item",
    "updatedAt": "2021-04-13T17:20:05.989445411Z",
    "urls": [
      {
        "href": "https://example.com",
        "label": "website",
        "primary": true
      }
    ],
    "vault": {
      "id": "ytrfte14kw1uex5txaore1emkz"
    },
    "version": 2
  },
  "values": {
    "Recovery Key": "s=^J@GhHP_isYP>LCq?vv8u7T:*wBP.c",
    "password": "mjXehR*uCj!aoe!iktt9KMtWb",
    "username": "wendy"
  }
}

Delete item

Delete an item for good. It doesn't go to Recently Deleted, so it can't be restored.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
ItemitemtextRequired
The item. Pick one, or give its ID or exact title.

Outputs

deletedtrue/false
Always true once deleted
item_idtext
The deleted item's ID
vault_idtext
The vault it was in
Example output
{
  "deleted": true,
  "item_id": "2fcbqwe9ndg175zg2dzwftvkpa",
  "vault_id": "ytrfte14kw1uex5txaore1emkz"
}

Download file

Download a file attached to an item, such as a certificate or a key file, for later steps to send or read. A small text file's contents are also given as text.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
ItemitemtextRequired
The item. Pick one, or give its ID or exact title.
Filefile_idtextRequired
The file. Pick one, or give its ID or name.

Outputs

content_typetext
The file's type
document_reftext
Reference to the saved file, for a later step
documentslist
The file, in the shape steps that send or upload files expect
file_idtext
The file's ID
filenametext
The file's name
size_bytesnumber
The file's size in bytes
texttext
The file's contents, when it is a small text file such as a key or certificate; empty otherwise
urltext
Download link for the saved file
Example output
{
  "content_type": "text/plain",
  "document_ref": "doc_5e6f708192a3b4c55e6f708192a3b4c5",
  "documents": [
    {
      "content_type": "text/plain",
      "document_ref": "doc_5e6f708192a3b4c55e6f708192a3b4c5",
      "filename": "testfile.txt",
      "size_bytes": 35,
      "url": "/actions/core/serve-document/doc_5e6f708192a3b4c55e6f708192a3b4c5"
    }
  ],
  "file_id": "6r65pjq33banznomn7q22sj44e",
  "filename": "testfile.txt",
  "size_bytes": 35,
  "text": "The future belongs to the curious.\n",
  "url": "/actions/core/serve-document/doc_5e6f708192a3b4c55e6f708192a3b4c5"
}

Find item by title

Find the item with this exact title, in one vault or every vault the token reaches, with its fields. Finding none isn't an error: 'found' is false, so a workflow can create it instead.

Inputs

TitletitletextRequired
The item's exact title.
Vaultvaulttext
Look only in this vault. Leave empty to look in all.

Outputs

foundtrue/false
Whether an item has this title
itemobject
The item, with its fields
match_countnumber
How many items have this title
valuesobject
Each field's value by its name, such as username and password. A name used in two sections is given as Section.name.
Example output
{
  "found": true,
  "item": {
    "category": "LOGIN",
    "createdAt": "2021-04-10T17:20:05.98944527Z",
    "favorite": false,
    "fields": [
      {
        "id": "username",
        "label": "username",
        "purpose": "USERNAME",
        "section": {
          "id": ""
        },
        "totp": "",
        "type": "STRING",
        "value": "wendy"
      },
      {
        "id": "password",
        "label": "password",
        "purpose": "PASSWORD",
        "section": {
          "id": ""
        },
        "totp": "",
        "type": "CONCEALED",
        "value": "mjXehR*uCj!aoe!iktt9KMtWb"
      },
      {
        "id": "boot3vsxwhuht6g7cmcx4m6rcm",
        "label": "Recovery Key",
        "purpose": "",
        "section": {
          "id": "95cdbc3b-7742-47ec-9056-44d6af82d562"
        },
        "totp": "",
        "type": "CONCEALED",
        "value": "s=^J@GhHP_isYP>LCq?vv8u7T:*wBP.c"
      }
    ],
    "files": [
      {
        "content_path": "v1/vaults/ytrfte14kw1uex5txaore1emkz/items/2fcbqwe9ndg175zg2dzwftvkpa/files/6r65pjq33banznomn7q22sj44e/content",
        "id": "6r65pjq33banznomn7q22sj44e",
        "name": "testfile.txt",
        "section": {
          "id": ""
        },
        "size": 35
      }
    ],
    "id": "2fcbqwe9ndg175zg2dzwftvkpa",
    "lastEditedBy": "LKGNQ7XGVBAJ7MMFLHOXKSYV2Q",
    "sections": [
      {
        "id": "95cdbc3b-7742-47ec-9056-44d6af82d562",
        "label": "Security Questions"
      }
    ],
    "state": "",
    "tags": [
      "connect"
    ],
    "title": "Secrets Automation Item",
    "updatedAt": "2021-04-13T17:20:05.989445411Z",
    "urls": [
      {
        "href": "https://example.com",
        "label": "website",
        "primary": true
      }
    ],
    "vault": {
      "id": "ytrfte14kw1uex5txaore1emkz"
    },
    "version": 2
  },
  "match_count": 1,
  "values": {
    "Recovery Key": "s=^J@GhHP_isYP>LCq?vv8u7T:*wBP.c",
    "password": "mjXehR*uCj!aoe!iktt9KMtWb",
    "username": "wendy"
  }
}

Get item

Get an item with every field and its value, such as its username and password. 'values' holds each field by name.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
ItemitemtextRequired
The item. Pick one, or give its ID or exact title.

Outputs

itemobject
The item, with its fields
valuesobject
Each field's value by its name, such as username and password. A name used in two sections is given as Section.name.
Example output
{
  "item": {
    "category": "LOGIN",
    "createdAt": "2021-04-10T17:20:05.98944527Z",
    "favorite": false,
    "fields": [
      {
        "id": "username",
        "label": "username",
        "purpose": "USERNAME",
        "section": {
          "id": ""
        },
        "totp": "",
        "type": "STRING",
        "value": "wendy"
      },
      {
        "id": "password",
        "label": "password",
        "purpose": "PASSWORD",
        "section": {
          "id": ""
        },
        "totp": "",
        "type": "CONCEALED",
        "value": "mjXehR*uCj!aoe!iktt9KMtWb"
      },
      {
        "id": "boot3vsxwhuht6g7cmcx4m6rcm",
        "label": "Recovery Key",
        "purpose": "",
        "section": {
          "id": "95cdbc3b-7742-47ec-9056-44d6af82d562"
        },
        "totp": "",
        "type": "CONCEALED",
        "value": "s=^J@GhHP_isYP>LCq?vv8u7T:*wBP.c"
      }
    ],
    "files": [
      {
        "content_path": "v1/vaults/ytrfte14kw1uex5txaore1emkz/items/2fcbqwe9ndg175zg2dzwftvkpa/files/6r65pjq33banznomn7q22sj44e/content",
        "id": "6r65pjq33banznomn7q22sj44e",
        "name": "testfile.txt",
        "section": {
          "id": ""
        },
        "size": 35
      }
    ],
    "id": "2fcbqwe9ndg175zg2dzwftvkpa",
    "lastEditedBy": "LKGNQ7XGVBAJ7MMFLHOXKSYV2Q",
    "sections": [
      {
        "id": "95cdbc3b-7742-47ec-9056-44d6af82d562",
        "label": "Security Questions"
      }
    ],
    "state": "",
    "tags": [
      "connect"
    ],
    "title": "Secrets Automation Item",
    "updatedAt": "2021-04-13T17:20:05.989445411Z",
    "urls": [
      {
        "href": "https://example.com",
        "label": "website",
        "primary": true
      }
    ],
    "vault": {
      "id": "ytrfte14kw1uex5txaore1emkz"
    },
    "version": 2
  },
  "values": {
    "Recovery Key": "s=^J@GhHP_isYP>LCq?vv8u7T:*wBP.c",
    "password": "mjXehR*uCj!aoe!iktt9KMtWb",
    "username": "wendy"
  }
}

Get one-time password

Get the current code of an item's one-time password, for a two-step sign-in.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
ItemitemtextRequired
The item. Pick one, or give its ID or exact title.

Outputs

codetext
The current code
item_idtext
The item's ID
item_titletext
The item's title
labeltext
The one-time password field's name
vault_idtext
The vault's ID
Example output
{
  "code": "123456",
  "item_id": "2fcbqwe9ndg175zg2dzwftvkpa",
  "item_title": "Secrets Automation Item",
  "label": "one-time password",
  "vault_id": "ytrfte14kw1uex5txaore1emkz"
}

Get secret

Get one field's value from an item, such as its password or an API key, ready to use in the next step.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
ItemitemtextRequired
The item. Pick one, or give its ID or exact title.
Fieldfield_labeltextRequired
The field's name, such as password, username or credential. For a field in a section, Section.name.

Outputs

field_idtext
The field's ID
item_idtext
The item's ID
item_titletext
The item's title
labeltext
The field's name
one_time_codetext
The current one-time password, when the field holds one
typetext
The field's type, such as CONCEALED for a hidden one
valuetext
The field's value
vault_idtext
The vault's ID
Example output
{
  "field_id": "password",
  "item_id": "2fcbqwe9ndg175zg2dzwftvkpa",
  "item_title": "Secrets Automation Item",
  "label": "password",
  "one_time_code": "",
  "type": "CONCEALED",
  "value": "mjXehR*uCj!aoe!iktt9KMtWb",
  "vault_id": "ytrfte14kw1uex5txaore1emkz"
}

Get vault

Get one vault's details: its name, kind and item count.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.

Outputs

vaultobject
A vault
Example output
{
  "vault": {
    "attributeVersion": 1,
    "contentVersion": 72,
    "createdAt": "2021-04-10T17:34:26Z",
    "description": "Secrets for the deploy pipeline",
    "id": "ytrfte14kw1uex5txaore1emkz",
    "items": 7,
    "name": "Demo",
    "type": "USER_CREATED",
    "updatedAt": "2021-04-13T14:33:50Z"
  }
}

List audit events

List what team members did in your 1Password account over a time range, such as inviting people, changing vault access or exporting data.

Inputs

Fromstartdate and time
Only events from this time on. Defaults to 24 hours before 'Until'.
Untilenddate and time
Only events before this time. Defaults to now.
Page sizelimitnumber
How many events to read, 1 to 1000. Defaults to 100.From 1 to 1000.
Next pagecursortext
The 'cursor' from an earlier list, to read the events after it. 'From', 'Until' and 'Page size' are then ignored.

Outputs

countnumber
How many events on this page
cursortext
Pass as 'Next page' to get the events after these
eventslist
The audit events
has_moretrue/false
True when more events are waiting after these
Example output
{
  "count": 1,
  "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK",
  "events": [
    {
      "action": "join",
      "actor_details": {
        "email": "jeff_shiner@agilebits.com",
        "name": "Jeff Shiner",
        "uuid": "4HCGRGYCTRQFBMGVEGTABYDU2V"
      },
      "actor_uuid": "4HCGRGYCTRQFBMGVEGTABYDU2V",
      "aux_details": {
        "email": "wendy_appleseed@agilebits.com",
        "name": "Wendy Appleseed",
        "uuid": "K6VFYDCJKHGGDI7QFAXX65LCDY"
      },
      "aux_id": 9277034,
      "aux_info": "R",
      "aux_uuid": "K6VFYDCJKHGGDI7QFAXX65LCDY",
      "location": {
        "city": "Toronto",
        "country": "Canada",
        "latitude": 43.5991,
        "longitude": -79.4988,
        "region": "Ontario"
      },
      "object_type": "gm",
      "object_uuid": "pf8soyakgngrphytsyjed4ae3u",
      "session": {
        "device_uuid": "lc5fqgbrcm4plajd8mwncv2b3u",
        "ip": "192.0.2.254",
        "login_time": "2023-03-15T16:33:50-03:00",
        "uuid": "A5K6COGVRVEJXJW3XQZGS7VAMM"
      },
      "timestamp": "2023-03-15T16:33:50-03:00",
      "uuid": "56YE2TYN2VFYRLNSHKPW5NVT5E"
    }
  ],
  "has_more": false
}

List Connect activity

List recent requests to your Connect server, newest first: which token read, created, changed or deleted which vault or item, and whether it was allowed.

Inputs

How manylimitnumber
How many requests to read, 1 to 1000. Defaults to 50.From 1 to 1000.
Skipoffsetnumber
How many of the newest to skip, to read further back.At least 0.

Outputs

countnumber
How many on this page
requestslist
The requests
totalnumber
How many the server has recorded
Example output
{
  "count": 1,
  "requests": [
    {
      "action": "READ",
      "actor": {
        "account": "M4E2SWNZAZFTRGQGDNS2E5A4MU",
        "id": "XW4YUBWKFZCKDJVOWJZJ6KGMHM",
        "jti": "u3ujpqbkxnw7wx7uqs6ljmfbem",
        "requestIp": "192.0.2.10",
        "userAgent": "Lodol (https://lodol.ai)"
      },
      "requestId": "e9f6c9a2-6b1e-4d6b-9c55-1f8f0d4c2a10",
      "resource": {
        "item": {
          "id": "2fcbqwe9ndg175zg2dzwftvkpa"
        },
        "itemVersion": 2,
        "type": "ITEM",
        "vault": {
          "id": "ytrfte14kw1uex5txaore1emkz"
        }
      },
      "result": "SUCCESS",
      "timestamp": "2021-04-13T17:20:05Z"
    }
  ],
  "total": 1134
}

List item files

List the files attached to an item, with their sizes.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
ItemitemtextRequired
The item. Pick one, or give its ID or exact title.

Outputs

countnumber
How many files
fileslist
The files
item_idtext
The item's ID
vault_idtext
The vault's ID
Example output
{
  "count": 1,
  "files": [
    {
      "content_path": "v1/vaults/ytrfte14kw1uex5txaore1emkz/items/2fcbqwe9ndg175zg2dzwftvkpa/files/6r65pjq33banznomn7q22sj44e/content",
      "id": "6r65pjq33banznomn7q22sj44e",
      "name": "testfile.txt",
      "section": {
        "id": ""
      },
      "size": 35
    }
  ],
  "item_id": "2fcbqwe9ndg175zg2dzwftvkpa",
  "vault_id": "ytrfte14kw1uex5txaore1emkz"
}

List item usage

List who used items in shared vaults over a time range, and how: revealed, copied, filled, edited or shared.

Inputs

Fromstartdate and time
Only events from this time on. Defaults to 24 hours before 'Until'.
Untilenddate and time
Only events before this time. Defaults to now.
Page sizelimitnumber
How many events to read, 1 to 1000. Defaults to 100.From 1 to 1000.
Next pagecursortext
The 'cursor' from an earlier list, to read the events after it. 'From', 'Until' and 'Page size' are then ignored.

Outputs

countnumber
How many events on this page
cursortext
Pass as 'Next page' to get the events after these
has_moretrue/false
True when more events are waiting after these
usageslist
The item uses
Example output
{
  "count": 1,
  "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK",
  "has_more": false,
  "usages": [
    {
      "action": "secure-copy",
      "client": {
        "app_name": "1Password Browser",
        "app_version": "20240",
        "ip_address": "192.0.2.254",
        "os_name": "MacOSX",
        "os_version": "13.2",
        "platform_name": "Chrome",
        "platform_version": "120"
      },
      "item_uuid": "SDGD3I4AJYO6RMHRK8DYVNFIDZ",
      "location": {
        "city": "Toronto",
        "country": "Canada",
        "latitude": 43.5991,
        "longitude": -79.4988,
        "region": "Ontario"
      },
      "timestamp": "2023-03-15T16:33:50-03:00",
      "used_version": 0,
      "user": {
        "email": "wendy_appleseed@agilebits.com",
        "name": "Wendy Appleseed",
        "uuid": "4HCGRGYCTRQFBMGVEGTABYDU2V"
      },
      "uuid": "56YE2TYN2VFYRLNSHKPW5NVT5E",
      "vault_uuid": "VZSYVT2LGHTBWBQGUJAIZVRABM"
    }
  ]
}

List items

List the items in a vault by title, without their secrets. Narrow them by tag, kind of item or part of the title.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
Tagtagtext
Only items with this tag.
Kind of itemcategorytext
Only items of this kind, such as logins.One of: LOGIN, PASSWORD, API_CREDENTIAL (API credential), SECURE_NOTE (Secure note), DATABASE, SERVER, CREDIT_CARD (Credit card), BANK_ACCOUNT (Bank account), SSH_KEY (SSH key), SOFTWARE_LICENSE (Software license), and 12 more.
Title containstitle_containstext
Only items whose title contains this, ignoring case.

Outputs

countnumber
How many items
itemslist
The items, by title
vault_idtext
The vault's ID
Example output
{
  "count": 1,
  "items": [
    {
      "category": "LOGIN",
      "createdAt": "2021-04-10T17:20:05.98944527Z",
      "favorite": false,
      "id": "2fcbqwe9ndg175zg2dzwftvkpa",
      "lastEditedBy": "LKGNQ7XGVBAJ7MMFLHOXKSYV2Q",
      "state": "",
      "tags": [
        "connect"
      ],
      "title": "Secrets Automation Item",
      "updatedAt": "2021-04-13T17:20:05.989445411Z",
      "urls": [
        {
          "href": "https://example.com",
          "label": "website",
          "primary": true
        }
      ],
      "vault": {
        "id": "ytrfte14kw1uex5txaore1emkz"
      },
      "version": 2
    }
  ],
  "vault_id": "ytrfte14kw1uex5txaore1emkz"
}

List sign-in attempts

List attempts to sign in to your 1Password account over a time range, failed and successful: who, when, from where, and why a failed one failed.

Inputs

Fromstartdate and time
Only events from this time on. Defaults to 24 hours before 'Until'.
Untilenddate and time
Only events before this time. Defaults to now.
Which attemptsoutcometext
Every attempt, only failed ones, or only successful ones.One of: all (Every attempt), failed (Failed attempts only), succeeded (Successful sign-ins only). Default: all.
Page sizelimitnumber
How many events to read, 1 to 1000. Defaults to 100.From 1 to 1000.
Next pagecursortext
The 'cursor' from an earlier list, to read the events after it. 'From', 'Until' and 'Page size' are then ignored.

Outputs

attemptslist
The attempts
countnumber
How many events on this page
cursortext
Pass as 'Next page' to get the events after these
has_moretrue/false
True when more events are waiting after these
Example output
{
  "attempts": [
    {
      "category": "firewall_failed",
      "client": {
        "app_name": "1Password Browser",
        "app_version": "20240",
        "ip_address": "192.0.2.254",
        "os_name": "MacOSX",
        "os_version": "13.2",
        "platform_name": "Chrome",
        "platform_version": "120"
      },
      "country": "France",
      "details": {
        "value": "Europe"
      },
      "location": {
        "city": "Toronto",
        "country": "Canada",
        "latitude": 43.5991,
        "longitude": -79.4988,
        "region": "Ontario"
      },
      "session_uuid": "A5K6COGVRVEJXJW3XQZGS7VAMM",
      "target_user": {
        "email": "wendy_appleseed@agilebits.com",
        "name": "Wendy Appleseed",
        "uuid": "4HCGRGYCTRQFBMGVEGTABYDU2V"
      },
      "timestamp": "2023-03-15T16:32:50-03:00",
      "type": "continent_blocked",
      "uuid": "56YE2TYN2VFYRLNSHKPW5NVT5E"
    }
  ],
  "count": 1,
  "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK",
  "has_more": false
}

List vaults

List the vaults your Connect server's access token can reach, with how many items each holds.

Inputs

None.

Outputs

countnumber
How many vaults
vaultslist
The vaults
Example output
{
  "count": 1,
  "vaults": [
    {
      "attributeVersion": 1,
      "contentVersion": 72,
      "createdAt": "2021-04-10T17:34:26Z",
      "description": "Secrets for the deploy pipeline",
      "id": "ytrfte14kw1uex5txaore1emkz",
      "items": 7,
      "name": "Demo",
      "type": "USER_CREATED",
      "updatedAt": "2021-04-13T14:33:50Z"
    }
  ]
}

Update item

Change an item's title, username, password, website, notes, tags or any field by name, or give it a new made-up password. Only what you fill in changes.

Inputs

VaultvaulttextRequired
The vault. Pick one, or give its ID or exact name.
ItemitemtextRequired
The item. Pick one, or give its ID or exact title.
New titletitletext
A new title. Leave empty to keep it.
Usernameusernametext
A new username. Leave empty to keep it.
Passwordpasswordtext
A new password, or for an API credential a new key. Leave empty to keep it.
Make up a new passwordnew_passwordtrue/false
Replace the password with a strong made-up one, for rotating it. The new one is in the result.
Password lengthpassword_lengthnumber
How long a made-up password is, 1 to 64 characters. Defaults to 32.From 1 to 64.
Websitewebsitetext
A new main website. Leave empty to keep it.
Notesnotestext
New notes, replacing the old ones. Leave empty to keep them.
Tagstagslist
New tags, replacing the old ones. Leave empty to keep them.
Other fieldsother_fieldsobject
Fields to set by name and value. A field the item doesn't have yet is added.

Outputs

itemobject
The item, with its fields
valuesobject
Each field's value by its name, such as username and password. A name used in two sections is given as Section.name.
Example output
{
  "item": {
    "category": "LOGIN",
    "createdAt": "2021-04-10T17:20:05.98944527Z",
    "favorite": false,
    "fields": [
      {
        "id": "username",
        "label": "username",
        "purpose": "USERNAME",
        "section": {
          "id": ""
        },
        "totp": "",
        "type": "STRING",
        "value": "wendy"
      },
      {
        "id": "password",
        "label": "password",
        "purpose": "PASSWORD",
        "section": {
          "id": ""
        },
        "totp": "",
        "type": "CONCEALED",
        "value": "mjXehR*uCj!aoe!iktt9KMtWb"
      },
      {
        "id": "boot3vsxwhuht6g7cmcx4m6rcm",
        "label": "Recovery Key",
        "purpose": "",
        "section": {
          "id": "95cdbc3b-7742-47ec-9056-44d6af82d562"
        },
        "totp": "",
        "type": "CONCEALED",
        "value": "s=^J@GhHP_isYP>LCq?vv8u7T:*wBP.c"
      }
    ],
    "files": [
      {
        "content_path": "v1/vaults/ytrfte14kw1uex5txaore1emkz/items/2fcbqwe9ndg175zg2dzwftvkpa/files/6r65pjq33banznomn7q22sj44e/content",
        "id": "6r65pjq33banznomn7q22sj44e",
        "name": "testfile.txt",
        "section": {
          "id": ""
        },
        "size": 35
      }
    ],
    "id": "2fcbqwe9ndg175zg2dzwftvkpa",
    "lastEditedBy": "LKGNQ7XGVBAJ7MMFLHOXKSYV2Q",
    "sections": [
      {
        "id": "95cdbc3b-7742-47ec-9056-44d6af82d562",
        "label": "Security Questions"
      }
    ],
    "state": "",
    "tags": [
      "connect"
    ],
    "title": "Secrets Automation Item",
    "updatedAt": "2021-04-13T17:20:05.989445411Z",
    "urls": [
      {
        "href": "https://example.com",
        "label": "website",
        "primary": true
      }
    ],
    "vault": {
      "id": "ytrfte14kw1uex5txaore1emkz"
    },
    "version": 2
  },
  "values": {
    "Recovery Key": "s=^J@GhHP_isYP>LCq?vv8u7T:*wBP.c",
    "password": "mjXehR*uCj!aoe!iktt9KMtWb",
    "username": "wendy"
  }
}

On this page