이 문서에서는 Partnership API 를 사용하여 사용자를 추가하고 관리하는 방법을 설명합니다.
요구 사항
New Relic 담당자가 사용해야 한다고 특별히 지시하지 않는 한 Partnership API는 조직에서 사용할 수 없습니다.
조직에 원래 사용자 모델의 사용자가 있는 경우에만 사용자 개체를 사용할 수 있습니다. API를 사용하기 전에 Partnership API 요구 사항 을 읽으십시오.
사용자 개체 속성
사용자 개체는 고객 정보를 저장합니다. 한 명 이상의 사용자가 계정과 연관될 수 있습니다. 또한 특정 사용자는 여러 계정과 연결될 수 있습니다.
이것은 사용자 개체의 속성 목록입니다. New Relic 계정을 생성할 때 한 명의 사용자 에게 소유자 속성을 할당해야 합니다.
중요
New Relic은 사용자당 최대 1,000개의 계정을 권장합니다. 추가 계정으로 인해 일부 New Relic 기능에 대한 액세스가 제한될 수 있습니다.
이 속성은 신규 사용자에게 필요 합니다.
사용자의 이메일 주소입니다. 이 이메일 주소에 대한 사용자 기록이 이미 있는 경우 이 계정에 연결됩니다. 현재 사용자 개체 생성 프로세스의 모든 설정은 무시됩니다.
특수 문자가 포함된 이메일 이름에는 URL 인코딩이 필요합니다. 예를 들어, +
대신 URL로 인코딩된 대체 %2B
을 사용합니다.
이 속성은 신규 사용자에게 필요 합니다.
이메일 주소가 기존 사용자 레코드와 일치하는 경우 이 사용자의 비밀번호는 무시됩니다. Partnership API 버전 2부터 계정 생성 호출의 일부로 전달된 비밀번호는 요구 사항 을 충족해야 합니다.
주의
이 형식을 따르지 않는 계정 프로비저닝 호출의 일부로 전달된 암호는 오류를 생성하고 작업을 실패하게 합니다.
이 속성은 신규 사용자에게 필요 합니다.
이 사용자의 이름입니다.
이 속성은 신규 사용자에게 필요 합니다.
이 사용자의 성입니다.
이 사용자가 계정의 소유자 인지 여부를 나타내는 플래그입니다. New Relic 계정을 생성할 때 한 명의 사용자에게 소유자 역할을 할당 해야 합니다.
이 속성은 신규 사용자에게 필요 합니다.
이 사람의 역할 :
사용자 호출
다음은 사용자 관련 API 기능에 대한 URL 패턴입니다. 이 URL 패턴을 사용하는 경우 JSON 요청 본문과 함께 파트너 API 키 가 포함된 HTTP 헤더를 보냅니다. 예를 들어:
GET .../api/v2/partners/PARTNER_ID/accounts/ID
x-api-key:PARTNER_ACCOUNT_KEY
Content-Type: application/json
부르다 | 리소스 URL 패턴 |
---|
계정의 모든 사용자를 나열 (색인)합니다. | GET /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users
|
계정에서 사람의 역할을 업데이트 합니다. | PUT /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users/ID
|
계정에 사용자를 생성 (추가)합니다. POST 작업당 한 명의 사용자만 생성할 수 있습니다. | 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 호출의 예입니다.
목록 요청:
-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=
매개변수를 추가합니다.
중요
POST 명령당 하나의 새 users
객체만 만들 수 있습니다.
요청 생성:
-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}]}
업데이트 요청:
-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}]}
요구:
-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
응답: 응답 본문이 없습니다.