자동화된 사용자 관리: SCIM API

ID 제공자로부터 New Relic 사용자의 프로비저닝 및 관리를 설정하기 위해 아직 New Relic 관련 앱 및 구현 이 없는 ID 제공자를 위한 SCIM API를 제공합니다.

누가 SCIM API를 사용해야 합니까?

뉴렐릭 앱(Azure AD, Okta 및 OneLogin)이 있는 ID 공급자가 있는 경우 해당 가이드를 참조하세요. SCIM API 해당 ID 공급업체를 사용하지 않거나 앱에서 사용할 수 없는 추가 설정을 위해 SCIM API 사용하려는 조직을 위한 것입니다(예: managing user type). 추가 제한사항:

Ping Identity의 PingOne은 그룹 프로비저닝을 허용하지 않기 때문에 지원되지 않습니다.

SCIM API를 사용하기 전에 먼저 SCIM이 활성화된 인증 도메인을 설정 해야 합니다. 인증 도메인 UI는 ID 공급자와 통합하는 데 사용할 수 있는 값을 제공합니다.

SCIM API와의 통합을 설정한 후에는 일부 사용자를 기본 사용자로 다운그레이드하고 사용자 그룹에 New Relic 계정에 대한 액세스 권한을 부여하는 등 수행해야 할 다음 단계 가 있습니다.

SCIM API 튜토리얼

이 문서에는 SCIM API에 대한 기술 정보가 포함되어 있습니다. 사용에 대한 자세한 지침은 SCIM API 자습서 를 참조하십시오.

SCIM 서비스 제공업체

SCIM 서비스 제공업체는 RFC 7643 및 7644 에 설명된 대로 SCIM 2.0 API 를 따릅니다. 사용자 정보를 New Relic과 통합하기 위해 SCIM 2.0 사양의 모든 측면을 구현할 필요는 없습니다. 사실, New Relic 서비스 공급자 자체가 사양의 모든 측면을 구현하지는 않습니다. 이 문서는 New Relic과의 통합에 사용할 수 있는 사양의 기능을 설명합니다.

입증

인증에는 무기명 토큰이 필요합니다. 이 전달자 토큰은 New Relic 인증 도메인 에 고유하며 인증 도메인에 대해 SCIM을 처음 활성화할 때 표시됩니다.

지원되는 리소스

New Relic 서비스 제공업체는 Group , User , Service provider config , Resource type 및 Schema SCIM 리소스를 지원합니다. Bulk 및 Search 은(는) 지원되지 않습니다. RFC가 리소스 끝점을 설명하는 방법에 대한 자세한 내용은 RFC 7644 SCIM 프로토콜 사양 을 참조하세요.

스키마

New Relic은 SCIM 핵심 스키마에서 사용 가능한 필드의 하위 집합을 사용합니다. 다른 SCIM 필드는 들어오는 요청에 포함된 경우 무시됩니다. New Relic이 사용하는 필드는 다음과 같습니다.

Group:

SCIM 필드 이름	설명
`displayName`	Required. 그룹의 이름입니다.
`members`	그룹의 사용자 목록입니다.

User:

SCIM 필드 이름	설명
`externalId`	시스템에서 사용하는 사용자의 고유 식별자입니다.
`userName`	Required. 뉴렐릭 시스템 내에서 사용자에 대한 고유한 논란입니다. 사용자의 이메일 주소를 사용하세요.
`name.familyName`	사용자의 성입니다.
`name.givenName`	사용자의 이름입니다.
`emails` 또는 `emails.value`	Required. 사용자의 이메일 주소입니다.
`timezone`	"Olson" 시간대 데이터베이스 형식이라고도 하는 IANA 시간대 데이터베이스 형식의 사용자 시간대(예: "America/Los_Angeles").
`active`	Required. 사용자가 New Relic 내에서 활성 또는 비활성 상태여야 하는지 여부를 나타내는 부울입니다.
`groups`	사용자가 속한 그룹 목록입니다.

New Relic 사용자 유형(기본, 코어 또는 전체) 스키마

이것은 New Relic 관련 사용자 속성에 대한 선택적 스키마 확장 입니다. 현재 이것은 사용자의 사용자 유형 에 대해서만 제어를 제공합니다. 이것을 사용하는 방법을 보여주는 튜토리얼은 SCIM API 튜토리얼 을 참조하십시오.

