DXable Manual
DXable製品総合情報サイト製品ニュースお問い合わせ
1Password
1Password
  • 1Passwordマニュアル
  • Delinea Secret Serverから1Passwordにデータを移動する
  • 1Password.comのアカウントにデータを移動する
  • 保管庫を作成してメンバーと共有する
  • Emergency Kitについて知っておくべきこと
  • 1Passwordのアイテムを誰とでも安全に共有する
  • ブラウザー内で1Passwordにパスワードを保存して自動入力に使う
  • ブラウザーに組み込まれているパスワードマネージャーをオフにする
  • 2要素認証のあるサイトで1Passwordを認証に使うには
  • Watchtowerを使って変更が必要なアカウント情報を見つけ出す
  • 1Passwordアプリを入手する
  • 1Password for Linuxアプリを入手する
  • 1Password for Linuxの使い方
  • 1Password 8にアップグレード
  • アプリとブラウザー拡張機能に別の1Passwordアカウントを追加する方法
  • Wi-Fi用QRコード
  • iPhone または iPad のSafari向け1Password の使い方
  • クレジットカードと住所を保存して入力する
  • 1Passwordを使用してログイン情報を保存し、 Androidデバイス上のアプリやウェブサイトにサインインする
  • 1Passwordを使用してログイン情報を保存し、iPhoneやiPadのアプリやウェブサイトにサインインする
  • iPhoneまたはiPad ProでFace IDを使用して1Passwordのロックを解除する
  • システム認証を使用してLinuxコンピュータで1Passwordのロックを解除する
  • Touch IDを使用してiPhoneまたはiPadで1Passwordのロックを解除する
  • Touch IDを使用してMacで1Passwordのロックを解除する
  • Windows Helloを使用してWindows PCで1Passwordのロックを解除する
  • Apple Watchを使ってMacで1Passwordのロックを解除する
  • デバイスのパスコード、 PIN、またはパターンを使用して1Passwordのロックを解除します
  • Androidデバイスで指紋、顔、虹彩を使って1Passwordのロックを解除する
  • 1Password CLI
  • CLIの利用例
  • 1Password CLI入門
  • 1Password CLIでシークレット参照を使う
  • シークレットを環境にロードする
  • シークレットをスクリプトにロードする
  • シークレットを設定ファイルにロードする
  • アイテムを作成する
  • アイテムを編集する
  • SSH鍵を管理する
  • チームメンバーの追加と削除
  • Vault権限の付与と取り消し
  • 1Password CLIを使いアカウントを回復する(β版)
  • 1Password CLIリファレンス
  • 1Password CLIのベストプラクティス
  • accountコマンド
  • connectコマンド
  • documentコマンド
  • イベント API
  • groupコマンド
  • itemコマンド
  • プラグイン
  • サービスアカウント
  • user
  • 保管庫(Vault)を操作する
  • completion
  • inject
  • read
  • run
  • signin
  • signoutコマンド
  • updateコマンド
  • whoamiコマンド
  • 1Password CLI環境変数
  • アイテムフィールド
  • アイテムJSONテンプレート
  • シークレット参照の構文
  • テンプレート構文
  • Vaultの権限について
  • 1Passwordアプリ統合セキュリティー
  • 1Password CLIの信頼性を確認する
  • サーバーに1Password CLIをインストールする
  • 1Password CLIが設定ディレクトリーを検出する方法
  • 1Password CLIを最新に保つ
  • 1Password CLI 2にアップグレードする
  • 1Passwordデスクトップアプリ統合でCLIにサインイン
  • 1Passwordアカウントに手動でサインインする
  • SSOで1Password CLIのロックを解除する
  • 複数のアカウントを使用する
  • 1Password CLIをアンインストールする
  • サンプルスクリプト
  • 1Password CLI リリースノート
  • 1Password SDK
  • 1Password SDKを使用してアイテムを管理する
  • 1Password SDKを使用してシークレットをロードする
  • 1Password SDKを使用してVaultとアイテムを一覧表示する
  • サポートされている機能
  • 1Password SDKのコンセプト
  • 1Password Go SDK
  • 1Password JavaScript SDK
  • 1Password Python SDK
  • SSHとGit用の1Password
  • 1Password for SSHを使う
  • SSH鍵を管理する
  • 公開鍵の自動入力
  • SSH で Git コミットに署名する
  • 1Password SSHエージェント
  • 1Password SSHエージェントの高度な応用
  • SSH エージェント設定ファイル
  • 1PasswordによるSSHエージェントフォワーディング
  • SSHクライアントの互換性
  • 1Password SSH Agentのセキュリティーについて
  • WSLで1Password SSHエージェントを使う
  • 1Password Shellプラグインを使用して、あらゆるCLIを安全に認証します
  • 1PasswordでAkamai CLIを安全に認証する
  • 1Passwordを使用してArgo CD CLIを安全に認証する
  • 1Passwordを使用してAxiom CLIを安全に認証する
  • 1Passwordを使用してAWS CLIを安全に認証する
  • 1Password を使用して AWS CDK ツールキットを安全に認証する
  • 1Passwordを使用してBinance CLIを安全に認証する
  • 1Passwordを使用してCachix CLIを安全に認証する
  • 1Passwordを使用してCargo CLIを安全に認証する
  • 1Passwordを使用してCircleCI CLIを安全に認証する
  • 1Passwordを使用してCivo CLIを安全に認証する
  • 1Passwordを使用してCloudflare Workers CLIを安全に認証する
  • 1Passwordを使用してCrowdin CLIを安全に認証する
  • 1Passwordを使用してDatabricks CLIを安全に認証する
  • 1Passwordを使用してDigitalOcean CLIを安全に認証する
  • 1Passwordを使用してDogshellを安全に認証する
  • 1Passwordを使用してFastly CLIを安全に認証する
  • 1Passwordを使用してFlyctlを安全に認証する
  • 1Passwordを使用してFOSSA CLIを安全に認証する
  • 1Passwordを使用してGitea CLIを安全に認証する
  • 1PasswordでGitHub CLIを安全に認証する
  • 1PasswordでGitLab CLIを安全に認証する
  • 1PasswordでHashiCorp Vault CLIを安全に認証する
  • 1PasswordでHetzner Cloud CLIを安全に認証する
  • 1PasswordでHeroku CLIを安全に認証する
  • 1PasswordでHomebrewを安全に認証する
  • 1PasswordでHuggingFace CLIを安全に認証する
  • 1PasswordでInfluxDBを安全に認証する
  • 1PasswordでKaggle CLIを安全に認証する
  • 1PasswordでLacework CLIを安全に認証する
  • 1PasswordでLaravel Forge CLIを安全に認証する
  • 1PasswordでLaravel Vapor CLIを安全に認証する
  • 1PasswordでLinode CLIを安全に認証する
  • 1PasswordでLocalStackを安全に認証する
  • 1PasswordでMongoDB Atlasを安全に認証する
  • 1PasswordでMySQL CLIを安全に認証する
  • 1Passwordでngrokを安全に認証する
  • 1PasswordでOh Dear CLIを安全に認証する
  • 1PasswordでOkta CLIを安全に認証する
  • 1PasswordでOpenAI CLIを安全に認証する
  • 1PasswordでOpenAI Evalsを安全に認証する
  • 1PasswordでPipedream CLIを安全に認証する
  • 1PasswordでPostgreSQL CLIを安全に認証する
  • 1PasswordでPulumi CLIを安全に認証する
  • 1PasswordでReadMe CLIを安全に認証する
  • 1PasswordでSentry CLIを安全に認証する
  • 1PasswordでSnowflake CLIを安全に認証する
  • 1PasswordでSnyk CLIを安全に認証する
  • 1PasswordでSourcegraph CLIを安全に認証する
  • 1PasswordでStripe CLIを安全に認証する
  • 1PasswordでTerraformを安全に認証する(ベータ版)
  • 1PasswordでTodoist CLIを安全に認証する
  • 1PasswordでTreasure Data CLIを安全に認証する
  • 1PasswordでTugboat CLIを安全に認証する
  • 1PasswordでTwilio CLIを安全に認証する
  • 1PasswordでUpstash CLIを安全に認証する
  • 1PasswordでVercel CLIを安全に認証する
  • 1PasswordでVertica CLIを安全に認証する
  • 1PasswordでVultr CLIを安全に認証する
  • 1PasswordでYugabyteDB SQL Shellを安全に認証する
  • 1PasswordでZapier CLIを安全に認証する
  • 1PasswordでZendesk CLIを安全に認証する
  • シェルプラグインをテストする
  • シェルプラグインを使って複数の環境を切り替える
  • シェルプラグインを使用して複数のアカウントで認証する
  • Nixを使ってシェルプラグインを設定する
  • シェルプラグインをアンインストールする
  • 独自のシェルプラグインを構築する(ベータ版)
  • 1Password Shell プラグインのトラブルシューティング
  • 1Password Shellプラグインのセキュリティについて
  • 1Password Secrets Automation
  • 1Password Service Accounts
  • 1Password Service Accountsを初めて使う
  • サービスアカウントを管理する
  • 1Password CLIでサービスアカウントを使う
  • 1Password サービス アカウントのセキュリティ
  • サービスアカウントのレート制限
  • 1Password接続
  • 1Password Connectサーバーを使い始める
  • Connectサーバーの管理
  • Connectサーバーを構成する
  • 1Password Connect サーバーの価格
  • 概念を結びつける
  • 1Password Connect Serverのセキュリティについて
  • 1Password Connect Server APIリファレンス
  • Connectサーバーで1Password CLIを使用する
  • 1Password Connect Server をデプロイする
  • AnsibleでConnectを使う
  • 1Passwordの統合
  • 1Password CI/CD 統合
  • 1Password から CircleCI にシークレットをロードする
  • 1Password のシークレットを GitHub Actions にロードする
  • 1PasswordからJenkinsに秘密情報を読み込む
  • Kubernetes 統合
  • Kubernetes Injector
  • Kubernetes Operator
  • 1Password Helmチャート
  • Helmチャート設定
  • 1Password Terraformプロバイダーを使用する
  • VSコード用の1Password
  • 1Password イベントレポート API
  • 1Password イベント API 汎用スクリプト
  • 1Password イベント API リファレンス
  • 1Password イベント 監査イベントの報告
  • 1Password イベント アイテムの使用アクションの報告
  • 1Password パートナーシップ API リファレンス
  • 1Password Developer Watchtower
  • ウェブサイトに「Save in 1Password」ボタンを追加する
  • 1Passwordで最適に機能するウェブサイトをデザインする
  • 1Passwordサポートへようこそ
  • 1Passwordを使い始める
  • 1Password for Macについて知る
  • iOS用1Passwordについて知る
  • 1Password for Windowsについて知る
  • Android用1Passwordについて知る
  • Linuxで1Passwordを使用する
  • ブラウザーで1Passwordを知ろう
  • 既存の1Passwordデータをスタンドアロンの保管庫から1Passwordアカウントに移行する
  • 1Passwordのセキュリティモデルについて
  • Secret KeyまたはSetup Codeを見つける
  • 1Passwordがブラウザーで動作しない場合
  • 家族やチームメンバーのアカウントを回復する
  • 1Passwordアカウントのパスワードを忘れた場合、またはアプリのロックを解除できない場合の対策
  • 1Passwordアカウントの2要素認証をオンにする
  • 柔軟さと制御機能で、企業の最も貴重な情報を保護
  • チームメンバーの追加と削除
  • チームの回復計画を実施する
  • チーム内で保管庫を作成、共有、管理する
  • 従業員用保管庫について
  • チームを離れる準備をしていて、リンクされたファミリーアカウントを持っている場合
  • 1Password Businessをご利用の場合、 1Password Familiesメンバーシップを無料でご利用いただけます
  • 1Password Extended Access Managementについて
  • レポートとActivity Logの無料トライアルを開始する
  • SCIMを使用して1Password Businessのプロビジョニングを自動化する
  • Google Workspace を1Password SCIM Bridgeに接続する
  • JumpCloudを1Password SCIM Bridgeに接続する
  • Microsoft Entra IDを1Password SCIM Bridgeに接続する
  • Oktaを1Password SCIM Bridgeに接続する
  • OneLoginを1Password SCIM Bridgeに接続する
  • Ripplingを1Password SCIM Bridgeに接続する
  • 1Password SCIM Bridgeを導入し、 Ripplingでプロビジョニングを自動化する
  • Azure Container Appsに1Password SCIM Bridgeをデプロイする
  • Azure Kubernetes Service に1Password SCIM Bridge をデプロイする
  • DigitalOceanに1Password SCIM Bridgeを導入する
  • Google Cloud Platformに1Password SCIM Bridge をデプロイする
  • 1Password SCIM Bridgeで問題が発生した場合
  • 1Password SCIM Bridgeの更新
  • SCIM を使用してプロビジョニングするときに1Password Businessで許可されたドメインを更新する
  • 1Password Businessアカウントを保護するためのベストプラクティス
  • 1Password Unlock with SSO で使用するためのベストプラクティス
  • モバイル デバイス管理について
  • 1Password for MacとWindowsを導入する
  • チームメンバーのブラウザーに1Passwordを導入する
  • 複数のコンピューターのブラウザーに組み込まれているパスワードマネージャーをオフにする
  • 1PasswordEvents Reporting
  • 1Password Events Reportingのセキュリティーについて
  • 1PasswordEvents Reportingを使い始める
  • 1PasswordEvents ReportingとElasticを使い始める
  • 1Password Events ReportingとSplunk Cloud Classic Experienceを使う
  • 1PasswordEvents ReportingとSplunk EnterpriseまたはSplunk Cloud Victoria Experienceを使い始めましょう
  • チームでDuoを使用する
  • 1Password Slackアプリを使用する
  • チーム内のアイテムの以前のバージョンを表示および復元する
  • チームメンバーのメールアドレスを変更する
  • チームメンバーの退会
  • チーム内のゲストと共有する
  • 1Password Businessでカスタムグループを使用する
  • チーム内の組み込みグループを使用する
  • 会社のドメイン侵害レポートを作成する
  • 1Password Businessでレポートを作成する
  • 1Password Businessでサインイン試行を監視する
  • チームにインサイト通知を送信する
  • Insightsを使用して、会社のセキュリティリスクを特定して修正します
  • 1Password BusinessのActivity Logを使用する
  • 1Password Businessでファイアウォールルールを作成する
  • 1Password Businessで1Passwordアカウントのパスワード要件を強制する
  • 1Password BusinessでEmergency Kitsを管理する
  • 1Password Businessでアイテムの共有設定を管理する
  • 1Password Businessでチームポリシーを管理する
  • 1Password Businessで2要素認証を管理する
  • 1Password Businessでは最新の1Passwordアプリが必要です
  • Auth0で1Passwordのロック解除を設定する
  • Googleで1Passwordのロック解除を設定する
  • JumpCloudで1Passwordのロック解除を設定する
  • Microsoft Entra IDで1Passwordのロック解除を設定する
  • Oktaで1Passwordのロック解除を設定する
  • OpenID Connectを使用してSSOで1Passwordのロック解除を設定する
  • 1Password Unlock with SSOを使い始める
  • SSOで1Passwordのロックを解除できない場合
  • 1Password Unlock with SSOで設定する
  • 新しいデバイスで SSO を使用して1Passwordのロックを解除する
  • SSOで1Passwordにサインインする
  • Conditional AccessポリシーのMicrosoft Entra IDによるロック解除の更新
  • チームメンバー: 1Passwordを使い始める
  • 管理者: 1Passwordを使い始める
  • 1Passwordとその機能に関するセットアップ ガイド、チュートリアル、よくある質問への回答。
  • 他のアプリケーションから1Passwordにデータを移動する
  • Chromeから1Passwordにパスワードを移動する
  • Firefoxから1Passwordにパスワードを移動する
  • パスワードをEdgeから1Passwordに移動する
  • Braveから1Passwordにパスワードを移動する
  • iCloud パスワードをSafariから1Passwordに移動する
  • Bitwardenから1Passwordにデータを移動する
  • Dashlaneから1Passwordにデータを移動する
  • KeePassから1Passwordにデータを移動する
  • KeePassXCから1Passwordにデータを移動する
  • デスクトップアプリでLastPassから1Passwordにデータを移動する
  • RoboFormから1Passwordにデータを移行する
