API

Every onepassword.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Items

create

items.create Create a new item in a vault Risk: write

await corsair.onepassword.api.items.create({});

Input

Name	Type	Required	Description
`vaultId`	`string`	Yes	—
`title`	`string`	Yes	—
`category`	`LOGIN \| PASSWORD \| SECURE_NOTE \| DATABASE \| CREDIT_CARD \| MEMBERSHIP \| PASSPORT \| SOFTWARE_LICENSE \| OUTDOOR_LICENSE \| API_CREDENTIAL`	Yes	—
`urls`	`object[]`	No	—
`fields`	`object[]`	No	—

urls full type

{
  primary?: boolean,
  href: string
}[]

fields full type

{
  id?: string,
  label?: string,
  type: string,
  value?: string,
  section?: {
    id: string
  }
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`title`	`string`	Yes	—
`vault`	`object`	Yes	—
`category`	`string`	Yes	—
`urls`	`object[]`	No	—
`fields`	`object[]`	No	—

vault full type

{
  id: string
}

urls full type

{
  primary?: boolean,
  href: string
}[]

fields full type

{
  id?: string,
  label?: string,
  type: string,
  value?: string,
  section?: {
    id: string
  }
}[]

delete

items.delete Delete an item from a vault [DESTRUCTIVE] Risk: destructive

await corsair.onepassword.api.items.delete({});

Input

Name	Type	Required	Description
`vaultId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—

get

items.get Get details of a vault item (e.g. login credentials, notes) Risk: read

await corsair.onepassword.api.items.get({});

Input

Name	Type	Required	Description
`vaultId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`title`	`string`	Yes	—
`vault`	`object`	Yes	—
`category`	`string`	Yes	—
`urls`	`object[]`	No	—
`fields`	`object[]`	No	—

vault full type

{
  id: string
}

urls full type

{
  primary?: boolean,
  href: string
}[]

fields full type

{
  id?: string,
  label?: string,
  type: string,
  value?: string,
  section?: {
    id: string
  }
}[]

list

items.list List all items inside a specific vault Risk: read

await corsair.onepassword.api.items.list({});

Input

Name	Type	Required	Description
`vaultId`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output: object[]

Output full type

{
  id: string,
  title: string,
  vault: {
    id: string
  },
  category: string,
  urls?: {
    primary?: boolean,
    href: string
  }[],
  fields?: {
    id?: string,
    label?: string,
    type: string,
    value?: string,
    section?: {
      id: string
    }
  }[]
}[]

update

items.update Update details of an existing vault item Risk: write

await corsair.onepassword.api.items.update({});

Input

Name	Type	Required	Description
`vaultId`	`string`	Yes	—
`id`	`string`	Yes	—
`title`	`string`	Yes	—
`category`	`LOGIN \| PASSWORD \| SECURE_NOTE \| DATABASE \| CREDIT_CARD \| MEMBERSHIP \| PASSPORT \| SOFTWARE_LICENSE \| OUTDOOR_LICENSE \| API_CREDENTIAL`	Yes	—
`urls`	`object[]`	No	—
`fields`	`object[]`	No	—

urls full type

{
  primary?: boolean,
  href: string
}[]

fields full type

{
  id?: string,
  label?: string,
  type: string,
  value?: string,
  section?: {
    id: string
  }
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`title`	`string`	Yes	—
`vault`	`object`	Yes	—
`category`	`string`	Yes	—
`urls`	`object[]`	No	—
`fields`	`object[]`	No	—

vault full type

{
  id: string
}

urls full type

{
  primary?: boolean,
  href: string
}[]

fields full type

{
  id?: string,
  label?: string,
  type: string,
  value?: string,
  section?: {
    id: string
  }
}[]

Vaults

get

vaults.get Get details of a specific vault by ID Risk: read

await corsair.onepassword.api.vaults.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—
`attributeVersion`	`number`	No	—
`contentVersion`	`number`	No	—
`type`	`string`	No	—

list

vaults.list List all vaults the integration can access Risk: read

await corsair.onepassword.api.vaults.list({});

Input: empty object Output: object[]

Output full type

{
  id: string,
  name: string,
  description?: string,
  attributeVersion?: number,
  contentVersion?: number,
  type?: string
}[]

Overview

Plugins

Items

create

delete

get

list

update

Vaults

get

list

​Items

​create

​delete

​get

​list

​update

​Vaults

​get

​list

Items

create

delete

get

list

update

Vaults

get

list