Partnership API の子アカウントオブジェクト

このドキュメントでは、 Partnership API を使って子アカウントを管理する方法を説明します。アカウントについては、 child account オブジェクトを使用します。

要件

パートナーシップ API は、New Relic の担当者から使用するように特別に指示されない限り、あなたの組織では利用できません。

このオブジェクトを使用するためのアクセス権がない場合もあります。Partnership API を使用する前に、まず要件をお読みください。

子アカウントの使い方紹介

子アカウントオブジェクトを使用する際の注意点

既存の親アカウントや子アカウントを管理するには、 Partnership API account object を使用します。
親アカウントには、複数の子アカウントを関連付けることができますが、すべての子アカウントは、1つの親アカウントにのみ対応する必要があります。
すべての子アカウントには、少なくとも primary_admin のユーザーが必要です。
子アカウントを作成するには、既存の親アカウントに接続し、少なくとも1人のユーザーを追加する必要があります。

子アカウントオブジェクトの属性

Partnership API を使用する前に、まず要件をお読みください。

Partnership API の子アカウントオブジェクトの属性を示します。

タイプ：	文字列
デフォルト：	(なし)

この名前は、New Relic のデータベースで一意でなければなりません。指定した名前が一意でない場合は、以下のように数字のサフィックスを付けて自動インクリメントされます。

conflicting_name_1
conflicting_name_2
etc.

タイプ：	ブール値
デフォルト：	false

このフラグは、アプリケーションデータへのAPIアクセスを許可するものです。これは、リモートでアカウントを管理しているパートナーシップのために、 true に設定する必要があります。

タイプ：	ブール値
デフォルト：	false

テストアカウントであることを示すために、このフラグを使用します。テストアカウントは、ゴミのようなデータを含んでいると想定され、内部システムでは無視されます。テストアカウントが生成したデータは、いつでも削除することができます。

タイプ：	配列
デフォルト：	(なし)

ユーザーのリストを定義する配列です。アカウントの状態に応じて、いくつかの制限があります。

顧客のパートナーシップについて New Relic One ユーザーモデルに切り替えた場合: ユーザーを定義しないでください。このフィールドでユーザーを追加しても、無視されます。代わりに、ユーザーを追加するには、以下のユーザー管理手順を使用します。.
他のすべてのアカウントは、当社のオリジナルのユーザーモデルのユーザーを持っています。子アカウントを作成する際には、アカウント オーナー という 1 人のユーザーしか定義できません。ユーザーを追加するには、 Partnership API ユーザーオブジェクトを使用します。
制限の詳細については、 Requirements をご覧ください。

タイプ：	文字列
デフォルト：	(なし)

既存のユーザーをアカウント Owner として子アカウントを作成する場合、パスワードはユーザーの現在のパスワードと一致する必要があります。

一部の New Relic 組織では、子アカウントは親アカウントの Account settings ページを通して New Relic UI で作成することもできます。

子アカウントのAPIコール

以下は、子アカウントを作成するためのURLパターンです。親アカウントのIDを指定する必要があることに注意してください。このURLパターンを使用する場合、JSONオブジェクトに、 Partner API key を含むHTTPヘッダーを送信してください。例えば、以下のようになります。

POST .../api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts
x-api-key:PARTNER_ACCOUNT_KEY
Content-Type: application/json

{ JSON data }

コール	リソースURLパターン
与えられたパラメーターで、子アカウントを作成します。	`POST /api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts`

JSONの例

以下は、Partnership API の子アカウントオブジェクトを使用した JSON リクエストとレスポンスの例です。

なお、これは一例であり、一部のアカウントでは、 ユーザー 属性は不要であり、無視されることになります。

{
  "account": {
    "name": "Sample child account",
    "users": [
      {
        "email": "sample_user@sample.org",
        "password": "XXXXXXXX",
        "owner": true,
        "role": "admin",
        "first_name": "Sample",
        "last_name": "User"
      }
    ],
    "allow_api_access": true,
    "phone_number": "555-555-5555"
  }
}

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "XXXXXX",
  "api_key": "XXXXXX",
  "browser_monitoring_key": "XXXXXX",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "parent_account_id":XXXXXX,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1990.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

子アカウントオブジェクトAPIの例

以下は、Partnership API の子アカウントオブジェクトを使用した API コールの例です。

なお、これは一例であり、一部のアカウントでは、 ユーザー 属性は不要であり、無視されることになります。

リクエスト

curl -X POST \
-H 'x-api-key:PARTNER_ACCOUNT_KEY' \
-H 'Content-Type:application/json' \
-d '{"sub_account":{"name":"Sample child account"}, "users":[{"email":"sample_user@sample.org", "password":"XXXXXX", "first_name":"Sample", "last_name":"User", "role":"admin", "owner":"true"}]}' \
https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts

応答（改行は読みやすさのため）。

{
  "id": XXXXXX,
  "name": "Sample child account",
  "status": "pending",
  "license_key": "XXXXXX",
  "api_key": "XXXXXX",
  "browser_monitoring_key": "XXXXXX",
  "allow_api_access": false,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "parent_account_id":XXXXXX,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1999.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

Partnership API の子アカウントオブジェクト

要件

子アカウントの使い方紹介

子アカウントオブジェクトの属性

名前 (REQUIRED)

allow_api_access

テスト

ユーザー（一部のアカウントでは必須となります）

パスワード (REQUIRED)

子アカウントのAPIコール

JSONの例

子アカウントオブジェクトのJSONリクエスト

JSONレスポンス

子アカウントオブジェクトAPIの例

クリエイト