Powered by GitBook
On this page
  • 前提条件
  • APIに関する情報
  • 請求先
  • 請求先アカウント情報
  • 請求先アカウントを削除
  • 請求先アカウントの終了日

1Password パートナーシップ API リファレンス

1Passwordマニュアル|顧客のサードパーティーパートナー請求アカウントをAPIで効率的に管理し、プロビジョニングとデプロビジョニングを簡素化します。

Previous1Password イベント アイテムの使用アクションの報告Next1Password Developer Watchtower

Last updated 19 hours ago

1Password パートナーシップ API を使うと、顧客向けのサードパーティ パートナーの請求アカウントのプロビジョニングとデプロビジョニングを管理できます。API は、1Password の個人アカウントとファミリー アカウントのパートナー請求アカウントをサポートしています。パートナーシップ API は、1Password チーム アカウントまたはビジネス アカウントをサポートしていません。

注記

別のツールで 1Password Partnership API を使うには、API 仕様ファイルをダウンロードします。

前提条件

API を使用してパートナーの請求サービスと統合する前に、1Password パートナーとして登録する必要があります。登録されたパートナーには、API 請求サーバーへのリクエストを承認するためのベアラー トークンへのアクセス権が付与されます。

パートナーシップの機会について詳しくは、にアクセスするか、にお問い合わせください。