urn:ietf:params:scim:schemas:extension:newrelic:2.0:User:

SCIM 필드 이름	설명
`nrUserType`	사용자 유형 : `full user` , `core user` 또는 `basic user`

지원되는 작업

SCIM은 그룹 및 사용자를 조작하기 위한 여러 옵션을 제공합니다. New Relic 서비스 제공자는 다음과 같은 옵션을 지원합니다.

구성할 때 다음 사항에 유의하십시오.

단순 필터링만 지원됩니다. eq 연산자는 기본 필터 표현식과 함께 사용할 수 있습니다. 예: “displayName eq "Example Group 1” . 다른 연산자는 지원되지 않습니다.
PUT 업데이트 시 모든 필드가 포함될 필요는 없습니다. 포함되지 않은 필드는 변경되지 않습니다. PUT 을 수행할 때 필수 필드에 이미 적절한 값이 있으면 해당 필드를 포함할 필요가 없습니다.

지원되는 작업은 다음과 같습니다.

요청 예시:

POST /Groups

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Example Group 1",
  "members": []
}

예시 응답:

201 Created

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T21:33:13.055Z"
  },
  "members": []
}

요청 예시:

GET /Groups/YOUR_GROUP_ID

예시 응답:

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T21:33:13.055Z"
  },
  "members": []
}

요청 예시:

GET /Groups?filter=displayName eq "Example Group 1"

예시 응답:

200 OK

{
  "totalResults": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [{
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
    "displayName": "Example Group 1",
    "meta": {
      "resourceType": "Group",
      "created": "2019-11-08T21:33:13.055Z",
      "lastModified": "2019-11-08T21:33:13.055Z"
    },
    "members": []
  }]
}

변경하려는 필드를 요청에 포함합니다. members 필드를 포함하면 그룹의 사용자가 구성원 필드의 내용과 일치하도록 조정됩니다. 요청 예시:

PUT /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Example Group 1a"
}

예시 응답:

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1a",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T22:47:14.019Z"
  },
  "members": []
}

요청 예시:

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Replace",
    "path": "displayName",
    "value": "Example Group 1b"
  }]
}

예시 응답:

204 No Content

요청 예시:

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Add",
    "path": "members",
    "value": [{
      "value": "f0cbc276-16c9-4d1a-abc0-1856b0c74224"
    }]
  }]
}

예시 응답:

204 No Content

요청 예시:

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Remove",
    "path": "members",
    "value": [{
      "value": "f0cbc276-16c9-4d1a-abc0-1856b0c74224"
    }]
  }]
}

예시 응답:

204 No Content

요청 예시:

POST /Users

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "groups": []
}

예시 응답:

201 Created

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:07:12.477Z"
  },
  "groups": []
}

요청 예시:

GET /Users/YOUR_USER_ID

예시 응답:

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:07:12.477Z"
  },
  "groups": []
}

요청 예시:

GET /Users?filter=externalId eq "external-id-1"

예시 응답:

200 OK

{
  "totalResults": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [{
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
    "externalId": "external-id-1",
    "userName": "example-user-1@example.com",
    "name": {
      "familyName": "User 1",
      "givenName": "Example"
    },
    "emails": [{
      "value": "example-user-1@example.com",
      "primary": true
    }],
    "timezone": "America/Los_Angeles",
    "active": true,
    "meta": {
      "resourceType": "User",
      "created": "2019-11-08T22:07:12.477Z",
      "lastModified": "2019-11-08T22:07:12.477Z"
    },
    "groups": []
  }]
}

변경하려는 필드를 요청에 포함합니다. groups 필드를 포함하면 사용자 그룹이 그룹 필드의 내용과 일치하도록 조정됩니다. 요청 예시:

PUT /Users/YOUR_USER_ID

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "name": {
    "familyName": "User 1A",
    "givenName": "Example"
  }
}

예시 응답:

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1A",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:28:33.552Z"
  },
  "groups": []
}

요청 예시:

PATCH /Users/YOUR_USER_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Replace",
    "path": "active",
    "value": "false"
  }]
}

예시 응답:

204 No Content

RFC와의 편차

이 섹션에서는 New Relic SCIM 서비스 공급자가 SCIM 프로토콜 RFC 7644 에서 벗어나는 영역에 대해 설명합니다. 섹션 번호는 RFC 섹션 번호를 나타냅니다.

