1Password

1Password is a password manager that helps individuals and businesses securely store and manage passwords, credentials, and sensitive information. The platform provides a Connect Server API for programmatic secrets management, an Events API for security monitoring and audit logging, and a Partnership API for managing partner billing accounts.

3 APIs 8 Features

Password ManagerPasswordsSecuritySecrets

APIs

1Password Connect Server API

The 1Password Connect Server API provides secure access to 1Password items and vaults in your company's apps and cloud infrastructure through a private REST API. Connect Servers...

1Password Events API

The 1Password Events API provides programmatic access to event data generated within a 1Password account. It enables security teams and administrators to retrieve sign-in attemp...

1Password Partnership API

You can use the 1Password Partnership API to manage the provisioning and deprovisioning of third-party partner billing accounts for your customers. The API supports partner bill...

Collections

1Password Connect Server API

POSTMAN

1Password Events API

POSTMAN

1Password Partnership API

POSTMAN

1Password Connect Server API

OPEN

1Password Events API

OPEN

1Password Partnership API

OPEN

Arazzo Workflows

1Password Decommission an Item

Confirm an item exists, then permanently delete it from its vault.

ARAZZO

1Password Download an Item File

Read an item, list its attached files, select one by name, and download its content.

ARAZZO

1Password Provision an Item

Create a new item in a vault and read it back to confirm it was stored.

ARAZZO

1Password Provision Partner Billing

Create a customer partner billing account, read it back, then schedule its end date.

ARAZZO

1Password Read an Item Secret

Resolve a vault, locate an item by title, and read its full field values.

ARAZZO

1Password Rotate an Item Password

Read an item, then apply a JSON Patch to replace its password field value.

ARAZZO

1Password Stream Audit Events

Validate the Events token, open an audit event feed from a start time, then page with the cursor.

ARAZZO

1Password Stream Item Usages

Open an item usage feed from a start time, then continue paging with the cursor while more remain.

ARAZZO

Pricing Plans

1Password Plans Pricing

5 plans

PLANS

Rate Limits

1Password Rate Limits

4 limits

RATE LIMITS

FinOps

1Password Finops

FINOPS

Features

Secrets Management

Programmatic access to 1Password vaults and items via Connect Server API

Security Monitoring

Real-time audit log streaming of sign-in events, item usage, and audit trails

Partner Billing Management

Provision and deprovision 1Password accounts for partner customers

SDKs

Official SDKs for Python, JavaScript/TypeScript, Go, and Connect-specific clients

CLI

1Password CLI for command-line secrets management and automation

Kubernetes Integration

Kubernetes operator and secrets injector for cloud-native deployments

Terraform Provider

Terraform provider to manage 1Password vault items as infrastructure

GitHub Actions

Load secrets from 1Password directly into GitHub Actions CI/CD pipelines

Use Cases

Secrets Injection

Inject secrets from 1Password into applications and containers at runtime

Security Audit

Stream and analyze sign-in events and item usage for security incident response

Compliance Reporting

Export audit trails for SOC2, GDPR, and other compliance frameworks

CI/CD Secrets

Securely provide secrets to CI/CD pipelines without hardcoding credentials

Infrastructure as Code

Manage secrets as part of Terraform or Ansible automation workflows

Partner Account Provisioning

Automate provisioning of 1Password accounts for partner customer bases

Integrations

Kubernetes

Native integration via operator and secrets injector for Kubernetes deployments

Terraform

Terraform provider for managing 1Password items as infrastructure resources

Ansible

Ansible collection for 1Password Connect integration

GitHub Actions

GitHub Actions to load and install 1Password secrets in CI/CD workflows

Splunk

Events API Splunk integration for security event streaming

HashiCorp Vault

Vault plugin for 1Password Connect secrets retrieval

Helm Charts

Official Helm charts for deploying 1Password Connect on Kubernetes

Semantic Vocabularies

1Password Connect Context

15 classes · 46 properties

JSON-LD

1Password Context

0 classes · 8 properties

JSON-LD

1Password Events Context

13 classes · 43 properties

JSON-LD

1Password Partnership Context

4 classes · 6 properties

JSON-LD

API Governance Rules

1Password API Rules

6 rules · 5 warnings 1 info

SPECTRAL

1Password API Rules

30 rules · 13 errors 11 warnings 6 info

SPECTRAL

JSON Structure

1Password Connect Api Request Structure

6 properties

JSON STRUCTURE

1Password Connect Field Structure

9 properties

JSON STRUCTURE

1Password Connect File Structure

6 properties

JSON STRUCTURE

1Password Connect Full Item Structure

0 properties

JSON STRUCTURE

1Password Connect Generator Recipe Structure

3 properties

JSON STRUCTURE

1Password Connect Item Structure

12 properties

JSON STRUCTURE

1Password Connect Json Patch Structure

0 properties

JSON STRUCTURE

1Password Connect Section Ref Structure

1 properties

JSON STRUCTURE

1Password Connect Section Structure

2 properties

JSON STRUCTURE

1Password Connect Server Health Structure

3 properties

JSON STRUCTURE

1Password Connect Url Structure

2 properties

JSON STRUCTURE

1Password Connect Vault Ref Structure

1 properties

JSON STRUCTURE

1Password Connect Vault Structure

9 properties

JSON STRUCTURE

1Password Event Structure

0 properties

JSON STRUCTURE

1Password Events Audit Event Response Structure

3 properties

JSON STRUCTURE

1Password Events Audit Event Structure

14 properties

JSON STRUCTURE

