このドキュメントでは、 Partnership API を使ってユーザーを追加・管理する方法を説明しています。
要件
パートナーシップ API は、New Relic の担当者から使用するように特別に指示されない限り、あなたの組織では利用できません。
ユーザオブジェクトを使用できるのは、あなたの組織が当社のオリジナルのユーザモデルのユーザを持っている場合のみです。API を使用する前に、 Partnership API requirements をお読みください。
ユーザーオブジェクトの属性
ユーザーオブジェクトは、お客様の情報を保存します。1つのアカウントに1人以上のユーザーを関連付けることができます。また、特定のユーザーが複数のアカウントに関連付けられることもあります。
これは、ユーザーオブジェクトの属性のリストです。New Relic アカウントの作成時に、 owner 属性を 1 人のユーザーに割り当てていることを確認してください。
重要
New Relic では、1 ユーザーあたり最大 1,000 アカウントまでを推奨しています。アカウント数が増えると、New Relic の一部の機能へのアクセスが制限される場合があります。
この属性は、新規ユーザーには 必須 です。
ユーザーの電子メールアドレスです。このメールアドレスにすでにユーザーレコードが存在する場合は、このアカウントにリンクされます。現在のユーザーオブジェクト作成プロセスでの設定は無視されます。
特殊文字を含むメール名は、URLエンコードが必要です。例えば、 + の代わりに、URL エンコードされた置換 %2B を使用します。
この属性は、新規ユーザーには 必須 です。
メールアドレスが既存のユーザレコードと一致する場合、このユーザのパスワードは無視されます。Partnership API バージョン 2 では、アカウント作成コールの一部として渡されるパスワードは、 要件 を満たす必要があります。
注意
アカウントプロビジョニングコールの一部として渡されたパスワードがこのフォーマットに準拠していない場合は、エラーが発生し、操作が失敗する原因となります。
この属性は、新規ユーザーには 必須 です。
このユーザーのファーストネームです。
この属性は、新規ユーザーには 必須 です。
このユーザーのラストネームです。
このユーザーがアカウントの オーナー であるかどうかを示すフラグです。New Relic アカウントを作成する際には、 **一人のユーザーに オーナー** の役割を割り当てる必要があります。
この属性は、新規ユーザーには 必須 です。
役割 この人のために。
ユーザーコール
ここでは、ユーザー関連のAPI機能のURLパターンをご紹介します。このURLパターンを使用する場合は、JSONリクエストボディとともに、 Partner API Key を含むHTTPヘッダを送信してください。例えば、以下のようになります。
GET .../api/v2/partners/PARTNER_ID/accounts/ID
x-api-key:PARTNER_ACCOUNT_KEY
Content-Type: application/json
{ JSON data }
コール | リソースURLパターン |
|---|
リスト （インデックス）アカウントの全ユーザー。 | GET /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users
|
更新 アカウントの人の役割を変更します。 | PUT /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users/ID
|
Create (add) a user to an account. 1回のPOST操作で作成できるユーザーは1人だけです。 | POST /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users
|
****ユーザーをアカウントから削除します。 ユーザーを削除すると、指定したアカウントからそのユーザーが削除されます。Partnership API を通じてオーナーをアカウントから削除することはできません。 | DELETE /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users/ID
|
ユーザーオブジェクトのJSONの例
本APIを使用する前に、 要件 をお読みください。
以下は、Partnership API のユーザーオブジェクトを使用した JSON リクエストとレスポンスの例です。
"email": "jsmith@gmail.com",
"password": "testing123",
以下は、そのアカウントのユーザーをリストアップしたJSONレスポンスの例です。
"email": "user-name1@company.com",
"email": "user-name2@company.com",
"email": "user-name3@company.com",
ユーザーオブジェクトAPIの例
以下は、Partnership API ユーザーオブジェクトを使用した API コールの例です。
リストリクエスト
curl -X GET \
-H 'x-api-key:PARTNER_ACCOUNT_KEY' \
-H 'Content-Type:application/json' \
https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/12345/users
レスポンス
{"users":[{"id":12345,"email":"xx@newrelic.com","role":"admin","owner":1}]}
1,000人以上のユーザーがいるアカウントでは、ページ分割されたレスポンスが返されます。
ページを指定するには、クエリに ?page= というパラメータを追加します。
重要
1つのPOSTコマンドにつき、新しい users オブジェクトは1つしか作成できません。
リクエストを作成します。
curl -X POST \
-H 'x-api-key:PARTNER_ACCOUNT_KEY' \
-H 'Content-Type:application/json' \
-d '{"users":[{"email": "foobar@newrelic.com", "password":"password1", "first_name":"John", "last_name":"Doe", "role":"admin" }]}' \
https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/12345/users
応答（改行は読みやすさのため）。
{"users":[{"id":12345,"email":"xx@newrelic.com","role":"admin","owner":1},
{"id":23456,"email":"foobar@newrelic.com","role":"admin","owner":0}]}
アップデートの依頼。
curl -X PUT \
-H 'x-api-key:PARTNER_ACCOUNT_KEY' \
-H 'Content-Type:application/json' \
-d '{"users":[{"role": "restricted"}]}' \
https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/12345/users/23456
レスポンス（読みやすさのために改行しています）
{"users":[{"id":12345,"email":"xx@newrelic.com","role":"admin","owner":1},
{"id":23456,"email":"foobar@newrelic.com","role":"restricted","owner":0}]}
リクエスト
curl -X DELETE \
-H 'x-api-key:PARTNER_ACCOUNT_KEY' \
-H 'Content-Type:application/json' \
https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/12345/users/23456
応答します。レスポンスボディはありません。