이 섹션의 항목은 서비스 공급자가 RFC를 완전히 준수하도록 작업하는 동안 변경될 수 있습니다.

RFC 섹션 이름	RFC 섹션 번호	편차 설명
리소스 생성	3.3.	`meta.location` 필드가 설정되지 않았습니다.
필터링	3.4.2.2.	현재 지원되는 유일한 연산자는 `eq` 입니다. 필드 이름은 대소문자를 구분합니다. 문자열 속성은 대소문자를 구분하여 비교됩니다. 스키마를 사용하여 필드 이름을 접두사로 사용하는 것은 지원되지 않습니다. 예를 들어, `filter=urn:ietf:params:scim:schemas:core:2.0:User:userName eq "johnsmith"` 은(는) 작동하지 않습니다.
`/Me` 인증된 제목 별칭	3.11.	`GET` `/Me` 리소스와 함께 `404 Not Found` 을 반환합니다.
서비스 공급자 구성 끝점	4.	서비스 공급자 기능 검색 끝점은 필터링을 지원하지 않습니다.
무기명 토큰 및 쿠키 고려 사항	7.4.	무기명 토큰에는 만료 날짜가 설정되어 있지 않습니다.

완료되면 다음 단계

다음 단계:

사용자의 사용자 유형 조정

사용자가 뉴렐릭에 프로비저닝되면 User management UI 에서 볼 수 있습니다.

SCIM을 통해 New Relic에 사용자를 추가하지만 SCIM 을 통해 사용자 유형을 관리 하지 않는 경우 기본 사용자 로 시작합니다. 사용자를 업그레이드하려면 다음 두 가지 옵션이 있습니다.

사용자 관리 UI 를 사용합니다.
SCIM API를 사용하여 사용자 유형을 관리합니다 .

그룹 액세스 할당

사용자가 New Relic에 있으면 특정 New Relic 계정, 특정 그룹 및 특정 역할에 대한 액세스 권한을 부여해야 합니다. 이렇게 하지 않으면 사용자는 New Relic 계정에 액세스할 수 없습니다. 이 작업을 수행하는 방법을 알아보려면 다음을 참조하세요.

SAML SSO 설정

대부분의 SCIM 사용자가 수행하는 SAML SSO를 설정하려면 SAML SSO 문서 를 참조하세요.

사용자의 편의를 위해 제공되는 기계 번역입니다.

자동화된 사용자 관리: SCIM API

누가 SCIM API를 사용해야 합니까?

SCIM API 튜토리얼

SCIM 서비스 제공업체

입증

지원되는 리소스

스키마

New Relic 사용자 유형(기본, 코어 또는 전체) 스키마

지원되는 작업

그룹 생성

그룹 가져오기

쿼리별로 그룹화 가져오기

PUT으로 그룹 업데이트

PATCH로 그룹 업데이트(비구성원 필드)

PATCH로 그룹 업데이트(구성원 추가)

PATCH로 그룹 업데이트(구성원 제거)

그룹 삭제

사용자 생성

사용자 가져오기

쿼리로 사용자 가져오기

PUT으로 사용자 업데이트

PATCH로 사용자 업데이트

사용자 삭제

RFC와의 편차

완료되면 다음 단계

사용자의 사용자 유형 조정

그룹 액세스 할당

SAML SSO 설정

사용자의 편의를 위해 제공되는 기계 번역입니다.

자동화된 사용자 관리: SCIM API

누가 SCIM API를 사용해야 합니까? .css-21sua1{background:none;border:none;width:0;padding:0;}

SCIM API 튜토리얼

SCIM 서비스 제공업체

입증

지원되는 리소스

스키마

New Relic 사용자 유형(기본, 코어 또는 전체) 스키마

지원되는 작업

그룹 가져오기

쿼리별로 그룹화 가져오기

PUT으로 그룹 업데이트

PATCH로 그룹 업데이트(비구성원 필드)

PATCH로 그룹 업데이트(구성원 추가)

PATCH로 그룹 업데이트(구성원 제거)

그룹 삭제

사용자 생성

사용자 가져오기

쿼리로 사용자 가져오기

PUT으로 사용자 업데이트

PATCH로 사용자 업데이트

사용자 삭제

RFC와의 편차

완료되면 다음 단계

사용자의 사용자 유형 조정

그룹 액세스 할당

SAML SSO 설정

누가 SCIM API를 사용해야 합니까?