APIに関する情報

1Password パートナーシップ API は、 に準拠した REST スタイルの API です。クライアントとサーバー間の全ての通信は HTTPS 経由で行われます。

パートナーシップ API のテストと実装には、お好みのプログラミング言語とツールを使用できます。このリファレンスでは、コマンド ラインでを使用してサンプル リクエストを示します。リクエスト内の値を独自の値に置き換えて、顧客の請求アカウントに関する情報を受け取ることができます。

Request methods

次の標準 HTTP メソッドを使用して、Partnership API にリクエストを送信できます。

  • : パートナーの請求サービスを通じて顧客のサードパーティの請求アカウントをCreateします。

  • : 顧客の請求アカウントの詳細を取得します。

  • : パートナーの請求サービスから顧客のサードパーティの請求アカウントを削除します。

  • : 顧客の請求アカウントがパートナーの請求サービスから削除される予定の日時を更新します。

バッチリクエストはサポートされていません。

パートナーが 1Password Partnership API を操Createするために使用できる課金サーバーには、API エンドポイントのベース URL を提供するものが 2 つあります。

  • Test server( https://billing.b5test.eu): テスト環境内の全てのリクエストのベースとしてテスト サーバーの URL を使用します。テスト サーバー ( b5test.com、b5test.ca、b5test.eu)から、全てのドメインのテスト パートナー課金アカウントをプロビジョニングおよびプロビジョニング解除できます。

  • Production server( https://billing.1password.com): 運用環境の全てのリクエストのベースとして運用サーバーの URL を使用します。運用サーバーから、全てのドメイン ( 1password.com、1password.ca、および1password.eu ) のパートナー課金アカウントをプロビジョニングおよびプロビジョニング解除できます。

API への各リクエストは、操Createするサーバー環境 (テストまたは本番) のベース URL で始まり、その後にパス ( api/v1/partners/account) が続きます。中括弧 ( {}) で示されるパス パラメータは、定義されている場合に必須です。例:

APIエンドポイントの構造

①<base_URL>/②<path>/③{parameters}

①base_URLと③{parameters}プレースホルダーを、使用しているサーバー環境とリクエストに指定されたパス パラメータに置き換えます。②pathは全てのリクエストで同じです。

パスパラメータのない API エンドポイントの例

①https://billing.b5test.eu/②api/v1/partners/accounts

パスパラメータを持つ API エンドポイントの例

①https://billing.1password.com/②api/v1/partners/accounts/③4266474b-6385-56d4-7b75-648096593064

Authorization

リクエストヘッダー

パートナーシップ API へのリクエストでは、次の 3 種類のヘッダーが使用されます。

  • Content-Type: 各 POST および PATCH リクエストには、リクエスト本体のメディア (MIME) タイプを示すヘッダーが必要です。

  • Accept: Partnership API への各 GET、POST、および PATCH リクエストには、クライアントがサーバーから受け入れることができる応答の種類を示す accept ヘッダーを含める必要があります。

全てのデータは JSON として送受信されるため、ヘッダーでそのことを必ず指定してください。

Authorization: Bearer YOUR_BEARER_TOKEN

Content-type: application/json

Accept: application/json

リクエストボディ

リクエスト ボディ (リクエスト ペイロードとも呼ばれます) には、サーバー上のリソースをCreate (POST) または更新 (PATCH) するためにクライアントが送信する JSON 形式のデータが含まれます。リクエスト ボディは、次に示すように、1 つ以上のフィールドを含むオブジェクトで構成されます。

  • 顧客の請求先アカウントの一意の識別子 (UID)。UID はパートナーによって提供されます。英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。

  • 1Password アカウントの種類。オプションは個人 (I) または家族 (F) です。チーム アカウントとビジネス アカウントはサポートされていません。

  • 顧客が新規または保存済みの 1Password アカウントに使用できるドメイン。テスト サーバーの場合、オプションは b5test.com、b5test.ca、または b5test.eu です。実稼働サーバーの場合、オプションは 1password.com、1password.ca、または 1password.eu です。

GET および DELETE 呼び出しにはリクエスト本体は含まれません。

アクティベーショントークン

アクティベーション トークンは、1Password アカウントをパートナーの請求アカウントにリンクすることで、顧客にサードパーティの請求をプロビジョニングするために使用されます。

リンクをクリックすると、顧客はプロモーション ページに移動し、新しい 1Password アカウントをCreateするか、保存済みのアカウントにサインインするように指示されます。顧客の 1Password アカウントの請求は、パートナーの請求アカウントにリンクされます。

顧客向けリンクをCreateする

1Password アカウントのパートナー請求リンクの構造

https://start.[1password_domain]/partnership/redeem?t={account_type}&c={activation_token}&l={language_code}

プレースホルダー

価値観

必須

[1password_domain]

可能な値は1password.com、、1password.caまたはです1password.eu。

はい

{account_type}

可能な値はindividualまたは ですfamily。

はい

{activation_token}

はい

{language_code}

いいえ

1Password ドメインのプレースホルダーとパラメータを適切な値に置き換えます。例:

オプションの言語パラメータを持つ 1Password.eu の個人アカウントのパートナー請求リンクの例

https://start.1password.eu/partnership/redeem?t=individual&c=4266474b-6385-56d4-7b75-648096593064&l=de

オプションの言語パラメータを持つ 1Password.com のファミリー アカウントのパートナー請求リンクの例

https://start.1password.com/partnership/redeem?t=family&c=4266474b-6385-56d4-7b75-648096593064&l=en

注意

Alternate partner billing link options

代替リンク オプションの詳細をご覧ください。

パートナーシップ API は、パートナーの請求リンクの代替オプションもいくつかサポートしています。パートナーシップの詳細に応じて、次のリンクをCreateすることをお勧めします。

これらのリンクのいずれかを顧客に提供した場合、顧客はそれを使用して、パートナーの請求先アカウントをそれぞれ新しいアカウントまたは保存済みのアカウントにリンクすることのみが可能になります。

新しい 1Password アカウント

新しい 1Password アカウントのパートナー請求リンクの構造

https://start.[1password_domain]/sign-up/[account_type]?c={activation_token}&l={language_code}

オプションの言語パラメータを持つ 1Password.eu の新規個人アカウントのパートナー請求リンクの例

https://start.1password.eu/sign-up/individual?c=4266474b-6385-56d4-7b75-648096593064&l=de

オプションの言語パラメータを含む 1Password.com の新しいファミリー アカウントのパートナー請求リンクの例

https://start.1password.com/sign-up/family?c=4266474b-6385-56d4-7b75-648096593064&l=en

保存済みの 1Password アカウントのみのリンクをCreateします

保存済みの 1Password アカウントのパートナー請求リンクの構造

https://my.[1password_domain]/partnership/link?c={activation_token}&l={language_code}

オプションの言語パラメータを持つ 1Password.com の保存済みアカウントのパートナー請求リンクの例

https://my.1password.com/partnership/link?c=4266474b-6385-56d4-7b75-648096593064&l=en

このリンクにはアカウントの種類は含まれません。顧客が既に持っている 1Password アカウントにサインインするように指示するためです。

プレースホルダー

価値観

必須

[1password_domain]

可能な値は1password.com、、1password.caまたは1password.euです。

はい

[account_type]

はい

新規アカウントのみ

{activation_token}

はい

{language_code}

いいえ

言語コード

オプションの言語コード パラメータの詳細について説明します。

言語パラメータでは次の言語コードを使用できます。

言語

コード

英語

en

ドイツ語

de

スペイン語

es

フランス語

fr

イタリア語

it

日本語

ja

言語

コード

韓国語

ko

オランダ語

nl

ポルトガル語

pt-BR

ロシア語

ru

簡体字

zh-Hans

繁體中文

zh-Hant

請求先

POST <base_URL>/api/v1/partners/accounts

パス

パスパラメータがありません。

  • 顧客のアカウント UID。

  • 適格な 1Password アカウントの種類。

  • 顧客が新規または保存済みの 1Password アカウントに使用できるドメイン。

Example request

curl --request POST \

--url https://billing.1password.com/api/v1/partners/accounts \

--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \

--header 'Content-Type: application/json' \

--header 'Accept: application/json' \

--data '{

"customer_account_uid": "4266474b-6385-56d4-7b75-648096593064",

"account_type": "F",

"domain": "1password.com",

"ends_at": "2024-08-31T13:00:00-05:00"

}'

Request object schema

名前

タイプ

説明

customer_account_uid

必須

string

顧客の請求アカウントの一意の識別子 (UID)。UID は、英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。

account_type

必須

string

顧客にプロビジョニングする 1Password アカウントの種類:I個人アカウントまたはFファミリー アカウント。チーム アカウントとビジネス アカウントはサポートされていません。

domain

必須

string

顧客がパートナーの課金サービスで使用できる新規または保存済みの 1Password アカウントのドメイン。テスト サーバーの場合: b5test.com、b5test.ca、またはb5test.eu。実稼働サーバーの場合: 1password.com、1password.ca、または1password.eu。

ends_at

string

顧客の請求アカウントがパートナーの請求サービスから削除される予定の日時。RFC 3339 で定義された形式を使用します。

Create功レスポンス

Example response

{

"customer_account_uid": "4266474b-6385-56d4-7b75-648096593064",

"account_type": "F",

"activation_token": "PNS-D5A75BT2",

"domain": "1password.com",

"status": "entitled",

"deployed_members": 0,

"created_at": "2023-08-24T04:19:44Z",

"updated_at": "2023-09-15T15:58:22Z",

"ends_at": "2024-08-31T18:00:00Z"

}

Response object schema

名前

タイプ

説明

customer_account_uid

string

顧客の請求アカウントの一意の識別子 (UID)。UID は、英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。

account_type

string

顧客用にプロビジョニングした 1Password アカウントの種類:I個人アカウント用またはFファミリー アカウント用。

activation_token

string

domain

string

顧客がパートナーの課金サービスで使用できる新規または保存済みの 1Password アカウントのドメイン。テスト サーバーの場合: b5test.com、b5test.ca、またはb5test.eu。実稼働サーバーの場合: 1password.com、1password.ca、または1password.eu。

status

string

プロビジョニングされた顧客請求アカウントのステータス。可能な値は次のいずれかです。

  • entitledプロビジョニングは開始されましたが、顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用していません。

  • provisioned顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用し、サードパーティの請求アカウントがプロビジョニングされています。

POST リクエストの期待値は entitledです。

deployed_members

integer

1Password アカウントにプロビジョニングされたユーザーの数。POST

リクエストに対して返される予想値は 0です。

created_at

string

updated_at

string

リクエストに対して返される予想値は、created_atプロパティの値と同じです。

ends_at

string

エラー応答

400不正なリクエストで返されました。

Example error

{

"code": 400,

"error": "bad_request",

"description": "Account type B is not supported."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

403リクエスト本文に認証ヘッダーがない場合、または無効なトークンが指定された場合に返されます。

Example error

{

"code": 403,

"error": "forbidden",

"description": "Invalid auth token."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

404リソースまたはリソースの依[Save]関係が見つからない場合に返されます。

Example error

{

"code": 404,

"error": "not_found",

"description": "Domain not found."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

500予期しないエラーが発生した場合に返されます。

Example error

{

"code": 500,

"error": "internal_server_error",

"description": "Internal server error"

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

請求先アカウント情報

GET <base_URL>/api/v1/partners/accounts/{customer_account_uid}

GET 呼び出しは、顧客の請求アカウントに関する情報を取得します。パス パラメータとして顧客のアカウント UID を必ず含めてください。

パスパラメータ

パラメータ

タイプ

説明

customer_account_uid

必須

string

顧客の請求アカウントの一意の ID。

リクエスト

Example request

curl --request GET \

--url https://billing.1password.com/api/v1/partners/accounts/{customer_account_uid} \

--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \

--header 'Accept: application/json'

Create功レスポンス

応答200では、顧客のサードパーティの請求アカウントに関する情報を提供する Account オブジェクトが返されます。

Example response

{

"customer_account_uid": "4266474b-6385-56d4-7b75-648096593064",

"account_type": "F",

"activation_token": "PNS-D5A75BT2",

"domain": "1password.com",

"status": "provisioned",

"deployed_members": 1,

"created_at": "2023-08-24T04:19:44Z",

"updated_at": "2023-09-15T15:58:22Z",

"ends_at": "2024-08-31T18:00:00Z"

}

Response object schema

前

タイプ

説明

customer_account_uid

string

顧客の請求アカウントの一意の識別子 (UID)。UID は、英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。

account_type

string

顧客用にプロビジョニングした 1Password アカウントの種類:I個人アカウント用またはFファミリー アカウント用。

activation_token

string

domain

string

顧客がパートナーの課金サービスで使用できる新規または保存済みの 1Password アカウントのドメイン。テスト サーバーの場合: b5test.com、b5test.ca、またはb5test.eu。実稼働サーバーの場合: 1password.com、1password.ca、または1password.eu。

status

string

プロビジョニングされた顧客請求アカウントのステータス。可能な値は次のいずれかです。

  • entitledプロビジョニングは開始されましたが、顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用していません。

  • provisioned顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用し、サードパーティの請求アカウントがプロビジョニングされています。

deployed_members

integer

1Password アカウントにプロビジョニングされたユーザーの数。

created_at

string

updated_at

string

ends_at

string

エラー応答

403認証ヘッダーが欠落しているか、無効なトークンが指定された場合に返されます。

Example error

{

"code": 403,

"error": "forbidden",

"description": "Invalid auth token."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

404リソースまたはリソースの依[Save]関係が見つからない場合に返されます。

Example error

{

"code": 404,

"error": "not_found",

"description": "Failed to find the requested account."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

410リソースが削除されたときに返されます。

Example error

{

"code": 410,

"error": "gone",

"description": "The requested account is gone."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

500予期しないエラーが発生した場合に返されます。

Example error

{

"code": 500,

"error": "internal_server_error",

"description": "Internal server error"

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

請求先アカウントを削除

DELETE <base_URL>/api/v1/partners/accounts/{customer_account_uid}

DELETE 呼び出しは、パートナーの課金サービスから顧客のサードパーティ課金アカウントを削除します。パス パラメータとして顧客のアカウント UID を必ず含めてください。

パスパラメータ

パラメータ

タイプ

説明

customer_account_uid

必須

string

削除する顧客請求アカウントの一意の ID。

リクエスト

Example request

curl --request DELETE \

--url https://billing.1password.com/api/v1/partners/accounts/{customer_account_uid} \

--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \

Create功レスポンス

顧客請求アカウントの非アクティブ化と削除が正常に完了すると、204応答が返されます。請求アカウントが削除されたため、GET 要求では顧客アカウント UID のアカウント情報は返されなくなります。

エラー応答

403認証ヘッダーが欠落しているか、無効なトークンが指定された場合に返されます。

Example error

{

"code": 403,

"error": "forbidden",

"description": "Invalid auth token."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

404リソースまたはリソースの依[Save]関係が見つからない場合に返されます。

Example value

{

"code": 404,

"error": "not_found",

"description": "Failed to find the requested account."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

500予期しないエラーが発生した場合に返されます。

Example error

{

"code": 500,

"error": "internal_server_error",

"description": "Internal server error"

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

請求先アカウントの終了日

PATCH <base_URL>/api/v1/partners/accounts/{customer_account_uid}

PATCH 呼び出しを使うと、顧客の請求先アカウントの終了日を追加、編集、または削除できます。パス パラメータとして顧客のアカウント UID を必ず含めてください。

パスパラメータ

パラメータ

タイプ

説明

customer_account_uid

必須

string

顧客の請求アカウントの一意の ID。

リクエスト

顧客の請求アカウントをパートナーシップ請求サービスから削除する予定の日時を追加または更新するには、RFC 3339 で定義された形式で、新しい日時をends_at値として含めます。

顧客の請求先アカウントから終了日時を削除するには、値として空の文字列 ( "") またはnullを使用します。

Example request

curl --request PATCH \

--url https://billing.1password.com/api/v1/partners/accounts/{customer_account_uid} \

--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \

--header 'Accept: application/json' \

--data '{

"ends_at": "2024-08-31T13:00:00-05:00"

}'

Request object schema

名前

タイプ

説明

ends_at

必須

string

顧客の課金アカウントがパートナー課金サービスから削除される予定の日時。RFC 3339 で定義された形式を使用します。アカウントから終了日を削除する場合は、値として空の文字列 ( "") またはnullを使用します。

Create功レスポンス

応答200では、請求アカウントに追加、編集、または削除された終了日など、顧客のサードパーティ請求アカウントに関する情報を提供する Account オブジェクトが返されます。

Example response

{

"customer_account_uid": "4266474b-6385-56d4-7b75-648096593064",

"account_type": "F",

"activation_token": "PNS-D5A75BT2",

"domain": "1password.com",

"status": "provisioned",

"deployed_members": 1,

"created_at": "2023-08-24T04:19:44Z",

"updated_at": "2023-09-15T15:58:22Z",

"ends_at": "2024-08-31T18:00:00Z"

}

Response object schema

名前

タイプ

説明

customer_account_uid

string

顧客の請求アカウントの一意の識別子 (UID)。UID は、英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。

account_type

string

顧客用にプロビジョニングした 1Password アカウントの種類:I個人アカウント用またはFファミリー アカウント用。

activation_token

string

domain

string

顧客がパートナーの課金サービスで使用できる新規または保存済みの 1Password アカウントのドメイン。テスト サーバーの場合: b5test.com、b5test.ca、またはb5test.eu。実稼働サーバーの場合: 1password.com、1password.ca、または1password.eu。

status

string

顧客の請求アカウントのステータス。可能な値は次のいずれかです。

  • entitledプロビジョニングは開始されましたが、顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用していません。

  • provisioned顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用し、サードパーティの請求アカウントがプロビジョニングされています。

deployed_members

integer

1Password アカウントにプロビジョニングされたユーザーの数。

created_at

string

updated_at

string

ends_at

string

エラー応答

403認証ヘッダーが欠落しているか、無効なトークンが指定された場合に返されます。

Example error

{

"code": 403,

"error": "forbidden",

"description": "Invalid auth token."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

404リソースまたはリソースの依[Save]関係が見つからない場合に返されます。

Example error

{

"code": 404,

"error": "not_found",

"description": "Failed to find the requested account."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

410リソースが削除されたときに返されます。

Example error

{

"code": 410,

"error": "gone",

"description": "The requested account is gone."

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

500予期しないエラーが発生した場合に返されます。

Example error

{

"code": 500,

"error": "internal_server_error",

"description": "Internal server error"

}

Error object schema

パラメータ

タイプ

説明

code

integer

エラーの HTTP 応答コード。

error

string

コードを表す、機械で解析可能な文字列。

description

string

エラーの説明。

Servers

Endpoints

に登録すると、パートナーシップ チームから、パートナーシップ API への呼び出しを承認するために必要なベアラー トークンが提供されます。

で使うトークンが別々に提供されます。Create業している環境で承認されたトークンを必ず使用してください。

いずれかの環境で新しいベアラー トークンが必要な場合は、

Authorization: パートナーシップ API への各 GET、POST、DELETE、および PATCH リクエストは、を使用して承認される必要があります。

をお持ちでない場合、またはinvalid auth tokenAPI へのリクエスト時にエラーが発生した場合は、1Password パートナーシップ チームにお問い合わせください。

顧客の請求アカウントを削除する予定の日時。日付は過去の日付にすることはできません。日付、時刻、およびオプションのタイムゾーンは、に従ってフォーマットします。

パートナーシップ API にを行って、顧客の新しいパートナー請求アカウントをCreateし、固有のアクティベーション トークンを生Createします。

で返されたトークンを1Password パートナーシップ引き換えリンクに追加して、。次に、顧客にリンクを提供します。

顧客のパートナー請求リンクをCreateするには、1Password パートナーシップ引き換えリンク (https://start.[1password_domain]/partnership/redeem) を調整して、目的の 1Password ドメインを使用します。次に、アカウント タイプとアクティベーション トークンに必要なパラメーターを含むクエリ文字列を追加します。オプションのを含めることもできます。

で返されるトークンの値。例: 4266474b-6385-56d4-7b75-648096593064。

オプションのコードの値は en, de, es, fr, it, ja, ko, nl, pt-BR, ru, zh-Hans, zh-Hantです。

どのリンクをCreateする必要があるかわからない場合は、

保存済みの 1Password アカウントを持つお客様の場合、パートナーの請求リンクは、1Password アカウントの種類とドメインがで指定されたものと同じである場合にのみ機能します。

保存済みやを変更する際にサポートが必要な場合は、ください。

保存済み

また、各タイプのリンクを 1 つずつCreateし、顧客に両方を提供して、必要なオプションを選択できるようにすることもできます。ただし、両方のオプションを可能にするをCreateする方が、より良い解決策となる場合があります。

顧客が新しい 1Password アカウントでのみ使用できるパートナー請求リンクをCreateするには、1Password サインアップ リンク ( https://start.[1password_domain]/sign-up/[account_type]) を調整して、希望する 1Password ドメインとアカウント タイプを使用します。次に、必要なアクティベーション トークン パラメータを含むクエリ文字列を追加します。オプションのを含めることもできます。例:

適切な値に置き換えます。例:

保存済みの 1Password アカウントでのみ顧客が使用できるパートナー請求リンクをCreateするには、1Password アカウントのサインイン リンク ( https://my.[1password_domain]/partnership/link) を調整して、目的の 1Password ドメインを使用します。次に、必要なアクティベーション トークン パラメータを含むクエリ文字列を追加します。オプションのを含めることもできます。例:

とパラメータを適切な値に置き換えます。例:

プレースホルダー

アカウント タイプは、ためのリンクでのみ使用されます。可能な値はindividualまたはfamily です。

で返されるトークンの値。例: 4266474b-6385-56d4-7b75-648096593064。

オプションのコードの値はen, de, es, fr, it, ja, ko, nl, pt-BR, ru, zh-Hans, またはzh-Hantです。

に追加できるオプションのパラメータで、顧客をその言語の適切なランディング ページに誘導します。言語パラメータが含まれていない場合、顧客はデフォルトのランディング ページ (英語) に誘導されます。

POST 呼び出しは、パートナー請求サービスを通じて顧客の新しいサードパーティ請求アカウントをCreateし、顧客がプロビジョニングを完了するためのパートナー請求リンクをCreateするために使う

と必要な含むエンドポイント URL を使用します。次の内容を含むオブジェクトを

(オプション) パートナーの請求サービスから顧客のアカウントを削除する日時。この値は過去のものにすることはできません。PATCHを使用してこのフィールドを更新することもできます。

201応答では、顧客の 1Password アカウントをパートナーの請求アカウントにリンクするために使用される一意のを含む Account オブジェクトが返されます。

顧客の新規または保存済みの 1Password アカウントをパートナーの請求先アカウント (例: ) に接続するリンクをCreateするために使う。https://start.[1password_domain]/partnership/redeem?t=[account_type]&c=[activation_token]&l=[language_code]トークンは 1Password の個人アカウントまたはファミリー アカウントでのみ使用できます。チーム アカウントとビジネス アカウントはサポートされていません。

顧客の請求アカウントがCreateされた日時。ISO を使用します。

請求先アカウントが最後に更新された日時。ISO を使用します。このフィールドは、アカウントのステータスが変更されたときに更新されます。POST

顧客の請求アカウントがパートナーの請求サービスから削除される予定の日時。ISO を使用します。日時が指定されていない場合、期待値は nullです。

と必要な含むエンドポイント URL を使用して、顧客の課金アカウント情報をリクエストします。GET リクエストには本文が含まれていないため、Content-typeヘッダーは使用されません。

顧客の新規または保存済みの 1Password アカウントをパートナーの請求先アカウント (例: ) に接続するリンクをCreateするために使う。https://start.[1password_domain]/partnership/redeem?t=[account_type]&c=[activation_token]&l=[language_code]トークンは 1Password の個人アカウントまたはファミリー アカウントでのみ使用できます。チーム アカウントとビジネス アカウントはサポートされていません。

顧客の請求アカウントがCreateされた日時。ISO を使用します。

顧客の請求先アカウントが最後に更新された日時。ISO を使用します。このフィールドは、アカウントのステータスが変更されると更新されます。

顧客の請求アカウントがパートナーの請求サービスから削除される予定の日時。ISO を使用します。日時が指定されていない場合、期待値は nullです。

顧客の請求先アカウントを削除するには、必要なを含むエンドポイント URL を使用します。DELETE リクエストとそれに続く応答には本文が含まれていないため、Content-typeおよびAcceptヘッダーは使用されません。

と必要なを含むエンドポイント URL を使用します。フィールドを含むオブジェクトをends_atとして含めます。

顧客の新規または保存済みの 1Password アカウントをパートナーの請求先アカウント (例: ) に接続するリンクをCreateするために使う。https://start.[1password_domain]/partnership/redeem?t=[account_type]&c=[activation_token]&l=[language_code]トークンは 1Password の個人アカウントまたはファミリー アカウントでのみ使用できます。チーム アカウントとビジネス アカウントはサポートされていません。

顧客の請求アカウントがCreateされた日時。ISO を使用します。

顧客の請求先アカウントが最後に更新された日時。ISO を使用します。このフィールドは、アカウントのステータスが変更されると更新されます。

顧客の請求アカウントがパートナーの請求サービスから削除される予定の日時。ISO を使用します。日時が指定されていない場合、期待値は nullです。

言語

コード

英語

en

ドイツ語

de

スペイン語

es

フランス語

fr

イタリア語

it

日本語

ja

言語

コード

韓国語

ko

オランダ語

nl

ポルトガル語

pt-BR

ロシア語

ru

簡体字

zh-Hans

繁體中文

zh-Hant

1password-partnership-api.yml
1Password パートナー プログラムの Web サイト
1Password パートナーシップ チーム
OpenAPI 3.0 仕様
curl
POST
GET
DELETE
パッチ
​
​
1Password パートナー プログラム
テスト環境と本番環境
1Password パートナーシップ チームにお問い合わせください。
ベアラー トークン
ベアラートークン
ISO 8601 標準
POST call
POST レスポンス
顧客のパートナー請求リンクをCreateします
言語パラメータ
1Password パートナーシップ チームにお問い合わせください。
POST リクエスト
のアカウントの種類
地域
1Password サポートにお問い合わせ
新しい1Passwordアカウントのみ
の1Passwordアカウントのみ
単一のリンク
言語パラメータ
1Password ドメイン、アカウント タイプ、およびパラメータのプレースホルダーを
言語パラメータ
1Password ドメインのプレースホルダー
参照
言語コードは、パートナーの請求リンク
アクティベーション トークンを返します。
ベアラー トークン
リクエスト ヘッダーを
リクエスト本文として含めます。
リクエスト
アクティベーション トークン
ベアラー トークン
リクエスト ヘッダーを
リクエスト ヘッダーに
ベアラー トークン
ベアラー トークン
リクエスト ヘッダー
リクエスト ボディ
POST 応答
言語
新しい 1Password アカウントをCreateする
POST 応答
言語
アクティベーション トークン
8601 標準
8601 標準
8601 標準
アクティベーション トークン
8601 標準
8601 標準
8601 標準
アクティベーション トークン
8601 標準
8601 標準
8601 標準