はい
新規アカウントのみ
| | {activation\_token} | [POST 応答](https://developer.1password.com/docs/partnership-api/reference/#success-response)で返されるトークンの値。例: 4266474b-6385-56d4-7b75-648096593064。 | はい | | {language\_code} | オプションの[言語](https://developer.1password.com/docs/partnership-api/reference/#language-codes)コードの値はen, de, es, fr, it, ja, ko, nl, pt-BR, ru, zh-Hans, またはzh-Hantです。 | いいえ | **言語コード** オプションの言語コード パラメータの詳細について説明します。 [言語コードは、パートナーの請求リンク](https://developer.1password.com/docs/partnership-api/reference/#create-a-link-for-customers)に追加できるオプションのパラメータで、顧客をその言語の適切なランディング ページに誘導します。言語パラメータが含まれていない場合、顧客はデフォルトのランディング ページ (英語) に誘導されます。 言語パラメータでは次の言語コードを使用できます。 | 0UkVhO3HLLeq | zuyO4aP6oj8K | | ------------ | ------------ | | **言語** | **コード** | | 英語 | en | | ドイツ語 | de | | スペイン語 | es | | フランス語 | fr | | イタリア語 | it | | 日本語 | ja | | **言語** | **コード** | | 韓国語 | ko | | オランダ語 | nl | | ポルトガル語 | pt-BR | | ロシア語 | ru | | 簡体字 | zh-Hans | | 繁體中文 | zh-Hant | ### **請求先** POST \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**功レスポンス** 201応答では、顧客の 1Password アカウントをパートナーの請求アカウントにリンクするために使用される一意の[アクティベーション トークン](https://developer.1password.com/docs/partnership-api/reference/#activation-tokens)を含む Account オブジェクトが返されます。 **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 | 顧客の新規または保存済みの 1Password アカウントをパートナーの請求先アカウント (例: ) に接続するリンクをCreateするために使う[アクティベーション トークン](https://developer.1password.com/docs/partnership-api/reference/#activation-tokens)。プロビジョニングされた顧客請求アカウントのステータス。可能な値は次のいずれかです。
POST リクエストの期待値は entitledです。
| | **deployed\_members** | integer |1Password アカウントにプロビジョニングされたユーザーの数。POST
リクエストに対して返される予想値は 0です。
| | **created\_at** | string | 顧客の請求アカウントがCreateされた日時。ISO [8601 標準](https://www.iso.org/iso-8601-date-and-time-format.html)を使用します。 | | **updated\_at** | string |請求先アカウントが最後に更新された日時。ISO 8601 標準を使用します。このフィールドは、アカウントのステータスが変更されたときに更新されます。POST
リクエストに対して返される予想値は、created\_atプロパティの値と同じです。
| | **ends\_at** | string | 顧客の請求アカウントがパートナーの請求サービスから削除される予定の日時。ISO [8601 標準](https://www.iso.org/iso-8601-date-and-time-format.html)を使用します。日時が指定されていない場合、期待値は nullです。 | #### **エラー応答** 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 \customer\_account\_uid
必須
| string | 顧客の請求アカウントの一意の ID。 | #### **リクエスト** [ベアラー トークン](https://developer.1password.com/docs/partnership-api/reference/#authorization)と必要な[リクエスト ヘッダーを](https://developer.1password.com/docs/partnership-api/reference/#request-headers)含むエンドポイント URL を使用して、顧客の課金アカウント情報をリクエストします。GET リクエストには本文が含まれていないため、Content-typeヘッダーは使用されません。 **Example request** curl --request GET \\ \--urlプロビジョニングされた顧客請求アカウントのステータス。可能な値は次のいずれかです。
customer\_account\_uid
必須
| string | 削除する顧客請求アカウントの一意の ID。 | #### **リクエスト** 顧客の請求先アカウントを削除するには、必要な[リクエスト ヘッダーに](https://developer.1password.com/docs/partnership-api/reference/#request-headers)[ベアラー トークン](https://developer.1password.com/docs/partnership-api/reference/#authorization)を含むエンドポイント URL を使用します。DELETE リクエストとそれに続く応答には本文が含まれていないため、Content-typeおよびAcceptヘッダーは使用されません。 **Example request** curl --request DELETE \\ \--urlcustomer\_account\_uid
必須
| string | 顧客の請求アカウントの一意の ID。 | #### **リクエスト** [ベアラー トークン](https://developer.1password.com/docs/partnership-api/reference/#authorization)と必要な[リクエスト ヘッダー](https://developer.1password.com/docs/partnership-api/reference/#request-headers)を含むエンドポイント URL を使用します。フィールドを含むオブジェクトを[リクエスト ボディ](https://developer.1password.com/docs/partnership-api/reference/#request-bodies)ends\_atとして含めます。 顧客の請求アカウントをパートナーシップ請求サービスから削除する予定の日時を追加または更新するには、RFC 3339 で定義された形式で、新しい日時をends\_at値として含めます。 顧客の請求先アカウントから終了日時を削除するには、値として空の文字列 ( "") またはnullを使用します。 **Example request** curl --request PATCH \\ \--urlends\_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 | 顧客の新規または保存済みの 1Password アカウントをパートナーの請求先アカウント (例: ) に接続するリンクをCreateするために使う[アクティベーション トークン](https://developer.1password.com/docs/partnership-api/reference/#activation-tokens)。顧客の請求アカウントのステータス。可能な値は次のいずれかです。