1Password Events Event Client Structure

7 properties

JSON STRUCTURE

1Password Events Event Location Structure

5 properties

JSON STRUCTURE

1Password Events Event Request Structure

3 properties

JSON STRUCTURE

1Password Events Event User Structure

3 properties

JSON STRUCTURE

1Password Events Item Usage Response Structure

3 properties

JSON STRUCTURE

1Password Events Item Usage Structure

9 properties

JSON STRUCTURE

1Password Events Sign In Attempt Response Structure

3 properties

JSON STRUCTURE

1Password Events Sign In Attempt Structure

8 properties

JSON STRUCTURE

1Password Events Token Introspection Structure

2 properties

JSON STRUCTURE

1Password Item Structure

14 properties

JSON STRUCTURE

1Password Partnership Account Structure

7 properties

JSON STRUCTURE

1Password Partnership Create Account Request Structure

4 properties

JSON STRUCTURE

1Password Partnership Update Account Request Structure

1 properties

JSON STRUCTURE

Example Payloads

1Password Connect Api Request Example

6 fields

EXAMPLE

1Password Connect Field Example

9 fields

EXAMPLE

1Password Connect File Example

6 fields

EXAMPLE

1Password Connect Full Item Example

EXAMPLE

1Password Connect Generator Recipe Example

3 fields

EXAMPLE

1Password Connect Item Example

12 fields

EXAMPLE

1Password Connect Json Patch Example

EXAMPLE

1Password Connect Section Example

2 fields

EXAMPLE

1Password Connect Section Ref Example

1 fields

EXAMPLE

1Password Connect Server Health Example

3 fields

EXAMPLE

1Password Connect Url Example

2 fields

EXAMPLE

1Password Connect Vault Example

9 fields

EXAMPLE

1Password Connect Vault Ref Example

1 fields

EXAMPLE

1Password Event Example

EXAMPLE

1Password Events Audit Event Example

14 fields

EXAMPLE

1Password Events Audit Event Response Example

3 fields

EXAMPLE

1Password Events Event Client Example

7 fields

EXAMPLE

1Password Events Event Location Example

5 fields

EXAMPLE

1Password Events Event Request Example

3 fields

EXAMPLE

1Password Events Event User Example

3 fields

EXAMPLE

1Password Events Item Usage Example

9 fields

EXAMPLE

1Password Events Item Usage Response Example

3 fields

EXAMPLE

1Password Events Sign In Attempt Example

8 fields

EXAMPLE

1Password Events Sign In Attempt Response Example

3 fields

EXAMPLE

1Password Events Token Introspection Example

2 fields

EXAMPLE

1Password Item Example

14 fields

EXAMPLE

1Password Partnership Account Example

7 fields

EXAMPLE

1Password Partnership Create Account Request Example

4 fields

EXAMPLE

1Password Partnership Update Account Request Example

1 fields

EXAMPLE

Resources

TrustCenter

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

Authentication

PostmanWorkspace

PostmanWorkspace

Documentation

GettingStarted

Authentication

Official SDKs

JavaScript SDK

Connect Python SDK

Connect Node.js SDK

Connect Go SDK

1Password CLI

PrivacyPolicy

TermsOfService

GitHubOrganization

GitHubOrganization

SpectralRules

Sources

opencollection: 1.0.0
info:
  name: 1Password Partnership API
  version: 1.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: 1Password Create a Partner Billing Account
      type: http
    http:
      method: POST
      url: https://billing.b5test.eu/api/v1/partners/accounts
      body:
        type: json
        data: '{}'
    docs: Creates a new third-party partner billing account for a customer through the partner billing service. Returns the
      activation token used to create a partner billing link for the customer to complete provisioning. Append the activation
      token to a 1Password partnership redemption link to create the customer's partner billing link.
  - info:
      name: 1Password Get Partner Billing Account Details
      type: http
    http:
      method: GET
      url: https://billing.b5test.eu/api/v1/partners/accounts/:accountUid
      params:
      - name: accountUid
        value: ''
        type: path
        description: The unique identifier for the customer's billing account, supplied by the partner. Can be up to 200 characters
          long with alphanumeric characters (A-Z, a-z, 0-9), hyphens, and periods.
    docs: Returns details about a customer's partner billing account, including the account type, domain, status, activation
      token, and scheduled end date if applicable.
  - info:
      name: 1Password Update a Partner Billing Account
      type: http
    http:
      method: PATCH
      url: https://billing.b5test.eu/api/v1/partners/accounts/:accountUid
      params:
      - name: accountUid
        value: ''
        type: path
        description: The unique identifier for the customer's billing account, supplied by the partner. Can be up to 200 characters
          long with alphanumeric characters (A-Z, a-z, 0-9), hyphens, and periods.
      body:
        type: json
        data: '{}'
    docs: Updates the date and time a customer's billing account is scheduled to be removed from the partner billing service.
      Use this endpoint to extend or shorten the billing period for a customer.
  - info:
      name: 1Password Delete a Partner Billing Account
      type: http
    http:
      method: DELETE
      url: https://billing.b5test.eu/api/v1/partners/accounts/:accountUid
      params:
      - name: accountUid
        value: ''
        type: path
        description: The unique identifier for the customer's billing account, supplied by the partner. Can be up to 200 characters
          long with alphanumeric characters (A-Z, a-z, 0-9), hyphens, and periods.
    docs: Deactivates and removes a customer's third-party billing account from the partner billing service. After deletion,
      GET requests will no longer return account information for the customer account UID.
bundled: true