SCIM(교차 도메인 ID 관리 시스템) API

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기234분

    • SCIM(System for Cross-domain Identity Management) API는 SCIM 프로토콜을 사용하여 사용자 및 그룹에 대한 작업을 생성, 읽기, 업데이트 및 삭제하는 엔드포인트를 제공합니다.

    SCIM 프로토콜은 HTTP[RFC7230] 표준을 기반으로 하는 애플리케이션 수준 HTTP 기반 프로토콜입니다. 이 API는 엔터프라이즈-클라우드 서비스 제공자 또는 클라우드 간 시나리오와 같은 웹 및 도메인 간 환경에서 사용자 및 그룹과 같은 ID 데이터를 프로비저닝하고 관리하는 데 사용합니다.

    이 API에 액세스하려면 SCIM v2 - ServiceNow® Cross-domain Identity Management(com.snc.integration.scim2) 플러그인을 활성화해야 합니다.

    리소스 매핑

    SCIM 서비스에는 6개의 리소스가 있습니다.
    • 사용자(코어 및 확장)
    • 그룹(코어 및 확장)
    • 회사
    • CostCenter
    • 부서
    • 위치
    이러한 SCIM 자원에 있는 대부분의 속성은 기존 ServiceNow 테이블의 해당 필드에 매핑됩니다. 다음 테이블에서는 이러한 매핑을 정의합니다. 기존 ServiceNow 테이블의 필드에 해당하지 않는 속성은 두 개의 SCIM 관련 테이블에 매핑됩니다. 이러한 테이블에 대한 자세한 내용은 SCIM 관련 테이블을 참조하세요.

    SCIM 사용자 리소스에는 코어(스키마: urn:ietf:params:scim:schemas:core:2.0:User) 및 확장(urn:ietf:params:scim:schemas:extension:servicenow:2.0:User) 스키마가 모두 있습니다. 대부분의 사용자 코어 및 확장 스키마 속성은 사용자 [sys_user] 테이블에 매핑됩니다.

    표 1. 사용자 자원과 사용자 [sys_user] 테이블 매핑
    SCIM 속성 이름 사용자 필드 이름
    active active
    주소.국가 국가
    addresses.default.country 국가
    addresses.home.country 국가
    주소.구/군/시 구/군/시
    addresses.default.locality 구/군/시
    주소.홈.지역 구/군/시
    addresses.postalCode 우편번호
    addresses.default.postalCode 우편번호
    주소.집.우편 번호 우편번호
    주소.지역 상태
    addresses.default.region 상태
    주소.홈.지역 상태
    주소.거리 주소 주소
    addresses.default.streetAddress 주소
    주소.집.거리 주소 주소
    displayName 이름
    emails.value 이메일
    emails.default.value 이메일
    emails.work.value 이메일
    id sys_id
    meta.created입니다. sys_created_on
    meta.lastModified sys_updated_on
    name.familyName last_name
    name.givenName (이름.givenName) first_name
    name.honorificPrefix 소개
    이름.중간 이름 middle_name
    phoneNumbers.값 전화
    phoneNumbers.home.value (전화번호.홈.값) home_phone
    phoneNumbers.mobile.value mobile_phone
    phoneNumbers.작업.값 전화
    preferredLanguage preferred_language
    시간대 time_zone
    직위 직위
    userName user_name
    표 2. 사용자 자원과 Sys Scim 사용자 [sys_scim_user] 테이블 매핑
    SCIM 속성 이름 Sys Scim 사용자 필드 이름
    externalId external_id

    SCIM 사용자 확장 스키마(urn:ietf:params:scim:schemas:extension:servicenow:2.0:User)는 사용자 [sys_user] 테이블에 매핑됩니다.

    표 3. 사용자 확장 자원을 사용자 [sys_user] 테이블로 매핑
    SCIM 속성 이름 사용자 필드 이름
    company.name company.name
    회사.가치 company.sys_id
    costCenter.name cost_center.이름
    costCenter.value cost_center.sys_id
    department.name department.name
    부서.값 department.sys_id
    employeeNumber employee_number
    성별 성별
    location.name location.name
    위치.값 location.sys_id
    manager.displayName manager.name
    관리자.값 manager.sys_id

    SCIM 그룹 리소스 스키마(urn:ietf:params:scim:schemas:core:2.0:Group)는 그룹 [sys_user_group] 테이블에 매핑됩니다.

    표 4. 그룹 자원과 그룹 [sys_user_group] 테이블 매핑
    SCIM 속성 이름 그룹 필드 이름
    displayName 이름
    id sys_id
    meta.created입니다. sys_created_on
    meta.lastModified sys_updated_on

    SCIM 그룹 externalId 매개변수는 Sys Scim 그룹 [sys_scim_group] 테이블에 매핑됩니다.

    표 5. Sys Scim 그룹 [sys_scim_group] 테이블 매핑에 대한 그룹 자원
    SCIM 속성 이름 Sys Scim 그룹 필드 이름
    externalId external_id

    SCIM 그룹 ServiceNow 확장 스키마(urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group)는 그룹 [sys_user_group] 테이블에 매핑됩니다.

    표 6. 그룹 자원과 그룹 [sys_user_group] 테이블 매핑
    SCIM 속성 이름 그룹 필드 이름
    회사.가치 company.sys_id
    company.name company.name

    SCIM 회사 자원 스키마(urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company)는 회사 [core_company] 테이블에 매핑됩니다.

    표 7. 회사 자원과 회사 [core_company] 테이블 매핑
    SCIM 속성 이름 회사 필드 이름
    id sys_id
    meta.created입니다. sys_created_on
    meta.lastModified sys_updated_on
    이름 이름

    SCIM CostCenter 자원 스키마(urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter)는 비용 센터 [cmn_cost_center] 테이블에 매핑됩니다.

    표 8. CostCenter 자원과 비용 센터 [cmn_cost_center] 테이블 매핑
    SCIM 속성 이름 비용 센터 필드 이름
    id sys_id
    meta.created입니다. sys_created_on
    meta.lastModified sys_updated_on
    이름 이름

    SCIM 부서 자원 스키마(urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department)는 부서 [cmn_department] 테이블에 매핑됩니다.

    표 9. 부서 자원과 부서 [cmn_department] 테이블 매핑
    SCIM 속성 이름 부서 필드 이름
    id sys_id
    meta.created입니다. sys_created_on
    meta.lastModified sys_updated_on
    이름 이름

    SCIM 위치 자원 스키마(urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location)는 위치 [cmn_location] 테이블에 매핑됩니다.

    표 10. 위치 자원과 위치 [cmn_location] 테이블 매핑
    SCIM 속성 이름 위치 필드 이름
    id sys_id
    meta.created입니다. sys_created_on
    meta.lastModified sys_updated_on
    이름 이름

    SCIM 관련 테이블

    Sys Scim User [sys_scim_user] 및 Sys Scim Group [sys_scim_group]의 두 테이블에는 기존 ServiceNow 테이블에 매핑되지 않는 SCIM 속성이 포함되어 있습니다. 다음은 이러한 테이블의 내용을 정의합니다.

    표 11. Sys Scim 사용자 [sys_scim_user] 테이블
    필드 이름 설명
    작성됨 연결된 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열

    최대 길이: 40
    작성자 기록을 생성한 엔터티의 이름입니다.

    데이터 유형: 문자열

    최대 길이: 40
    외부 ID 이 사용자 기록을 생성한 엔터티가 시스템에서 사용자를 참조하는 데 사용하는 외부 ID입니다.

    데이터 유형: 문자열

    최대 길이: 255
    시스템 ID 인스턴스 내 기록의 고유 식별자입니다 ServiceNow .

    데이터 유형: 문자열

    최대 길이: 32
    업데이트됨 연결된 기록이 마지막으로 업데이트된 날짜 및 시간입니다.

    데이터 유형: 문자열

    최대 길이: 40
    업데이트한 사람 연결된 기록을 마지막으로 업데이트한 엔터티의 이름입니다.

    데이터 유형: 문자열

    최대 길이: 40
    업데이트 기록이 업데이트된 횟수입니다.

    데이터 형식: 정수

    최대 길이: 40
    사용자 이 기록과 연결된 사용자에 대한 참조

    참조: 사용자 [sys_user] 테이블

    최대 길이: 32
    사용자 유형 사용자 기록의 유형입니다. 이 값은 조직과 사용자 관계를 식별하는 데 사용됩니다.
    이 값은 모든 값이 될 수 있지만 일반적인 값에는 다음이 포함될 수 있습니다.
    • 협력업체
    • 직원
    • 외부
    • 인턴
    • 임시 직원
    • 알 수 없음

    데이터 유형: 문자열

    최대 길이: 40
    표 12. Sys Scim 그룹 [sys_scim_group] 테이블
    필드 이름 설명
    작성됨 연결된 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열

    최대 길이: 40
    작성자 기록을 생성한 엔터티의 이름입니다.

    데이터 유형: 문자열

    최대 길이: 40
    외부 ID 이 그룹 기록을 생성한 엔터티가 시스템에서 그룹을 참조하는 데 사용하는 외부 ID입니다.

    데이터 유형: 문자열

    최대 길이: 255
    그룹 이 기록과 연결된 그룹에 대한 참조입니다.

    참조: 그룹 [sys_user_group] 테이블

    최대 길이: 32
    시스템 ID 인스턴스 내 기록의 고유 식별자입니다 ServiceNow .

    데이터 유형: 문자열

    최대 길이: 32
    업데이트됨 연결된 기록이 마지막으로 업데이트된 날짜 및 시간입니다.

    데이터 유형: 문자열

    최대 길이: 40
    업데이트한 사람 연결된 기록을 마지막으로 업데이트한 엔터티의 이름입니다.

    데이터 유형: 문자열

    최대 길이: 40
    업데이트 기록이 업데이트된 횟수입니다.

    데이터 형식: 정수

    최대 길이: 40

    역할 및 접근 제어 목록

    scim_admin 역할은 SCIM 관련 테이블 및 프라이빗 SCIM 엔드포인트에 액세스하는 데 필요하며 사용자 [sys_user] 및 그룹 [sys_user_group] 테이블에 액세스할 수 있도록 합니다.

    SCIM 서비스에는 생성, 삭제, 읽기 및 쓰기를 가능하게 하는 Sys Scim 사용자 [sys_scim_user] 테이블과 Sys Scim 그룹 [sys_scim_group] 테이블에 액세스하기 위한 4개의 ACL이 있습니다. 이러한 ACL은 scim_admin 역할에만 매핑됩니다.

    SCIM - /scim/Groups/{group_id} 삭제

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스의 ServiceNow 그룹 [sys_user_group] 테이블에서 지정된 그룹 기록을 삭제합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Groups/{group_id}

    기본 URL: /api/now/scim/Groups/{group_id}

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    group_id 삭제할 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 16. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 18. 상태 코드
    상태 코드 설명
    204 컨텐츠가 없습니다. 요청이 성공적으로 처리되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    오류 요청을 처리하는 동안 발생했을 수 있는 오류를 설명하는 응답입니다.

    데이터 유형: 객체

    "errors": {
  "details": "String",
  "schemas": "String",
  "scimType": "String",
  "status": "String"
}
    오류.세부 정보 요청 실패 이유에 대한 자세한 오류 메시지입니다.

    데이터 유형: 문자열
    오류.scimType SCIM 오류 상세 정보 키워드입니다.

    데이터 유형: 문자열
    오류.스키마 오류 응답을 처리하는 데 사용되는 SCIM 스키마의 URI입니다.

    데이터 형식: 문자열 배열
    오류.상태 오류 응답의 HTTP 상태 코드입니다.

    데이터 유형: 문자열

    그룹 삭제를 위한 cURL 요청

    이 예시에서는 그룹 [sys_user_group] 테이블에서 그룹 기록을 삭제하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Groups/a0a9e9fb1b7e3010593876a61a4bcbe0" \
--request DELETE \
--header "Accept:application/scim+json" \

    SCIM - GET /scim/groups

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 그룹 [sys_user_group] 테이블에서 하나 이상의 그룹 기록을 반환합니다.

    주:
    일치 항목을 반환하지 않는 쿼리는 0으로 설정된 성공(HTTP 상태 코드 200) totalResults 을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Groups

    기본 URL: /api/now/scim/groups

    지원되는 요청 매개변수

    표 19. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 20. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    카운트 반환할 기록 수입니다. 음수 값은 0으로 해석됩니다.

    데이터 유형: 숫자

    최대값: 500 - 이보다 큰 값은 잘못된 요청 오류를 발생시킵니다.

    기본값: 10
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    필터 반환 결과에 적용할 필터 식입니다. 필드 필터는 <field_name> <operator> <"value">로 표현됩니다. 유효한 연산자 목록은 RFC7644 참조하십시오.
    주:
    이 메서드에서는 NOT 연산자를 지원하지 않습니다.

    예를 들어 이름이 "HR"로 시작하는 모든 그룹을 필터링하려면 displayName SW "HR"을 입력합니다.

    둘 이상의 필드 필터를 지정하려면 AND 피연산자를 사용하여 필터를 연결합니다. 예를 들어 이름이 "HR"로 시작하고 2021년 10월 3일 이전에 마지막으로 수정된 모든 그룹을 필터링하려면 displayName SW "HR" 및 meta.lastModified lt "2021-10-33T00:00:00Z"를 입력합니다. 닷워킹을 사용하여 중첩된 속성을 지정합니다.

    필터에 사용할 수 있는 SCIM 그룹 필드는 다음과 같습니다.
    • displayName
    • externalId: EQ 연산자만 지원합니다.
    • id
    • meta.created입니다.
    • meta.lastModified

    데이터 유형: 문자열

    기본값: 필터링 안 함
    정렬 기준 매개변수와 sortOrder 함께 지정해야 합니다. 반환 결과를 정렬할 필드입니다. 정렬은 대소문자를 구분하지 않습니다.

    매개변수 필터링 sortBy 에 사용할 수 있는 매개변수만 사용할 수 있습니다(허용되지 않는 경우 externalId ).

    null인 값의 경우:
    • 오름차순으로 정렬 - Null 값이 맨 위로 정렬됩니다.
    • sorted by descending - Null 값이 맨 아래로 정렬됩니다.

    데이터 유형: 문자열

    기본값: 정렬 안 함
    sortOrder 매개변수와 sortBy 함께 지정해야 합니다. sortBy 매개 변수가 반환 결과에 적용되는 순서입니다.
    유효한 값은 다음과 같습니다.
    • 오름차순
    • 내림차순

    데이터 유형: 문자열

    기본값: 오름차순
    startIndex 기록 검색을 시작할 테이블에 대한 1부터 시작하는 인덱스입니다. 예를 들어 이 매개 변수를 100 count 으로 설정하고 매개 변수를 20으로 설정하면 엔드포인트는 100에서 119까지의 레코드를 반환합니다.
    주:
    1보다 작게 설정된 값은 1로 해석됩니다.

    데이터 유형: 문자열

    기본값: 1
    표 21. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 22. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 23. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 24. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    itemsPerPage 반환 결과에 반환된 기록 수입니다.

    데이터 유형: 숫자
    자원 그룹 기록 목록입니다.

    데이터 형식: 객체 배열

    "Resources": [
  {
    "company": {Object},
    "displayName": "String",
    "externalId": "String",
    "id": "String",
    "meta": [Array]
  }
]
    자원.회사 그룹의 회사 또는 조직에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "$ref": "String",
  "value": "String"
}
    Resources.company.display 회사의 이름입니다.

    데이터 유형: 문자열
    자원.회사.$ref 회사의 참조 URI입니다.

    형식: <host>/Companies/<company sys_id>(예: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 ).

    데이터 유형: 문자열
    자원.회사.가치 연결된 회사의 Sys_id입니다.

    데이터 유형: 문자열
    Resources.displayName HR 팀과 같이 사용자가 읽을 수 있는 그룹 이름입니다.

    데이터 유형: 문자열
    Resources.externalId 그룹을 프로비저닝하는 엔터티에서 그룹에 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    Resources.id 그룹의 Sys_id입니다.

    데이터 유형: 문자열
    리소스.메타 그룹과 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    Resources.meta.created 그룹 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.lastModified 그룹 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.location 검색 중인 그룹의 URI입니다.

    데이터 유형: 문자열
    Resources.meta.resourceType SCIM 그룹의 자원 유형입니다.

    데이터 유형: 문자열
    Resources.members 그룹과 연결된 사용자 및 그룹의 목록입니다.
    데이터 형식: 객체 배열
    "members": [
  {
    "display": "String",
    "value": "String",
    "$ref": "String"
  }
]
    Resources.members.display 연결된 그룹 구성원의 이름입니다.

    데이터 유형: 문자열
    Resources.members.value 연결된 사용자 또는 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    자원.구성원.$ref 연결된 그룹 구성원의 URI입니다.

    데이터 유형: 문자열
    Resources.schemas
    요청을 처리하는 데 사용되는 SCIM 그룹 스키마의 URI 목록입니다.
    지원되는 그룹 스키마:
    • urn:ietf:params:scim:schemas:core:2.0:Group - Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema 문서에 지정된 핵심 스키마 (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2)
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 확장 스키마입니다. 이 스키마에는 기본 ServiceNow 시스템의 그룹 [sys_user_group] 테이블에 있지만 핵심 스키마의 일부가 아닌 속성이 포함되어 있습니다.
    • urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" - 사용자 지정 확장 스키마입니다. 이 스키마는 sys_scim_schema_extension 테이블에 있는 "Group" resourceType의 일부입니다. 스키마가 활성 상태가 아니면 스키마 URN이 응답에 반환되지 않습니다.

    데이터 형식: 문자열 배열
    스키마 요청을 처리하는 데 사용되는 SCIM 목록 응답 스키마의 URI 목록입니다.

    데이터 유형: 배열
    startIndex 엔드포인트에서 기록 검색을 시작한 그룹 [sys_user_group] 테이블에 대한 1부터 시작하는 인덱스입니다.

    데이터 유형: 숫자
    totalResults 요청과 일치하는 총 기록 수입니다.

    데이터 유형: 숫자

    여러 그룹에 대한 cURL 요청

    이 예제에서는 매개 변수를 사용하여 여러 그룹(이 경우 4개)을 count 요청하는 방법을 보여 줍니다.

    curl "https://instance-sevicenow.com/api/now/scim/Groups?count=4" \
--request GET \
--header "Accept:application/scim+json" \

    응답:

    {"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":44,
  "Resources":[
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"019ad92ec7230010393d265c95c260dd",
      "meta":{
        "resourceType":"Group",
        "created":"2020-03-17T11:39:14Z",
        "lastModified":"2020-03-17T11:39:14Z",
        "location":"https://instance-sevicenow.com/api/now/scim/Groups/019ad92ec7230010393d265c95c260dd"
      },
      "displayName":"Analytics Settings Managers"
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0a52d3dcd7011200f2d224837e6103f2",
      "meta":{
        "resourceType":"Group",
        "created":"2021-09-29T16:42:02Z",
        "lastModified":"2021-09-29T16:42:02Z",
        "location":"https://instance-sevicenow.com/api/now/scim/Groups/0a52d3dcd7011200f2d224837e6103f2"
      },
      "displayName":"Application Development",
      "members":[
        {
          "value":"dc6053dcd7011200f2d224837e6103e0",
          "display":"John Doe",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/dc6053dcd7011200f2d224837e6103e0"
        },
        {
          "value":"443193dcd7011200f2d224837e61037d",
          "display":"Abel Tutor",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/443193dcd7011200f2d224837e61037d"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
        "company": {
          "value": "81fd65ecac1d55eb42a426568fc87a63",
          "name": "ACME Japan",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
        }
      }
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0c4e7b573b331300ad3cc9bb34efc461",
      "meta":{
        "resourceType":"Group",
        "created":"2021-09-29T05:11:33Z",
        "lastModified":"2021-09-29T05:11:33Z",
        "location":"instance-sevicenow.com/api/now/scim/Groups/0c4e7b573b331300ad3cc9bb34efc461"
      },
      "displayName":"Problem Analyzers",
      "members":[
        {
          "value":"d3dbbf173b331300ad3cc9bb34efc466",
          "display":"Problem Manager",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/babb4639b76233004fbc2089ee11a97f"
        },
        {
          "value":"38cb3f173b331300ad3cc9bb34efc4d6",
          "display":"Problem Coordinator B",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/cbcc4639b76233004fbc2089ee111047"
        },
        {
          "value":"26fbff173b331300ad3cc9bb34efc4bd",
          "display":"Problem Administrator",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/45324639b76232189fbc2089ee11bc34"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
        "company": {
          "value": "913465ecac1d569b42a426568fc88af3",
          "name": "ACME London",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/913465ecac1d569b42a426568fc88af3"
        }
      }
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
        "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group"
      ],
      "id":"0c5e2a7ce4001410f877ce457cda6b98",
      "meta":{
        "resourceType":"Group",
        "created":"2020-04-06T03:47:08Z",
        "lastModified":"2020-07-29T04:02:26Z",
        "location":"instance-sevicenow.com/api/now/scim/Groups/0c5e2a7ce4001410f877ce457cda6b98"
      },
      "displayName":"Business Application Registration Approval Group"
    }
  ],
  "startIndex":1,
  "itemsPerPage":4
}

    excludedAttributes를 사용하는 여러 그룹에 대한 cURL 요청

    이 예제에서는 매개 변수를 사용하고 count meta 및 members 필드를 제외하고 여러 그룹(이 경우 4개)을 요청하는 방법을 보여 줍니다.

    curl "https://instance-sevicenow.com/api/now/scim/Groups?excludedAttributes=meta%2C%20members&count=4" \
--request GET \
--header "Accept:application/scim+json" \

    응답:

    {"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":44,
  "Resources":[
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"019ad92ec7230010393d265c95c260dd",
      "displayName":"Analytics Settings Managers",
      "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
        "company": {
          "value": "913465ecac1d569b42a426568fc88af3",
          "name": "ACME London",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/913465ecac1d569b42a426568fc88af3"
        }
      }
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0a52d3dcd7011200f2d224837e6103f2",
      "displayName":"Application Development"
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0c4e7b573b331300ad3cc9bb34efc461",
      "displayName":"Problem Analyzers"
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0c5e2a7ce4001410f877ce457cda6b98",
      "displayName":"Business Application Registration Approval Group",
      "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
        "company": {
          "value": "81fd65ecac1d55eb42a426568fc87a63",
          "name": "ACME Japan",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
        }
      }
    }
  ],
  "startIndex":1,
  "itemsPerPage":4
}

    SCIM - GET /scim/Groups/{group_id}

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스 내 ServiceNow 그룹 [sys_user_group] 테이블에서 지정된 그룹 기록을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Groups/{group_id}

    기본 URL: /api/now/scim/Groups/{group_id}

    지원되는 요청 매개변수

    표 25. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    group_id 반환할 그룹 기록의 Sys_id입니다.
    표 26. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 27. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 28. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 29. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 30. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    회사 그룹의 회사 또는 조직에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "$ref": "String",
  "value": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    형식: <host>/Companies/<company sys_id>(예: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 ).

    데이터 유형: 문자열
    회사.가치 연결된 회사의 Sys_id입니다.

    데이터 유형: 문자열
    displayName HR 팀과 같이 사용자가 읽을 수 있는 그룹 이름입니다.

    데이터 유형: 문자열
    externalId 그룹을 프로비저닝하는 엔터티에서 그룹에 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    id 그룹의 Sys_id입니다.

    데이터 유형: 문자열
    메타 그룹과 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    meta.created입니다. 그룹 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 그룹 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 검색 중인 그룹의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 그룹의 자원 유형입니다.

    데이터 유형: 문자열
    구성원 그룹과 연결된 사용자 및 그룹의 목록입니다.
    데이터 형식: 객체 배열
    "members": [
  {
    "display": "String",
    "value": "String",
    "$ref": "String"
  }
]
    구성원.표시 연결된 그룹 구성원의 이름입니다.

    데이터 유형: 문자열
    구성원.값 연결된 사용자 또는 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    회원.$ref 연결된 그룹 구성원의 URI입니다.

    데이터 유형: 문자열
    스키마
    요청을 처리하는 데 사용되는 SCIM 그룹 스키마의 URI 목록입니다.
    지원되는 그룹 스키마:
    • urn:ietf:params:scim:schemas:core:2.0:Group - Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema 문서에 지정된 핵심 스키마 (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2)
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 확장 스키마입니다. 이 스키마에는 기본 ServiceNow 시스템의 그룹 [sys_user_group] 테이블에 있지만 핵심 스키마의 일부가 아닌 속성이 포함되어 있습니다.
    • urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" - 사용자 지정 확장 스키마입니다. 이 스키마는 sys_scim_schema_extension 테이블에 있는 "Group" resourceType의 일부입니다. 스키마가 활성 상태가 아니면 스키마 URN이 응답에 반환되지 않습니다.

    데이터 형식: 문자열 배열

    특정 그룹에 대한 cURL 요청

    이 예시에서는 특정 그룹 기록을 검색하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" \
--request GET \
--header "Accept:application/scim+json" \

    응답:

    {"schemas":
  [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group"
  ],
  "id":"e0140d671bbe3010593876a61a4bcb11",
  "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83",
  "meta":{
    "resourceType":"Group",
    "created":"2021-09-30T18:20:43Z",
    "lastModified":"2021-09-30T18:20:43Z",
    "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"},
    "displayName":"HR Group",
    "members":[
      {
        "value":"62826bf03710200044e0bfc8bcbe5df1",
        "display":"Abel Tuter",
        "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
      }
    ], 
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
      "company": {
        "value": "81fd65ecac1d55eb42a426568fc87a63",
        "name": "ACME Japan",
        "$ref": "http://111.111.1.11:8080/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
      }
    }
  }
}

    SCIM - 패치 /scim/Groups/{group_id}

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스의 ServiceNow 그룹 [sys_user_group] 테이블에 있는 그룹 기록에서 지정된 필드를 추가, 업데이트 및 삭제할 수 있습니다.

    자세한 내용은 RFC 7644의 PATCH로 수정 섹션을 참조하십시오.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Groups/{group_id}

    기본 URL: /api/now/scim/Groups/{group_id}

    지원되는 요청 매개변수

    표 31. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    group_id 업데이트할 그룹 기록의 Sys_id입니다.
    표 32. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 33. 요청 본문 매개변수(JSON)
    이름 설명
    운영 필수 지정된 그룹 기록을 패치할 작업 객체의 목록입니다.

    데이터 형식: 객체 배열

    "Operations": [
  {
    "op": "String",
    "path": "String",
    "value": Any
  }
]
    운영.op 필수 수행할 작업입니다.
    유효한 값은 다음과 같습니다.
    • add: 지정된 필드와 값을 그룹 기록에 추가합니다.
    • remove: 지정된 필드에서 값을 제거합니다. 데이터 형식 "null"로 바뀝니다.
    • replace: 지정된 필드의 값을 바꿉니다.

    데이터 유형: 문자열
    운영.경로 제거 작업에 필요하며 다른 작업에는 선택 사항입니다. 수정할 필드의 이름/경로입니다.
    매개변수는 path 다음 형식 중 하나를 가질 수 있습니다.
    • 직접 필드(예: displayName)
    • 복합 배열의 경우 필터가 있는 특정 요소에 대한 포인터입니다(예: emails[type eq "work"]).
    {
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "displayName",
      "value": "HR Group"
    },
    {
      "op": "replace", 
      "path": "members[value eq \"sysid1\"]", 
      "value": {
        "value": "sysid2"
      }
    } 
  ]
}

    데이터 유형: 문자열

    기본값: 필드를 자원으로 간주합니다.
    운영.가치 매개변수에 지정된 필드의 값입니다 Operations.path . 이 매개변수의 형식은 연결된 필드의 데이터 유형에 따라 다릅니다.

    예를 들어 제목과 같은 단순 문자열을 업데이트하는 경우 필드는 value 문자열로 표현됩니다.

     "Operations": [
  {
    "op": "add",
    "path": "displayName",
    "value": "HR Group"
  }
]
    다음과 같은 매개 변수 없이 path 간단한 문자열 값을 선언할 수도 있습니다. 
     "Operations": [
  {
    "op": "add",
    "value": {
      "displayName": "HR Group"
    }
  }
]
    다음은 그룹에 구성원을 추가하는 방법을 보여 줍니다.
    {
  "op": "add",
  "value": {
    "members": {
      "value": "62826bf03710200044e0bfc8bcbe5df1",
    }
  }
}

    업데이트 중인 필드가 base-schema에 없는 경우 연결된 스키마의 URN을 지정하는 개체에 이름-값 쌍을 묶어야 합니다.

    "value": {
  "<schema_urn>": {
    "<field_name>": "<new_value>"
  },
}

    예:

    "value": {
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
    "groupNumber": "13454"
  },
}
    데이터 유형: 모두
    운영.값.유형 업데이트할 필드의 이름입니다.

    데이터 유형: 문자열
    운영.값.값 필드를 업데이트하는 데 사용할 값입니다.

    데이터 유형: 문자열
    스키마 필수 패치 작업의 SCIM 스키마 URI: "urn:ietf:params:scim:api:messages:2.0:PatchOp"

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 34. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 35. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 36. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    204

    성공한. 콘텐츠 없음(SCIM 그룹 패치 API에만 적용 가능) - 이 204 상태는 SCIM UI 속성의 상태, 콘텐츠가 없는 그룹 패치 API 응답 활성화에 따라 달라지며 RFC에 따라 전달된 속성 매개변수의 적용을 받습니다. https://www.rfc-editor.org/rfc/rfc7644#page-35.

    기본 속성 값: false

    클라이언트가 응답 리소스를 사용할 계획이 없는 경우 콘텐츠가 없는 그룹 패치 API 응답 사용 속성을 사용하여 추가 응답 실행 성능 향상을 얻을 수 있습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 잘못된 값 확인:
      • 요청 본문의 변형이 있습니다.
      • 필수 필드가 제공되지 않았거나 비어 있습니다.
      • 잘못된 사용자 또는 그룹 sys_id가 제공되었습니다.
    • 읽기 전용 또는 변경할 수 없는 필드를 수정하려고 하는지 확인합니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 모두 요청에 전달되지 않았거나 요청이 최대 구성원 수를 초과하지 않는지 확인합니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    409 그룹이 이미 있습니다. 매개변수는 displayName 고유해야 합니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    회사 그룹의 회사 또는 조직에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "$ref": "String",
  "value": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    형식: <host>/Companies/<company sys_id>(예: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 ).

    데이터 유형: 문자열
    회사.가치 연결된 회사의 Sys_id입니다.

    데이터 유형: 문자열
    displayName HR 팀과 같이 사용자가 읽을 수 있는 그룹 이름입니다.

    데이터 유형: 문자열
    externalId 그룹을 프로비저닝하는 엔터티에서 그룹에 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    오류 요청을 처리하는 동안 발생했을 수 있는 오류를 설명하는 응답입니다.

    데이터 유형: 객체

    "errors": {
  "details": "String",
  "schemas": "String",
  "scimType": "String",
  "status": "String"
}
    오류.세부 정보 요청 실패 이유에 대한 자세한 오류 메시지입니다.

    데이터 유형: 문자열
    오류.scimType SCIM 오류 상세 정보 키워드입니다.

    데이터 유형: 문자열
    오류.스키마 오류 응답을 처리하는 데 사용되는 SCIM 스키마의 URI입니다.

    데이터 형식: 문자열 배열
    오류.상태 오류 응답의 HTTP 상태 코드입니다.

    데이터 유형: 문자열
    displayName HR 팀과 같이 사용자가 읽을 수 있는 그룹 이름입니다.

    데이터 유형: 문자열
    externalId 그룹을 프로비저닝하는 엔터티에서 그룹에 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    id 그룹의 Sys_id입니다.

    데이터 유형: 문자열
    구성원 그룹과 연결된 사용자 및 그룹의 목록입니다.
    데이터 형식: 객체 배열
    "members": [
  {
    "display": "String",
    "value": "String",
    "$ref": "String"
  }
]
    구성원.표시 연결된 그룹 구성원의 이름입니다.

    데이터 유형: 문자열
    구성원.값 연결된 사용자 또는 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    회원.$ref 연결된 그룹 구성원의 URI입니다.

    데이터 유형: 문자열
    메타 그룹과 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    meta.created입니다. 그룹 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 그룹 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 검색 중인 그룹의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 그룹의 자원 유형입니다.

    데이터 유형: 문자열
    스키마
    요청을 처리하는 데 사용되는 SCIM 그룹 스키마의 URI 목록입니다.
    지원되는 그룹 스키마:
    • urn:ietf:params:scim:schemas:core:2.0:Group - Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema 문서에 지정된 핵심 스키마 (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2)
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 확장 스키마입니다. 이 스키마에는 기본 ServiceNow 시스템의 그룹 [sys_user_group] 테이블에 있지만 핵심 스키마의 일부가 아닌 속성이 포함되어 있습니다.
    • urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" - 사용자 지정 확장 스키마입니다. 이 스키마는 sys_scim_schema_extension 테이블에 있는 "Group" resourceType의 일부입니다. 스키마가 활성 상태가 아니면 스키마 URN이 응답에 반환되지 않습니다.

    데이터 형식: 문자열 배열

    cURL 요청

    이 예시에서는 그룹 레코드에 외부 ID를 추가하고 연결된 구성원(사용자)의 현재 목록을 바꾸는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Groups/a92b84f96b073010638c83eece44af4e" \
--request PATCH \
--header "Accept:application/scim+json" \
--header "Content-Type:application/scim+json" \
--data "{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "externalId",
      "value": "278fdc2e-a6aa-4140-bd23-9ba4987a2938"
    },
    {
      "op": "replace",
      "path": "members",
      "value": [
        {
          "value": "62826bf03710200044e0bfc8bcbe5df1"
        },
        {
          "value": "a8f98bb0eb32010045e1a5115206fe3a"
        }
      ]
    }
  ]
}"

    응답:

    {
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group'
  ],
  "id": "a92b84f96b073010638c83eece44af4e",
  "externalId": "278fdc2e-a6aa-4140-bd23-9ba4987a2938",
  "meta": {
    "resourceType": "Group",
    "created": "2021-10-07T13:58:22Z",
    "lastModified": "2021-10-07T15:48:44Z",
    "location":
      "https://instance-sevicenow/api/now/scim/Groups/a92b84f96b073010638c83eece44af4e"
  },
  "displayName": "HR Team",
  "members": [
    {
      "value": "62826bf03710200044e0bfc8bcbe5df1",
      "display": "Abel Tuter",
      "$ref":
        "https://instance-sevicenow/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
    },
    {
      "value": "a8f98bb0eb32010045e1a5115206fe3a",
      "display": "Abraham Lincoln",
      "$ref":
        "https://instance-sevicenow/api/now/scim/Users/a8f98bb0eb32010045e1a5115206fe3a"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
    "company": {
      "value": "81fd65ecac1d55eb42a426568fc87a63",
      "name": "ACME Japan",
      "$ref": "http://instance-sevicenow/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
    }
  }
}

    SCIM - POST /scim/그룹

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스의 ServiceNow 그룹 [sys_user_group] 테이블에 그룹 기록을 생성합니다.

    그룹의 표시 이름, 이 그룹을 외부 시스템과 상호 연결하는 데 사용되는 외부 ID를 정의하고 그룹에 구성원(사용자/그룹)을 추가할 수 있습니다.

    주:
    RFC7643 사양에 명시된 검색 및 대량 수정 기능은 이 엔드포인트에서 지원되지 않습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Groups

    기본 URL: /api/now/scim/groups

    지원되는 요청 매개변수

    표 37. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 38. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 39. 요청 본문 매개변수(JSON)
    이름 설명
    회사 그룹의 회사 또는 조직에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "$ref": "String",
  "value": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    형식: <host>/Companies/<company sys_id>(예: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 ).

    데이터 유형: 문자열
    회사.가치 연결된 회사의 Sys_id입니다.

    데이터 유형: 문자열
    displayName 필수 HR 팀과 같이 사용자가 읽을 수 있는 그룹 이름입니다.

    데이터 유형: 문자열
    externalId 그룹을 프로비저닝하는 엔터티에서 그룹에 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    구성원 그룹과 연결할 사용자 또는 기타 그룹의 목록입니다.

    데이터 형식: 객체 배열

    "members:" [
  {
    "value": "String"
  }
]

    최대 크기: 100 - 시스템 속성 com.snc.interation.scim2.max.member.count를 업데이트하여 이 최대 크기를 수정할 수 있습니다.
    구성원.값 연결된 사용자 또는 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    스키마 필수
    요청을 처리하는 데 사용되는 SCIM 그룹 스키마의 URI 목록입니다.
    지원되는 그룹 스키마:
    • urn:ietf:params:scim:schemas:core:2.0:Group - Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema 문서에 지정된 핵심 스키마 (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2)
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 확장 스키마입니다. 이 스키마에는 기본 ServiceNow 시스템의 그룹 [sys_user_group] 테이블에 있지만 핵심 스키마의 일부가 아닌 속성이 포함되어 있습니다.
    • urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" - 사용자 지정 확장 스키마입니다. 이 스키마는 sys_scim_schema_extension 테이블에 있는 "Group" resourceType의 일부입니다. 스키마가 활성 상태가 아니면 스키마 URN이 응답에 반환되지 않습니다.

    데이터 형식: 문자열 배열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 40. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 41. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 42. 상태 코드
    상태 코드 설명
    201 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 잘못된 값 확인:
      • 요청 본문의 변형이 있습니다.
      • 필수 필드가 제공되지 않았거나 비어 있습니다.
      • 잘못된 사용자 또는 그룹 sys_id가 제공되었습니다.
    • 읽기 전용 또는 변경할 수 없는 필드를 수정하려고 하는지 확인합니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 모두 요청에 전달되지 않았거나 요청이 최대 구성원 수를 초과하지 않는지 확인합니다.
    409 그룹이 이미 있습니다. 매개변수는 displayName 고유해야 합니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    회사 그룹의 회사 또는 조직에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "$ref": "String",
  "value": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    형식: <host>/Companies/<company sys_id>(예: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 ).

    데이터 유형: 문자열
    회사.가치 연결된 회사의 Sys_id입니다.

    데이터 유형: 문자열
    displayName HR 팀과 같이 사용자가 읽을 수 있는 그룹 이름입니다.

    데이터 유형: 문자열
    externalId 그룹을 프로비저닝하는 엔터티에서 그룹에 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    id 그룹의 Sys_id입니다.

    데이터 유형: 문자열
    메타 그룹과 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    meta.created입니다. 그룹 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 그룹 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 검색 중인 그룹의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 그룹의 자원 유형입니다.

    데이터 유형: 문자열
    구성원 그룹과 연결된 사용자 및 그룹의 목록입니다.
    데이터 형식: 객체 배열
    "members": [
  {
    "display": "String",
    "value": "String",
    "$ref": "String"
  }
]
    구성원.표시 연결된 그룹 구성원의 이름입니다.

    데이터 유형: 문자열
    구성원.값 연결된 사용자 또는 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    회원.$ref 연결된 그룹 구성원의 URI입니다.

    데이터 유형: 문자열
    스키마
    요청을 처리하는 데 사용되는 SCIM 그룹 스키마의 URI 목록입니다.
    지원되는 그룹 스키마:
    • urn:ietf:params:scim:schemas:core:2.0:Group - Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema 문서에 지정된 핵심 스키마 (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2)
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 확장 스키마입니다. 이 스키마에는 기본 ServiceNow 시스템의 그룹 [sys_user_group] 테이블에 있지만 핵심 스키마의 일부가 아닌 속성이 포함되어 있습니다.
    • urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" - 사용자 지정 확장 스키마입니다. 이 스키마는 sys_scim_schema_extension 테이블에 있는 "Group" resourceType의 일부입니다. 스키마가 활성 상태가 아니면 스키마 URN이 응답에 반환되지 않습니다.

    데이터 형식: 문자열 배열

    cURL 요청 새 그룹을 게시하고 구성원을 추가합니다.

    이 예제에서는 group51을 만들고 사용자 Abel Tutor를 멤버로 추가합니다.

    curl "https://instance-servicenow.com/api/now/scim/Groups" \
--request POST \
--header "Accept:application/scim+json" \
--header "Content-Type:application/scim+json" \
--data "{
  \"schemas\": ["urn:ietf:params:scim:schemas:core:2.0:Group",
    “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”, 
    “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”],
  \"displayName\": \"HR Team\",
  \"externalId\": \"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83\",
  \"members\": [
    {
      \"value\": \"62826bf03710200044e0bfc8bcbe5df1\",
      \"$ref\": \"Users/62826bf03710200044e0bfc8bcbe5df1\"
    }
  ]
}"

    응답:

    {"schemas":
  [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group'
  ],
  "id":"e0140d671bbe3010593876a61a4bcb11",
  "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83",
  "meta":{
    "resourceType":"Group",
    "created":"2021-09-30T18:20:43Z",
    "lastModified":"2021-09-30T18:20:43Z",
    "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"},
    "displayName":"HR Team",
    "members":[
      {
        "value":"62826bf03710200044e0bfc8bcbe5df1",
        "display":"Abel Tuter",
        "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
      }
    ],
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
      "company": {
        "value": "81fd65ecac1d55eb42a426568fc87a63",
        "name": "ACME Japan",
        "$ref": http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63
      }
    }
  }
}

    SCIM - PUT /scim/Groups/{group_id}

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스의 ServiceNow 그룹 [sys_user_group] 테이블에서 지정된 그룹 기록을 업데이트합니다.

    요청에서 생략된 필드는 업데이트되지 않습니다. 단일 값 필드에 대해 값을 null로 설정하고 배열 형식 필드에 대해 빈 배열로 설정하여 필드를 명시적으로 지울 수 있습니다 members.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Groups/{group_id}

    기본 URL: /api/now/scim/Groups/{group_id}

    지원되는 요청 매개변수

    표 43. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    group_id 업데이트할 그룹 기록의 Sys_id입니다.
    표 44. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 45. 요청 본문 매개변수(JSON)
    이름 설명
    회사 그룹의 회사 또는 조직에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "$ref": "String",
  "value": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    형식: <host>/Companies/<company sys_id>(예: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 ).

    데이터 유형: 문자열
    회사.가치 연결된 회사의 Sys_id입니다.

    데이터 유형: 문자열
    displayName HR 팀과 같이 사용자가 읽을 수 있는 그룹 이름입니다.

    데이터 유형: 문자열
    externalId 그룹을 프로비저닝하는 엔터티에서 그룹에 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    구성원 현재 구성원 목록을 대체할 사용자 목록입니다.

    데이터 형식: 객체 배열

    "members:" [
  {
    "value": "String"
  }
]

    최대 크기: 100 - 시스템 속성 com.snc.interation.scim2.max.member.count를 업데이트하여 이 최대 크기를 수정할 수 있습니다.
    구성원.값 연결된 사용자 또는 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    스키마 필수
    요청을 처리하는 데 사용되는 SCIM 그룹 스키마의 URI 목록입니다.
    지원되는 그룹 스키마:
    • urn:ietf:params:scim:schemas:core:2.0:Group - Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema 문서에 지정된 핵심 스키마 (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2)
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 확장 스키마입니다. 이 스키마에는 기본 ServiceNow 시스템의 그룹 [sys_user_group] 테이블에 있지만 핵심 스키마의 일부가 아닌 속성이 포함되어 있습니다.
    • urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" - 사용자 지정 확장 스키마입니다. 이 스키마는 sys_scim_schema_extension 테이블에 있는 "Group" resourceType의 일부입니다. 스키마가 활성 상태가 아니면 스키마 URN이 응답에 반환되지 않습니다.

    데이터 형식: 문자열 배열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 46. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 47. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 48. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 잘못된 값 확인:
      • 요청 본문의 변형이 있습니다.
      • 필수 필드가 제공되지 않았거나 비어 있습니다.
      • 잘못된 사용자 또는 그룹 sys_id가 제공되었습니다.
    • 읽기 전용 또는 변경할 수 없는 필드를 수정하려고 하는지 확인합니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 모두 요청에 전달되지 않았거나 요청이 최대 구성원 수를 초과하지 않는지 확인합니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    409 그룹이 이미 있습니다. 매개변수는 displayName 고유해야 합니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    회사 그룹의 회사 또는 조직에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "$ref": "String",
  "value": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    형식: <host>/Companies/<company sys_id>(예: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 ).

    데이터 유형: 문자열
    회사.가치 연결된 회사의 Sys_id입니다.

    데이터 유형: 문자열
    displayName HR 팀과 같이 사용자가 읽을 수 있는 그룹 이름입니다.

    데이터 유형: 문자열
    오류 요청을 처리하는 동안 발생했을 수 있는 오류를 설명하는 응답입니다.

    데이터 유형: 객체

    "errors": {
  "details": "String",
  "schemas": "String",
  "scimType": "String",
  "status": "String"
}
    오류.세부 정보 요청 실패 이유에 대한 자세한 오류 메시지입니다.

    데이터 유형: 문자열
    오류.scimType SCIM 오류 상세 정보 키워드입니다.

    데이터 유형: 문자열
    오류.스키마 오류 응답을 처리하는 데 사용되는 SCIM 스키마의 URI입니다.

    데이터 형식: 문자열 배열
    오류.상태 오류 응답의 HTTP 상태 코드입니다.

    데이터 유형: 문자열
    externalId 그룹을 프로비저닝하는 엔터티에서 그룹에 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    id 그룹의 Sys_id입니다.

    데이터 유형: 문자열
    구성원 그룹과 연결된 사용자 및 그룹의 목록입니다.
    데이터 형식: 객체 배열
    "members": [
  {
    "display": "String",
    "value": "String",
    "$ref": "String"
  }
]
    구성원.표시 연결된 그룹 구성원의 이름입니다.

    데이터 유형: 문자열
    구성원.값 연결된 사용자 또는 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    회원.$ref 연결된 그룹 구성원의 URI입니다.

    데이터 유형: 문자열
    메타 그룹과 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    meta.created입니다. 그룹 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 그룹 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 검색 중인 그룹의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 그룹의 자원 유형입니다.

    데이터 유형: 문자열
    스키마
    요청을 처리하는 데 사용되는 SCIM 그룹 스키마의 URI 목록입니다.
    지원되는 그룹 스키마:
    • urn:ietf:params:scim:schemas:core:2.0:Group - Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema 문서에 지정된 핵심 스키마 (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2)
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 확장 스키마입니다. 이 스키마에는 기본 ServiceNow 시스템의 그룹 [sys_user_group] 테이블에 있지만 핵심 스키마의 일부가 아닌 속성이 포함되어 있습니다.
    • urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" - 사용자 지정 확장 스키마입니다. 이 스키마는 sys_scim_schema_extension 테이블에 있는 "Group" resourceType의 일부입니다. 스키마가 활성 상태가 아니면 스키마 URN이 응답에 반환되지 않습니다.

    데이터 형식: 문자열 배열

    PUT을 사용하여 그룹 구성원을 업데이트하는 cURL 요청

    다음 예에서는 그룹과 연결된 구성원을 Abel Tutor 대신 Abraham Lincoln으로 변경하고 그룹 이름을 HR 팀으로 변경합니다.

    curl "https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" \
--request PUT \
--header "Accept:application/scim+json" \
--header "Content-Type:application/scim+json" \
--data "{
  \"schemas\": ["urn:ietf:params:scim:schemas:core:2.0:Group",
    “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”, 
    “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”],
  \"displayName\": \"HR Team\",
  \"externalId\": \"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83\",
  \"members\": [
    {
      \"value\": \"a8f98bb0eb32010045e1a5115206fe3a\",
      \"$ref\": \"Users\"
    }
  ]
}"

    응답:

    {"schemas":
  [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group'
  ],
  "id":"e0140d671bbe3010593876a61a4bcb11",
  "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83",
  "meta":{
    "resourceType":"Group",
    "created":"2021-09-30T18:20:43Z",
    "lastModified":"2021-09-30T21:19:40Z",
    "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"
  },
  "displayName":"HR Team",
  "members":[
    {
      "value":"a8f98bb0eb32010045e1a5115206fe3a",
      "display":"Abraham Lincoln",
      "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
    "company": {
      "value": "81fd65ecac1d55eb42a426568fc87a63",
      "name": "ACME Japan",
      "$ref": "http://192.168.1.25:8080/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
    }
  }
}

    SCIM - /scim/Users/{user_id} 삭제

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스의 ServiceNow 사용자 [sys_user] 테이블에서 지정된 사용자 기록을 삭제합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Users/{user_id}

    기본 URL: /api/now/scim/Users/{user_id}

    지원되는 요청 매개변수

    표 49. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    user_id 삭제할 사용자 기록의 Sys_id입니다.
    표 50. 쿼리 매개변수
    이름 설명
    없음
    표 51. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 52. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 53. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 54. 상태 코드
    상태 코드 설명
    204 컨텐츠가 없습니다. 요청이 성공적으로 처리되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    오류 요청을 처리하는 동안 발생했을 수 있는 오류를 설명하는 응답입니다.

    데이터 유형: 객체

    "errors": {
  "details": "String",
  "schemas": "String",
  "scimType": "String",
  "status": "String"
}
    오류.세부 정보 요청 실패 이유에 대한 자세한 오류 메시지입니다.

    데이터 유형: 문자열
    오류.scimType SCIM 오류 상세 정보 키워드입니다.

    데이터 유형: 문자열
    오류.스키마 오류 응답을 처리하는 데 사용되는 SCIM 스키마의 URI입니다.

    데이터 형식: 문자열 배열
    오류.상태 오류 응답의 HTTP 상태 코드입니다.

    데이터 유형: 문자열

    cURL 요청

    이 예에서는 사용자 [sys_user] 테이블에서 사용자 기록을 삭제하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Users/b7c5015f778330102e8cc5179e5a9992" \
--request DELETE \
--header "Accept:application/scim+json"  \

    SCIM - GET /scim/Users

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 사용자 [sys_user] 테이블에서 하나 이상의 사용자 기록을 반환합니다.

    주:
    일치 항목을 반환하지 않는 쿼리는 0으로 설정된 성공(HTTP 상태 코드 200) totalResults 을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Users

    기본 URL: /api/now/scim/Users

    지원되는 요청 매개변수

    표 55. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 56. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    카운트 반환할 기록 수입니다. 음수 값은 0으로 해석됩니다.

    데이터 유형: 숫자

    최대값: 500 - 이보다 큰 값은 잘못된 요청 오류를 발생시킵니다.

    기본값: 10
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    필터 반환 결과에 적용할 필터 식입니다. 필드 필터는 <field_name> <operator> <"value">로 표현됩니다. 유효한 연산자 목록은 RFC7644 참조하십시오.
    주:
    NOT 연산자는 지원되지 않습니다.

    예를 들어 이름이 "Jo"로 시작하는 모든 사용자를 필터링하려면 userName SW "jo" (대/소문자 구분 안 함)를 입력합니다.

    둘 이상의 필드 필터를 지정하려면 AND 피연산자를 사용하여 필터를 연결합니다. 예를 들어 이름이 "Jo"로 시작하고 성에 "smi"가 포함된 모든 사용자를 필터링하려면 userName SW "john" AND name.familyName CO "smi"를 입력합니다. 닷워킹을 사용하여 중첩된 속성을 지정합니다.

    다음 SCIM 사용자 필드만 필터에 사용할 수 있으며, 일부는 앞서 언급한 대로 고정 형식만 지원합니다.
    • active
    • addresses - 다음과 같은 고정 형식만 해당:
      • [eq "home" 및 streetAddress eq "xxxx"를 입력합니다.]
      • [유형 eq "home" 및 구/군/시 eq "xxxx"]
      • [eq "home" 및 region eq "xxxx"를 입력합니다.]
      • [eq "home" 및 postalCode eq "xxxx"를 입력하십시오.]
      • [eq "home" 및 country eq "xxxx"를 입력합니다.]
    • displayName
    • 이메일 - 고정 형식만(예: [type eq "work" and value eq "emailValue"])
    • externalId - EQ 연산자만 지원됩니다.
    • id
    • meta.created입니다.
    • meta.lastModified
    • name.familyName
    • name.givenName (이름.givenName)
    • 이름.중간 이름
    • preferredLanguage
    • phoneNumbers - 다음과 같은 고정 형식만:
      • [유형 eq "work" 및 값 eq "xxxx"]
      • [유형 eq "mobile" 및 값 eq "xxxx"]
      • [유형 eq "home" 및 값 eq "xxxx"]
    • 시간대
    • 직위
    • userName
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:employeeNumber
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:gender
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.name
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.value
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.displayName
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.value
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.name
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.value
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.name
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.value
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.name
    • urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.value

    데이터 유형: 문자열

    기본값: 필터링 안 함
    정렬 기준 매개변수와 sortOrder 함께 지정해야 합니다. 반환 결과를 정렬할 필드입니다. 정렬은 대소문자를 구분하지 않습니다.

    매개 변수를 필터링 sortBy 하는 데 사용할 수 있는 매개 변수만 사용할 수 있으며 허용되지 않는 는 예외 externalId입니다.

    또한 다음과 같은 닷워킹 매개변수만 지원됩니다.
    • addressess - 다음 값만 허용됩니다.
      • addresses.streetAddress - 집 도로명 주소에 대한 지도.
      • addresses.home.streetAddress
      • addresses.locality - 홈 지역에 대한 지도.
      • addresses.home.locality
      • addresses.region - 홈 지역에 매핑합니다.
      • addresses.home.region
      • addresses.postalCode - 집 우편 번호에 매핑합니다.
      • addresses.home.postalCode
      • addresses.country - 본국에 대한 지도.
      • addresses.home.country
    • emails - 다음 값만 허용됩니다.
      • emails.value - 이메일 유형 작업에 매핑합니다.
      • emails.work.value
    • phoneNumbers - 다음 값만 허용됩니다.
      • phoneNumbers.value - 전화 번호 유형 작업에 매핑합니다.
      • phoneNumbers.home.value
      • phoneNumbers.mobile.value
      • phoneNumbers.work.value
    null인 값의 경우:
    • 오름차순으로 정렬 - Null 값이 맨 위로 정렬됩니다.
    • sorted by descending - Null 값이 맨 아래로 정렬됩니다.

    데이터 유형: 문자열

    기본값: 정렬이 수행되지 않음
    sortOrder 매개변수와 sortBy 함께 지정해야 합니다. sortBy 매개 변수가 반환 결과에 적용되는 순서입니다.
    유효한 값은 다음과 같습니다.
    • 오름차순
    • 내림차순

    데이터 유형: 문자열

    기본값: 오름차순
    startIndex 기록 검색을 시작할 사용자 [sys_user] 테이블에 대한 1부터 시작하는 인덱스입니다. 예를 들어 이 매개 변수를 100 count 으로 설정하고 매개 변수를 20으로 설정하면 엔드포인트는 100에서 119까지의 레코드를 반환합니다.
    주:
    1보다 작게 설정된 값은 1로 해석됩니다.

    path 매개변수와 id 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 1
    표 57. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 58. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 59. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 60. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.

    응답 본문 매개변수(JSON)

    이름 설명
    itemsPerPage 반환 결과에 반환된 기록 수입니다.

    데이터 유형: 숫자
    자원 사용자 기록의 목록입니다.

    데이터 형식: 객체 배열

    "Resources": [
  {
    "active": Boolean,
    "addresses": {Object},
    "displayName": "String",
    "emails": [Array],
    "externalId": "String",
    "groups": [Array],
    "id": "String",
    "meta": {Object},
    "name": {Object},
    "phoneNumbers": [Array],
    "preferredLanguage": "String",
    "schemas": [Array],
    "timezone": "String",
    "title": "String",
    "userName": "String",
    "userType": "String"
  }
]
    Resources.active 관련된 사용자가 인스턴스 내에서 활성 상태인지 여부를 나타내는 플래그입니다 ServiceNow .
    가능한 값:
    • true: 사용자가 활성 상태입니다.
    • false: 사용자가 비활성 상태입니다.

    데이터 유형: 부울
    리소스.주소 사용자의 현재 우편 주소에 대한 세부 정보입니다.

    데이터 유형: 객체

    "addresses": {
  "country": "String",
  "locality": "String",
  "postalCode": "String",
  "region": "String",
  "streetAddress": "String",
  "type": "String"
}
    Resources.addresses.country 국가 이름입니다.

    데이터 유형: 문자열
    Resources.addresses.locality (리소스.주소.지역) 도시 또는 지역 이름입니다.

    데이터 유형: 문자열
    Resources.addresses.postalCode 우편 번호.

    데이터 유형: 문자열
    Resources.addresses.region 주 또는 지역입니다.

    데이터 유형: 문자열
    Resources.addresses.streetAddress 전체 주소. 여기에는 집 번호, 거리 이름, 사서함 및 여러 줄로 확장 된 거리 주소 정보가 포함될 수 있습니다.

    데이터 유형: 문자열
    Resources.addresses.type 주소 유형입니다. 현재는 홈만 지원합니다.

    데이터 유형: 문자열
    Resources.displayName 사용자 표시 이름입니다. 이 값은 필드를 연결하여 name 자동으로 생성됩니다.

    데이터 유형: 문자열
    Resources.emails 사용자와 연결된 이메일 계정의 목록입니다.

    데이터 형식: 객체 배열

    "emails:" [
  {
    "type": "String",
    "value": "String"
  }
]
    Resources.emails.type 사용자 이메일 유형입니다. 현재는 "작업" 유형만 지원합니다.

    데이터 유형: 문자열
    리소스.이메일.값 사용자의 이메일 주소입니다. 연결된 사용자의 고유 키입니다.

    데이터 유형: 문자열
    Resources.externalId 프로비저닝하는 엔터티에서 사용자에게 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    Resources.groups 직접 구성원 자격, 중첩된 그룹 또는 동적으로 계산된 사용자를 속한 그룹 목록입니다.

    데이터 형식: 객체 배열

    "groups": [
  {
    "display": "String",
    "type": "String",
    "value": "String",
    "$ref": "String"
  }
]
    Resources.groups.display 연결된 그룹의 이름입니다.

    데이터 유형: 문자열
    Resources.groups.type 직접 또는 간접과 같은 그룹 연결 유형입니다.

    데이터 유형: 문자열
    Resources.groups.value 연결된 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    Resources.groups.ref 연결된 그룹의 URI입니다.

    데이터 유형: 문자열
    Resources.id 연결된 사용자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    리소스.메타 사용자와 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    Resources.meta.created 사용자 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.lastModified 사용자 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.location 검색 중인 사용자의 URI입니다.

    데이터 유형: 문자열
    Resources.meta.resourceType SCIM 사용자의 자원 유형입니다.

    데이터 유형: 문자열
    Resources.name 사용자 이름 정보.

    데이터 유형: 객체

    "name": {
  "familyName": "String",
  "givenName": "String",
  "honorificPrefix": "String",
  "middleName": "String"
}
    Resources.name.familyName 사용자의 가족 또는 성입니다.

    데이터 유형: 문자열
    Resources.name.givenName 사용자의 이름 또는 이름입니다.

    데이터 유형: 문자열
    Resources.name.honorificPrefix 사용자의 존칭 또는 직함(예: Dr., Bishop 또는 Baron)입니다.

    데이터 유형: 문자열
    Resources.name.middle 사용자의 중간 이름입니다.

    데이터 유형: 문자열
    Resources.phoneNumbers 사용자와 연결된 전화 번호 목록입니다.

    데이터 형식: 객체 배열

    "phoneNumbers": [
  {
    "type": "String",
    "value": "String"
  }
]
    Resources.phoneNumbers.type 전화 번호 유형입니다.

    가능한 값:

    • 홈
    • 모바일
    • 일하다

    데이터 유형: 문자열
    Resources.phoneNumbers.value 사용자의 전화 번호입니다.

    데이터 유형: 문자열
    Resources.preferredLanguage 사용자가 선호하는 말하기 및 쓰기 언어입니다.

    데이터 유형: 문자열
    Resources.schemas 요청을 처리하는 데 사용되는 SCIM 사용자 스키마의 URI 목록입니다.

    데이터 형식: 문자열 배열
    Resources.timezone 사용자의 시간대입니다.

    데이터 유형: 문자열
    Resources.title CEO 또는 사장과 같은 사용자 직함입니다.

    데이터 유형: 문자열
    Resources.userName 연결된 사용자의 고유한 사용자 이름입니다.

    데이터 유형: 문자열
    Resources.userType 사용자 유형입니다. 이 값은 조직과 사용자 관계를 식별하는 데 사용됩니다.
    이 값은 모든 값이 될 수 있지만 일반적인 값에는 다음이 포함될 수 있습니다.
    • 협력업체
    • 직원
    • 인턴
    • 임시 직원
    • 외부
    • 알 수 없음

    데이터 유형: 문자열
    스키마 요청을 처리하는 데 사용되는 SCIM ListResponse 스키마의 URI 목록입니다.

    데이터 형식: 문자열 배열
    startIndex 기록이 반환된 사용자 [sys_user] 테이블에 대한 1부터 시작하는 인덱스입니다.

    데이터 유형: 문자열
    totalResults 요청과 일치하는 총 기록 수입니다.

    데이터 유형: 숫자

    반환된 확장 매개변수

    이름 설명
    회사 사용자와 연결된 회사에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.가치 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    데이터 유형: 문자열
    비용 센터 사용자의 연결된 비용 센터에 대한 상세 정보입니다.

    데이터 유형: 객체

    "costCenter": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    costCenter.display 비용 센터의 이름입니다.

    데이터 유형: 문자열
    costCenter.value 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    costCenter.$ref 비용 센터의 참조 URI입니다.

    데이터 유형: 문자열
    부서 사용자의 연결된 부서에 대한 상세 정보입니다.

    데이터 유형: 객체

    "department": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    부서.표시 부서 이름.

    데이터 유형: 문자열
    부서.값 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    부서.$ref 부서의 참조 URI입니다.

    데이터 유형: 문자열
    employeeNumber 숫자 또는 영숫자 직원 번호입니다.

    데이터 유형: 문자열
    성별 사용자의 성별(예: 남성 또는 여성)입니다.

    데이터 유형: 문자열
    위치 사용자의 연결된 위치에 대한 세부 정보입니다.

    데이터 유형: 객체

    "location": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    location.display (위치.표시) 위치 이름입니다.

    데이터 유형: 문자열
    위치.값 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    위치.$ref 위치에 대한 참조 URI입니다.

    데이터 유형: 문자열
    매니저 사용자와 연결된 관리자에 대한 세부정보입니다.

    데이터 유형: 객체

    "manager": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    관리자.디스플레이 관리자의 이름입니다.

    데이터 유형: 문자열
    관리자.값 관리자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    관리자.$ref 관리자의 참조 URI입니다.

    데이터 유형: 문자열

    속성을 사용한 cURL 요청

    다음 예제에서는 여섯 번째 레코드에서 시작하여 표시 이름만 반환하는 두 명의 사용자를 가져오는 방법을 보여 줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Users?attributes=displayName&startIndex=6&count=2" \
--request GET \
--header "Accept:application/scim+json" \

    응답:

    {"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":619,
  "Resources":
    [
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"02826bf03710200044e0bfc8bcbe5d6d",
        "displayName":"Sean Bonnet"
      },
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
           ],
         "id":"02826bf03710200044e0bfc8bcbe5d76",
         "displayName":"Jacinto Gawron"
      }
    ],
  "startIndex":6,
  "itemsPerPage":2
}

    필터를 사용한 cURL 요청

    다음 예제에서는 매개 변수를 사용하여 filter 지정된 이름이 "a"로 시작하는 처음 두 개의 사용자 레코드를 반환하는 방법을 보여 줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Users?filter=name.givenName%20SW%20%22a%22&count=2" \
--request GET \
--header "Accept:application/scim+json" \

    응답:

    {"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":42,
  "Resources":
    [
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"06826bf03710200044e0bfc8bcbe5d8a",
        "meta":
          {
            "resourceType":"User",
            "created":"2012-02-18T03:04:50Z",
            "lastModified":"2021-10-01T14:23:32Z",
            "location":"https://instance-servicenow.com/api/now/scim/Users/06826bf03710200044e0bfc8bcbe5d8a"
          },
          "userName":"allyson.gillispie",
          "name":
            {
              "familyName":"Gillispie",
              "givenName":"Allyson"
            },
          "displayName":"Allyson Gillispie",
          "active":true,
          "emails":
            [
              {
                "value":"allyson.gillispie@example.com",
                "type":"work"
              }
            ],
          "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
            {
              "gender":"Female",
              "costCenter":
                {
                  "value":"d9d07bddc0a80a647cf932056ed24652",
                  "name":"Engineering"
                },
              "company":
                {
                  "value":"31bea3d53790200044e0bfc8bcbe5dec",
                  "name":"ACME North America"
                },
              "department":
                {
                  "value":"221f3db5c6112284009f4becd3039cc9",
                  "name":"Development"
                },
              "location":
                {
                  "value":"f9084ba00a0a0b910060ba2ce83f882b",
                  "name":"946 Donax Avenue, Imperial Beach,CA"
                }
            }
         },
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"0a826bf03710200044e0bfc8bcbe5d7a"
        "meta":
          {
            "resourceType":"User",
            "created":"2012-02-18T03:04:50Z",
            "lastModified":"2021-10-01T14:23:32Z",
            "location":"https://instance-servicenow.com/api/now/scim/Users/0a826bf03710200044e0bfc8bcbe5d7a"
          },
        "userName":"adela.cervantsz",
        "name":
          {
            "familyName":"Cervantsz",
            "givenName":"Adela"
          },
        "displayName":"Adela Cervantsz",
        "active":true,
        "emails":
          [
            {
              "value":"adela.cervantsz@example.com",
              "type":"work"
            }
          ],
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
          {
            "gender":"Female",
            "costCenter":
              {
                "value":"91e8bbf43710200044e0bfc8bcbe5daa",
                "name":"Customer Support"
              },
            "company":
              {
                "value":"31bea3d53790200044e0bfc8bcbe5dec",
                "name":"ACME North America"
              },
            "department":
              {
                "value":"5d7f17f03710200044e0bfc8bcbe5d43",
                "name":"Customer Support"
              },
            "location":
              {
                "value":"25ab93750a0a0bb30067bd2ef3d4a5c9",
                "name":"8306 Mills Drive, Miami,FL"
              }
          }
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

    SCIM - GET /scim/Users/{user_id}

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 사용자 [sys_user] 테이블에서 지정된 사용자 기록을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Users/{user_id}

    기본 URL: /api/now/scim/Users/{user_id}

    지원되는 요청 매개변수

    표 61. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    user_id 반환할 사용자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    표 62. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 63. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 64. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 65. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 66. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    active 관련된 사용자가 인스턴스 내에서 활성 상태인지 여부를 나타내는 플래그입니다 ServiceNow .
    가능한 값:
    • true: 사용자가 활성 상태입니다.
    • false: 사용자가 비활성 상태입니다.

    데이터 유형: 부울
    addresses 사용자의 현재 우편 주소에 대한 세부 정보입니다.

    데이터 유형: 객체

    "addresses": {
  "country": "String",
  "locality": "String",
  "postalCode": "String",
  "region": "String",
  "streetAddress": "String",
  "type": "String"
}
    주소.국가 국가 이름입니다.

    데이터 유형: 문자열
    주소.구/군/시 도시 또는 지역 이름입니다.

    데이터 유형: 문자열
    addresses.postalCode 우편 번호.

    데이터 유형: 문자열
    주소.지역 주 또는 지역입니다.

    데이터 유형: 문자열
    주소.거리 주소 전체 주소. 여기에는 집 번호, 거리 이름, 사서함 및 여러 줄로 확장 된 거리 주소 정보가 포함될 수 있습니다.

    데이터 유형: 문자열
    주소.유형 주소 유형입니다. 현재는 홈만 지원합니다.

    데이터 유형: 문자열
    displayName 사용자 표시 이름입니다. 이 값은 필드를 연결하여 name 자동으로 생성됩니다.

    데이터 유형: 문자열
    이메일 사용자와 연결된 이메일 계정의 목록입니다.

    데이터 형식: 객체 배열

    "emails:" [
  {
    "type": "String",
    "value": "String"
  }
]
    emails.type 사용자 이메일 유형입니다. 현재는 "작업" 유형만 지원합니다.

    데이터 유형: 문자열
    emails.value 사용자의 이메일 주소입니다. 연결된 사용자의 고유 키입니다.

    데이터 유형: 문자열
    externalId 프로비저닝하는 엔터티에서 사용자에게 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    그룹 직접 구성원 자격, 중첩된 그룹 또는 동적으로 계산된 사용자를 속한 그룹 목록입니다.

    데이터 형식: 객체 배열

    "groups": [
  {
    "display": "String",
    "type": "String",
    "value": "String",
    "$ref": "String"
  }
]
    그룹.디스플레이 연결된 그룹의 이름입니다.

    데이터 유형: 문자열
    groups.type 직접 또는 간접과 같은 그룹 연결 유형입니다.

    데이터 유형: 문자열
    그룹.값 연결된 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    그룹.$ref 연결된 그룹의 URI입니다.

    데이터 유형: 문자열
    id 연결된 사용자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    메타 사용자와 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    meta.created입니다. 사용자 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 사용자 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 검색 중인 사용자의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 사용자의 자원 유형입니다.

    데이터 유형: 문자열
    이름 사용자 이름 정보.

    데이터 유형: 객체

    "name": {
  "familyName": "String",
  "givenName": "String",
  "honorificPrefix": "String",
  "middleName": "String"
}
    name.familyName 사용자의 가족 또는 성입니다.

    데이터 유형: 문자열
    name.givenName (이름.givenName) 사용자의 이름 또는 이름입니다.

    데이터 유형: 문자열
    name.honorificPrefix 사용자의 존칭 또는 직함(예: Dr., Bishop 또는 Baron)입니다.

    데이터 유형: 문자열
    이름.중간 사용자의 중간 이름입니다.

    데이터 유형: 문자열
    phoneNumbers 사용자와 연결된 전화 번호 목록입니다.

    데이터 형식: 객체 배열

    "phoneNumbers": [
  {
    "type": "String",
    "value": "String"
  }
]
    phoneNumbers.type 전화 번호 유형입니다.

    가능한 값:

    • 홈
    • 모바일
    • 일하다

    데이터 유형: 문자열
    phoneNumbers.값 사용자의 전화 번호입니다.

    데이터 유형: 문자열
    preferredLanguage 사용자가 선호하는 말하기 및 쓰기 언어입니다.

    데이터 유형: 문자열
    스키마 요청을 처리하는 데 사용되는 SCIM 사용자 스키마의 URI 목록입니다.

    데이터 형식: 문자열 배열
    시간대 사용자의 시간대입니다.

    데이터 유형: 문자열
    직위 CEO 또는 사장과 같은 사용자 직함입니다.

    데이터 유형: 문자열
    userName 연결된 사용자의 고유한 사용자 이름입니다.

    데이터 유형: 문자열
    사용자 유형 사용자 유형입니다. 이 값은 조직과 사용자 관계를 식별하는 데 사용됩니다.
    이 값은 모든 값이 될 수 있지만 일반적인 값에는 다음이 포함될 수 있습니다.
    • 협력업체
    • 직원
    • 인턴
    • 임시 직원
    • 외부
    • 알 수 없음

    데이터 유형: 문자열

    반환된 확장 매개변수

    이름 설명
    회사 사용자와 연결된 회사에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.가치 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    데이터 유형: 문자열
    비용 센터 사용자의 연결된 비용 센터에 대한 상세 정보입니다.

    데이터 유형: 객체

    "costCenter": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    costCenter.display 비용 센터의 이름입니다.

    데이터 유형: 문자열
    costCenter.value 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    costCenter.$ref 비용 센터의 참조 URI입니다.

    데이터 유형: 문자열
    부서 사용자의 연결된 부서에 대한 상세 정보입니다.

    데이터 유형: 객체

    "department": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    부서.표시 부서 이름.

    데이터 유형: 문자열
    부서.값 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    부서.$ref 부서의 참조 URI입니다.

    데이터 유형: 문자열
    employeeNumber 숫자 또는 영숫자 직원 번호입니다.

    데이터 유형: 문자열
    성별 사용자의 성별(예: 남성 또는 여성)입니다.

    데이터 유형: 문자열
    위치 사용자의 연결된 위치에 대한 세부 정보입니다.

    데이터 유형: 객체

    "location": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    location.display (위치.표시) 위치 이름입니다.

    데이터 유형: 문자열
    위치.값 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    위치.$ref 위치에 대한 참조 URI입니다.

    데이터 유형: 문자열
    매니저 사용자와 연결된 관리자에 대한 세부정보입니다.

    데이터 유형: 객체

    "manager": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    관리자.디스플레이 관리자의 이름입니다.

    데이터 유형: 문자열
    관리자.값 관리자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    관리자.$ref 관리자의 참조 URI입니다.

    데이터 유형: 문자열

    사용자 sys_id 사용한 cURL 요청

    다음 예제에서는 해당 sys_id 전달하여 특정 사용자 레코드를 가져오는 방법을 보여 줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/scim+json" \

    응답:

    {"schemas":
  [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
    "id":"62826bf03710200044e0bfc8bcbe5df1",
    "meta":
      {
        "resourceType":"User",
        "created":"2012-02-18T03:04:52Z",
        "lastModified":"2021-10-01T14:23:34Z",
        "location":"https://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
      },
    "userName":"abel.tuter",
    "name":
      {
        "familyName":"Tuter",
        "givenName":"Abel"
      },
    "displayName":"Abel Tuter",
    "active":true,
    "emails":[
      {
        "value":"abel.tuter@example.com",
        "type":"work"
      }
    ],
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
      {
        "gender":"Male",
        "costCenter":
          {
            "value":"d9d07bddc0a80a647cf932056ed24652",
            "name":"Engineering"
          },
        "company":
          {
            "value":"227cdfb03710200044e0bfc8bcbe5d6b",
            "name":"ACME South America"
          },
        "department":
          {
            "value":"9a7ed3f03710200044e0bfc8bcbe5db7",
            "name":"Product Management"
           },
        "location":
          {
            "value":"25b3d04b0a0a0bb300176b546c22db27",
            "name":"SHS quadra 5, Bloco E., Brasilia"}
          }
      }

    SCIM - 패치 /scim/Users/{user_id}

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스의 ServiceNow 사용자 [sys_user] 테이블에 있는 사용자 기록의 지정된 필드를 추가, 교체 및 제거할 수 있습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Users/{user_id}

    기본 URL: /api/now/scim/Users/{user_id}

    지원되는 요청 매개변수

    표 67. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    user_id 수정할 사용자 기록의 Sys_id입니다.
    표 68. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 69. 요청 본문 매개변수(JSON)
    이름 설명
    운영 필수 지정된 사용자 기록을 패치할 작업 객체의 목록입니다.

    데이터 유형: 배열

    "Operations": [
  {
    "op": "String",
    "path": "String",
    "value": Any
  }
]
    운영.op 필수 수행할 작업입니다.
    유효한 값은 다음과 같습니다.
    • 추가: 지정된 필드와 값을 사용자 기록에 추가합니다.
    • remove: 지정된 필드에서 값을 제거합니다.
    • replace: 지정된 필드의 값을 바꿉니다.

    데이터 유형: 문자열
    운영.경로 제거 작업에 필요합니다. 수정할 필드의 이름/경로입니다.
    매개변수는 path 다음 형식 중 하나를 가질 수 있습니다.
    • 제목과 같은 직접 필드
    • 중첩된 필드(예: name.givenName)
    • 복합 배열의 경우 필터가 있는 특정 요소를 가리킬 수 있습니다(예: emails[type eq "work"]).
    {
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "title",
      "value": "xyz"
    },
    {  
      "op": "replace",
      "path": "name.givenName",
      "value": "Jennifer"
    },
    {
      "op": "replace",
      "path": "emails[type eq \"work\"]",
      "value": "xyz@test.com"
    }
  ]
}

    데이터 유형: 문자열

    기본값: 필드를 사용자 자원으로 간주합니다.
    운영.가치 매개변수에 지정된 필드의 값입니다 Operations.path . 이 매개변수의 형식은 연결된 필드의 데이터 유형에 따라 다릅니다.

    예를 들어 제목과 같은 단순 문자열을 업데이트하는 경우 필드는 value 문자열로 표현됩니다.

     "Operations": [
  {
    "op": "add",
    "path": "title",
    "value": "xyz"
  }
]
    using value 또는 path 매개 변수 없이 다음과 같은 간단한 문자열 값을 선언할 수도 있습니다. 
     "Operations": [
  {
    "op": "add",
    "title": "xyz"
  }
]

    그러나 사용자 기록에 추가할 추가 필드를 정의하는 객체 및 관련 값을 value 정의하는 객체가 포함된 배열인 전화 번호를 업데이트할 때 필드는 객체 배열로 표현됩니다.

     "Operations": [
  {
    "op": "add",
    "path": "phoneNumbers",
    "value": [
      {
        "type": "work",
        "value": "9876543210"
      },
      {
        "type": "home",
        "value": "9876783216"
      }
    ]
  }
]
    특성 노드를 지정할 때 항목에 다음과 같이 중첩이 포함될 수 있습니다.
    {
  "op": "replace",
  "value": {
    "name": {
      "familyName": "Jones",
      "givenName": "Jennifer"
    }
  }
}
    또는 다음에서 중첩을 지정할 수 있습니다.Operations.path
    {
  "op": "replace",
  "path": "name.givenName",
  "value": "Jennifer"
}

    업데이트 중인 필드가 base-schema에 없는 경우 연결된 스키마의 URN을 지정하는 개체에 이름-값 쌍을 묶어야 합니다.

    "value": {
  "<schema_urn>": {
    "<field_name>": "<new_value>"
  },
}

    예:

    "value": {
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": {
    "employeeNumber": "13454"
  },
}
    데이터 유형: 모두
    운영.값.유형 업데이트할 필드의 이름입니다.

    데이터 유형: 문자열
    운영.값.값 필드를 업데이트하는 데 사용할 값입니다.

    데이터 유형: 문자열
    스키마 필수 패치 작업의 SCIM 스키마 URI urn:ietf:params:scim:api:messages:2.0:PatchOp.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 70. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 71. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 72. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 잘못된 값 확인:
      • 요청 본문의 변형이 있습니다.
      • 필수 필드가 제공되지 않았거나 비어 있습니다.
      • 잘못된 사용자 또는 그룹 sys_id가 제공되었습니다.
    • 읽기 전용 또는 변경할 수 없는 필드를 수정하려고 하는지 확인합니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 모두 요청에 전달되지 않았거나 요청이 최대 구성원 수를 초과하지 않는지 확인합니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    409 사용자가 이미 있습니다. 매개변수는 userName 고유해야 합니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    active 관련된 사용자가 인스턴스 내에서 활성 상태인지 여부를 나타내는 플래그입니다 ServiceNow .
    가능한 값:
    • true: 사용자가 활성 상태입니다.
    • false: 사용자가 비활성 상태입니다.

    데이터 유형: 부울
    addresses 사용자의 현재 우편 주소에 대한 세부 정보입니다.

    데이터 유형: 객체

    "addresses": {
  "country": "String",
  "locality": "String",
  "postalCode": "String",
  "region": "String",
  "streetAddress": "String",
  "type": "String"
}
    주소.국가 국가 이름입니다.

    데이터 유형: 문자열
    주소.구/군/시 도시 또는 지역 이름입니다.

    데이터 유형: 문자열
    addresses.postalCode 우편 번호.

    데이터 유형: 문자열
    주소.지역 주 또는 지역입니다.

    데이터 유형: 문자열
    주소.거리 주소 전체 주소. 여기에는 집 번호, 거리 이름, 사서함 및 여러 줄로 확장 된 거리 주소 정보가 포함될 수 있습니다.

    데이터 유형: 문자열
    주소.유형 주소 유형입니다. 현재는 홈만 지원합니다.

    데이터 유형: 문자열
    displayName 사용자 표시 이름입니다. 이 값은 필드를 연결하여 name 자동으로 생성됩니다.

    데이터 유형: 문자열
    이메일 사용자와 연결된 이메일 계정의 목록입니다.

    데이터 형식: 객체 배열

    "emails:" [
  {
    "type": "String",
    "value": "String"
  }
]
    emails.type 사용자 이메일 유형입니다. 현재는 "작업" 유형만 지원합니다.

    데이터 유형: 문자열
    emails.value 사용자의 이메일 주소입니다. 연결된 사용자의 고유 키입니다.

    데이터 유형: 문자열
    오류 요청을 처리하는 동안 발생했을 수 있는 오류를 설명하는 응답입니다.

    데이터 유형: 객체

    "errors": {
  "details": "String",
  "schemas": "String",
  "scimType": "String",
  "status": "String"
}
    오류.세부 정보 요청 실패 이유에 대한 자세한 오류 메시지입니다.

    데이터 유형: 문자열
    오류.scimType SCIM 오류 상세 정보 키워드입니다.

    데이터 유형: 문자열
    오류.스키마 오류 응답을 처리하는 데 사용되는 SCIM 스키마의 URI입니다.

    데이터 형식: 문자열 배열
    오류.상태 오류 응답의 HTTP 상태 코드입니다.

    데이터 유형: 문자열
    externalId 프로비저닝하는 엔터티에서 사용자에게 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    그룹 직접 구성원 자격, 중첩된 그룹 또는 동적으로 계산된 사용자를 속한 그룹 목록입니다.

    데이터 형식: 객체 배열

    "groups": [
  {
    "display": "String",
    "type": "String",
    "value": "String",
    "$ref": "String"
  }
]
    그룹.디스플레이 연결된 그룹의 이름입니다.

    데이터 유형: 문자열
    groups.type 직접 또는 간접과 같은 그룹 연결 유형입니다.

    데이터 유형: 문자열
    그룹.값 연결된 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    그룹.$ref 연결된 그룹의 URI입니다.

    데이터 유형: 문자열
    id 연결된 사용자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    메타 사용자와 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    meta.created입니다. 사용자 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 사용자 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 검색 중인 사용자의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 사용자의 자원 유형입니다.

    데이터 유형: 문자열
    이름 사용자 이름 정보.

    데이터 유형: 객체

    "name": {
  "familyName": "String",
  "givenName": "String",
  "honorificPrefix": "String",
  "middleName": "String"
}
    name.familyName 사용자의 가족 또는 성입니다.

    데이터 유형: 문자열
    name.givenName (이름.givenName) 사용자의 이름 또는 이름입니다.

    데이터 유형: 문자열
    name.honorificPrefix 사용자의 존칭 또는 직함(예: Dr., Bishop 또는 Baron)입니다.

    데이터 유형: 문자열
    이름.중간 사용자의 중간 이름입니다.

    데이터 유형: 문자열
    phoneNumbers 사용자와 연결된 전화 번호 목록입니다.

    데이터 형식: 객체 배열

    "phoneNumbers": [
  {
    "type": "String",
    "value": "String"
  }
]
    phoneNumbers.type 전화 번호 유형입니다.

    가능한 값:

    • 홈
    • 모바일
    • 일하다

    데이터 유형: 문자열
    phoneNumbers.값 사용자의 전화 번호입니다.

    데이터 유형: 문자열
    preferredLanguage 사용자가 선호하는 말하기 및 쓰기 언어입니다.

    데이터 유형: 문자열
    스키마 요청을 처리하는 데 사용되는 SCIM 사용자 스키마의 URI 목록입니다.

    데이터 형식: 문자열 배열
    시간대 사용자의 시간대입니다.

    데이터 유형: 문자열
    직위 CEO 또는 사장과 같은 사용자 직함입니다.

    데이터 유형: 문자열
    userName 연결된 사용자의 고유한 사용자 이름입니다.

    데이터 유형: 문자열
    사용자 유형 사용자 유형입니다. 이 값은 조직과 사용자 관계를 식별하는 데 사용됩니다.
    이 값은 모든 값이 될 수 있지만 일반적인 값에는 다음이 포함될 수 있습니다.
    • 협력업체
    • 직원
    • 인턴
    • 임시 직원
    • 외부
    • 알 수 없음

    데이터 유형: 문자열

    반환된 확장 매개변수

    이름 설명
    회사 사용자와 연결된 회사에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.가치 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    데이터 유형: 문자열
    비용 센터 사용자의 연결된 비용 센터에 대한 상세 정보입니다.

    데이터 유형: 객체

    "costCenter": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    costCenter.display 비용 센터의 이름입니다.

    데이터 유형: 문자열
    costCenter.value 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    costCenter.$ref 비용 센터의 참조 URI입니다.

    데이터 유형: 문자열
    부서 사용자의 연결된 부서에 대한 상세 정보입니다.

    데이터 유형: 객체

    "department": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    부서.표시 부서 이름.

    데이터 유형: 문자열
    부서.값 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    부서.$ref 부서의 참조 URI입니다.

    데이터 유형: 문자열
    employeeNumber 숫자 또는 영숫자 직원 번호입니다.

    데이터 유형: 문자열
    성별 사용자의 성별(예: 남성 또는 여성)입니다.

    데이터 유형: 문자열
    위치 사용자의 연결된 위치에 대한 세부 정보입니다.

    데이터 유형: 객체

    "location": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    location.display (위치.표시) 위치 이름입니다.

    데이터 유형: 문자열
    위치.값 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    위치.$ref 위치에 대한 참조 URI입니다.

    데이터 유형: 문자열
    매니저 사용자와 연결된 관리자에 대한 세부정보입니다.

    데이터 유형: 객체

    "manager": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    관리자.디스플레이 관리자의 이름입니다.

    데이터 유형: 문자열
    관리자.값 관리자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    관리자.$ref 관리자의 참조 URI입니다.

    데이터 유형: 문자열

    cURL 요청

    다음 예제에서는 사용자 기록 내에서 값을 추가, 제거 및 바꾸는 방법을 보여 줍니다.

    curl -X PATCH \
  https://instance-servicenow.com/api/now/scim/Users/005d500b536073005e0addeeff7b12f4 \
  -d '{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op" : "remove",
      "path" : "title" 
    },
    {
      "op" : "add",
      "path" : "phoneNumbers",
      "value" : [
        {
          "type" : "work",
          "value" : "9876543210"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": {
            "employeeNumber": "13454"
        },
        "name": {
            "familyName": "John",
            "givenName": "Smith"
        }
      }
    }
  ]
}'

    응답:

    {
  "schemas":[
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id":"005d500b536073005e0addeeff7b12f4",
  "meta":{
    "resourceType":"User",
    "created":"2019-04-05T21:09:12Z",
    "lastModified":"2021-10-12T18:29:27Z",
    "location":"https://instance-servicenow.com/api/now/scim/Users/005d500b536073005e0addeeff7b12f4"
  },
  "userName":"survey.user",
  "name":{
    "familyName":"John",
    "givenName":"Smith"
  },
  "displayName":"Smith John",
  "active":true,
  "emails":[
    {
      "value":"survey.user@email.com",
      "type":"work"
    }
  ],
  "phoneNumbers":[
    {
      "value":"9876543210",
      "type":"work"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":{
    "employeeNumber":"13454"
  }
}

    SCIM - POST /scim/사용자

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스의 ServiceNow 사용자 [sys_user] 테이블에 사용자 기록을 생성합니다.

    주:
    RFC7643 사양에 명시된 검색 및 대량 수정 기능은 이 엔드포인트에서 지원되지 않습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Users

    기본 URL: /api/now/scim/Users

    지원되는 요청 매개변수

    표 73. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 74. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 75. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    active 관련된 사용자가 인스턴스 내에서 활성 상태인지 여부를 나타내는 플래그입니다 ServiceNow .
    가능한 값:
    • true: 사용자가 활성 상태입니다.
    • false: 사용자가 비활성 상태입니다.

    데이터 유형: 부울
    addresses 사용자의 현재 우편 주소에 대한 세부 정보입니다.

    데이터 유형: 객체

    "addresses": {
  "country": "String",
  "locality": "String",
  "postalCode": "String",
  "region": "String",
  "streetAddress": "String",
  "type": "String"
}
    주소.국가 국가 이름입니다.

    데이터 유형: 문자열
    주소.구/군/시 도시 또는 지역 이름입니다.

    데이터 유형: 문자열
    addresses.postalCode 우편 번호.

    데이터 유형: 문자열
    주소.지역 주 또는 지역입니다.

    데이터 유형: 문자열
    주소.거리 주소 전체 주소. 여기에는 집 번호, 거리 이름, 사서함 및 여러 줄로 확장 된 거리 주소 정보가 포함될 수 있습니다.

    데이터 유형: 문자열
    주소.유형 주소 유형입니다. 현재는 홈만 지원합니다.

    데이터 유형: 문자열
    displayName 사용자 표시 이름입니다. 이 값은 필드를 연결하여 name 자동으로 생성됩니다.

    데이터 유형: 문자열
    이메일 사용자와 연결된 이메일 계정의 목록입니다.

    데이터 형식: 객체 배열

    "emails:" [
  {
    "type": "String",
    "value": "String"
  }
]
    emails.type 사용자 이메일 유형입니다. 현재는 "작업" 유형만 지원합니다.

    데이터 유형: 문자열
    emails.value 사용자의 이메일 주소입니다. 연결된 사용자의 고유 키입니다.

    데이터 유형: 문자열
    externalId 프로비저닝하는 엔터티에서 사용자에게 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    이름 사용자 이름 정보.

    데이터 유형: 객체

    "name": {
  "familyName": "String",
  "givenName": "String",
  "honorificPrefix": "String",
  "middleName": "String"
}
    name.familyName 사용자의 가족 또는 성입니다.

    데이터 유형: 문자열
    name.givenName (이름.givenName) 사용자의 이름 또는 이름입니다.

    데이터 유형: 문자열
    name.honorificPrefix 사용자의 존칭 또는 직함(예: Dr., Bishop 또는 Baron)입니다.

    데이터 유형: 문자열
    이름.중간 사용자의 중간 이름입니다.

    데이터 유형: 문자열
    phoneNumbers 사용자와 연결된 전화 번호 목록입니다.

    데이터 형식: 객체 배열

    "phoneNumbers": [
  {
    "type": "String",
    "value": "String"
  }
]
    phoneNumbers.type 전화 번호 유형입니다.

    가능한 값:

    • 홈
    • 모바일
    • 일하다

    데이터 유형: 문자열
    phoneNumbers.값 사용자의 전화 번호입니다.

    데이터 유형: 문자열
    preferredLanguage 사용자가 선호하는 말하기 및 쓰기 언어입니다.

    데이터 유형: 문자열
    시간대 사용자의 시간대입니다.

    데이터 유형: 문자열
    직위 CEO 또는 사장과 같은 사용자 직함입니다.

    데이터 유형: 문자열
    userName 필수 연결된 사용자의 고유한 사용자 이름입니다.

    데이터 유형: 문자열
    사용자 유형 사용자 유형입니다. 이 값은 조직과 사용자 관계를 식별하는 데 사용됩니다.
    이 값은 모든 값이 될 수 있지만 일반적인 값에는 다음이 포함될 수 있습니다.
    • 협력업체
    • 직원
    • 인턴
    • 임시 직원
    • 외부
    • 알 수 없음

    데이터 유형: 문자열
    확장된 스키마
    회사 사용자와 연결된 회사에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "value": "String"
}
    회사.가치 회사가 게시물에 포함된 경우 필수입니다. 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    비용 센터 사용자의 연결된 비용 센터에 대한 상세 정보입니다.

    데이터 유형: 객체

    "costCenter": {
  "value": "String"
}
    costCenter.value costCenter가 포스트에 포함된 경우 필수입니다. 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    부서 사용자의 연결된 부서에 대한 상세 정보입니다.

    데이터 유형: 객체

    "department": {
  "value": "String"
}
    부서.값 부서가 게시물에 포함된 경우 필수입니다. 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    employeeNumber 숫자 또는 영숫자 직원 번호입니다.

    데이터 유형: 문자열
    성별 사용자의 성별(예: 남성 또는 여성)입니다.

    데이터 유형: 문자열
    위치 사용자의 연결된 위치에 대한 세부 정보입니다.

    데이터 유형: 객체

    "location": {
  "value": "String"
}
    위치.값 위치가 게시물에 포함된 경우 필수입니다. 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    매니저 사용자와 연결된 관리자에 대한 세부정보입니다.

    데이터 유형: 객체

    "manager": {
  "value": "String"
}
    관리자.값 관리자가 게시물에 포함된 경우 필수입니다. 관리자 기록의 Sys_id입니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 76. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 77. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 78. 상태 코드
    상태 코드 설명
    201 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    409 사용자가 이미 있습니다. 매개변수는 userName 고유해야 합니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    active 관련된 사용자가 인스턴스 내에서 활성 상태인지 여부를 나타내는 플래그입니다 ServiceNow .
    가능한 값:
    • true: 사용자가 활성 상태입니다.
    • false: 사용자가 비활성 상태입니다.

    데이터 유형: 부울
    addresses 사용자의 현재 우편 주소에 대한 세부 정보입니다.

    데이터 유형: 객체

    "addresses": {
  "country": "String",
  "locality": "String",
  "postalCode": "String",
  "region": "String",
  "streetAddress": "String",
  "type": "String"
}
    주소.국가 국가 이름입니다.

    데이터 유형: 문자열
    주소.구/군/시 도시 또는 지역 이름입니다.

    데이터 유형: 문자열
    addresses.postalCode 우편 번호.

    데이터 유형: 문자열
    주소.지역 주 또는 지역입니다.

    데이터 유형: 문자열
    주소.거리 주소 전체 주소. 여기에는 집 번호, 거리 이름, 사서함 및 여러 줄로 확장 된 거리 주소 정보가 포함될 수 있습니다.

    데이터 유형: 문자열
    주소.유형 주소 유형입니다. 현재는 홈만 지원합니다.

    데이터 유형: 문자열
    displayName 사용자 표시 이름입니다. 이 값은 필드를 연결하여 name 자동으로 생성됩니다.

    데이터 유형: 문자열
    이메일 사용자와 연결된 이메일 계정의 목록입니다.

    데이터 형식: 객체 배열

    "emails:" [
  {
    "type": "String",
    "value": "String"
  }
]
    emails.type 사용자 이메일 유형입니다. 현재는 "작업" 유형만 지원합니다.

    데이터 유형: 문자열
    emails.value 사용자의 이메일 주소입니다. 연결된 사용자의 고유 키입니다.

    데이터 유형: 문자열
    오류 요청을 처리하는 동안 발생했을 수 있는 오류를 설명하는 응답입니다.

    데이터 유형: 객체

    "errors": {
  "details": "String",
  "schemas": "String",
  "scimType": "String",
  "status": "String"
}
    오류.세부 정보 요청 실패 이유에 대한 자세한 오류 메시지입니다.

    데이터 유형: 문자열
    오류.scimType SCIM 오류 상세 정보 키워드입니다.

    데이터 유형: 문자열
    오류.스키마 오류 응답을 처리하는 데 사용되는 SCIM 스키마의 URI입니다.

    데이터 형식: 문자열 배열
    오류.상태 오류 응답의 HTTP 상태 코드입니다.

    데이터 유형: 문자열
    externalId 프로비저닝하는 엔터티에서 사용자에게 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    그룹 직접 구성원 자격, 중첩된 그룹 또는 동적으로 계산된 사용자를 속한 그룹 목록입니다.

    데이터 형식: 객체 배열

    "groups": [
  {
    "display": "String",
    "type": "String",
    "value": "String",
    "$ref": "String"
  }
]
    그룹.디스플레이 연결된 그룹의 이름입니다.

    데이터 유형: 문자열
    groups.type 직접 또는 간접과 같은 그룹 연결 유형입니다.

    데이터 유형: 문자열
    그룹.값 연결된 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    그룹.$ref 연결된 그룹의 URI입니다.

    데이터 유형: 문자열
    id 연결된 사용자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    메타 사용자와 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    meta.created입니다. 사용자 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 사용자 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 검색 중인 사용자의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 사용자의 자원 유형입니다.

    데이터 유형: 문자열
    이름 사용자 이름 정보.

    데이터 유형: 객체

    "name": {
  "familyName": "String",
  "givenName": "String",
  "honorificPrefix": "String",
  "middleName": "String"
}
    name.familyName 사용자의 가족 또는 성입니다.

    데이터 유형: 문자열
    name.givenName (이름.givenName) 사용자의 이름 또는 이름입니다.

    데이터 유형: 문자열
    name.honorificPrefix 사용자의 존칭 또는 직함(예: Dr., Bishop 또는 Baron)입니다.

    데이터 유형: 문자열
    이름.중간 사용자의 중간 이름입니다.

    데이터 유형: 문자열
    phoneNumbers 사용자와 연결된 전화 번호 목록입니다.

    데이터 형식: 객체 배열

    "phoneNumbers": [
  {
    "type": "String",
    "value": "String"
  }
]
    phoneNumbers.type 전화 번호 유형입니다.

    가능한 값:

    • 홈
    • 모바일
    • 일하다

    데이터 유형: 문자열
    phoneNumbers.값 사용자의 전화 번호입니다.

    데이터 유형: 문자열
    preferredLanguage 사용자가 선호하는 말하기 및 쓰기 언어입니다.

    데이터 유형: 문자열
    스키마 요청을 처리하는 데 사용되는 SCIM 사용자 스키마의 URI 목록입니다.

    데이터 형식: 문자열 배열
    시간대 사용자의 시간대입니다.

    데이터 유형: 문자열
    직위 CEO 또는 사장과 같은 사용자 직함입니다.

    데이터 유형: 문자열
    userName 연결된 사용자의 고유한 사용자 이름입니다.

    데이터 유형: 문자열
    사용자 유형 사용자 유형입니다. 이 값은 조직과 사용자 관계를 식별하는 데 사용됩니다.
    이 값은 모든 값이 될 수 있지만 일반적인 값에는 다음이 포함될 수 있습니다.
    • 협력업체
    • 직원
    • 인턴
    • 임시 직원
    • 외부
    • 알 수 없음

    데이터 유형: 문자열

    POST 사용자에 대한 cURL 요청

    이 예에서는 사용자 Jack Sparrow를 사용자 [sys_user] 테이블에 POST하는 방법을 보여 줍니다.

    curl -X POST \
  https://instance-servicenow.com/api/now/scim/Users \
  -d '{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "externalId": "123456",
    "userName": "jack.sparrow",
    "name": {
        "familyName": "Sparrow",
        "givenName": "Jack"
    },
    "title": "Senior Developer",
    "preferredLanguage": "en",
    "timezone": "ET",
    "active": true,
    "emails": [
      {
        "value": "jack.sparrow@abc.com",
        "display": null,
        "type": "work",
        "primary": true
      }
    ],
    "phoneNumbers": [
      {
        "value": "9977553312",
        "type": "mobile",
        "primary": true
      }
    ]
}'

    응답

    {"schemas":
  [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id":"d6287d7b1bbe3010593876a61a4bcbc3",
  "externalId":"123456",
  "meta":{
    "resourceType":"User",
    "created":"2021-10-01T16:46:48Z",
    "lastModified":"2021-10-01T16:46:48Z",
    "location":"https://instance-servicenow.com/api/now/scim/Users/d6287d7b1bbe3010593876a61a4bcbc3"
  },
  "userName":"jack.sparrow",
  "name":{
    "familyName":"Sparrow",
    "givenName":"Jack"
  },
  "displayName":"Jack Sparrow",
  "title":"Senior Developer",
  "preferredLanguage":"en",
  "timezone":"ET",
  "active":true,
  "emails":[
    {
      "value":"jack.sparrow@abc.com",
      "type":"work"
    }
  ],
  "phoneNumbers":[
    {
      "value":"9977553312",
      "type":"mobile"
    }
  ]
}

    SCIM - PUT /scim/Users/{user_id}

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스의 ServiceNow 사용자 [sys_user] 테이블에서 지정된 사용자 기록을 업데이트합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Users/{user_id}

    기본 URL: /api/now/scim/Users/{user_id}

    지원되는 요청 매개변수

    표 79. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    user_id 업데이트할 사용자 기록의 Sys_id입니다.
    표 80. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 81. 요청 본문 매개변수(JSON)
    이름 설명
    active 관련된 사용자가 인스턴스 내에서 활성 상태인지 여부를 나타내는 플래그입니다 ServiceNow .
    가능한 값:
    • true: 사용자가 활성 상태입니다.
    • false: 사용자가 비활성 상태입니다.

    데이터 유형: 부울
    addresses 사용자의 현재 우편 주소에 대한 세부 정보입니다.

    데이터 유형: 객체

    "addresses": {
  "country": "String",
  "locality": "String",
  "postalCode": "String",
  "region": "String",
  "streetAddress": "String",
  "type": "String"
}
    주소.국가 국가 이름입니다.

    데이터 유형: 문자열
    주소.구/군/시 도시 또는 지역 이름입니다.

    데이터 유형: 문자열
    addresses.postalCode 우편 번호.

    데이터 유형: 문자열
    주소.지역 주 또는 지역입니다.

    데이터 유형: 문자열
    주소.거리 주소 전체 주소. 여기에는 집 번호, 거리 이름, 사서함 및 여러 줄로 확장 된 거리 주소 정보가 포함될 수 있습니다.

    데이터 유형: 문자열
    주소.유형 주소 유형입니다. 현재는 홈만 지원합니다.

    데이터 유형: 문자열
    displayName 사용자 표시 이름입니다. 이 값은 필드를 연결하여 name 자동으로 생성됩니다.

    데이터 유형: 문자열
    이메일 사용자와 연결된 이메일 계정의 목록입니다.

    데이터 형식: 객체 배열

    "emails:" [
  {
    "type": "String",
    "value": "String"
  }
]
    emails.type 사용자 이메일 유형입니다. 현재는 "작업" 유형만 지원합니다.

    데이터 유형: 문자열
    emails.value 사용자의 이메일 주소입니다. 연결된 사용자의 고유 키입니다.

    데이터 유형: 문자열
    externalId 프로비저닝하는 엔터티에서 사용자에게 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    이름 사용자 이름 정보.

    데이터 유형: 객체

    "name": {
  "familyName": "String",
  "givenName": "String",
  "honorificPrefix": "String",
  "middleName": "String"
}
    name.familyName 사용자의 가족 또는 성입니다.

    데이터 유형: 문자열
    name.givenName (이름.givenName) 사용자의 이름 또는 이름입니다.

    데이터 유형: 문자열
    name.honorificPrefix 사용자의 존칭 또는 직함(예: Dr., Bishop 또는 Baron)입니다.

    데이터 유형: 문자열
    이름.중간 사용자의 중간 이름입니다.

    데이터 유형: 문자열
    phoneNumbers 사용자와 연결된 전화 번호 목록입니다.

    데이터 형식: 객체 배열

    "phoneNumbers": [
  {
    "type": "String",
    "value": "String"
  }
]
    phoneNumbers.type 전화 번호 유형입니다.

    가능한 값:

    • 홈
    • 모바일
    • 일하다

    데이터 유형: 문자열
    phoneNumbers.값 사용자의 전화 번호입니다.

    데이터 유형: 문자열
    preferredLanguage 사용자가 선호하는 말하기 및 쓰기 언어입니다.

    데이터 유형: 문자열
    시간대 사용자의 시간대입니다.

    데이터 유형: 문자열
    직위 CEO 또는 사장과 같은 사용자 직함입니다.

    데이터 유형: 문자열
    userName 필수 연결된 사용자의 고유한 사용자 이름입니다.

    데이터 유형: 문자열
    사용자 유형 사용자 유형입니다. 이 값은 조직과 사용자 관계를 식별하는 데 사용됩니다.
    이 값은 모든 값이 될 수 있지만 일반적인 값에는 다음이 포함될 수 있습니다.
    • 협력업체
    • 직원
    • 인턴
    • 임시 직원
    • 외부
    • 알 수 없음

    데이터 유형: 문자열
    확장된 스키마
    회사 사용자와 연결된 회사에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "value": "String"
}
    회사.가치 회사가 게시물에 포함된 경우 필수입니다. 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    비용 센터 사용자의 연결된 비용 센터에 대한 상세 정보입니다.

    데이터 유형: 객체

    "costCenter": {
  "value": "String"
}
    costCenter.value costCenter가 포스트에 포함된 경우 필수입니다. 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    부서 사용자의 연결된 부서에 대한 상세 정보입니다.

    데이터 유형: 객체

    "department": {
  "value": "String"
}
    부서.값 부서가 게시물에 포함된 경우 필수입니다. 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    employeeNumber 숫자 또는 영숫자 직원 번호입니다.

    데이터 유형: 문자열
    성별 사용자의 성별(예: 남성 또는 여성)입니다.

    데이터 유형: 문자열
    위치 사용자의 연결된 위치에 대한 세부 정보입니다.

    데이터 유형: 객체

    "location": {
  "value": "String"
}
    위치.값 위치가 게시물에 포함된 경우 필수입니다. 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    매니저 사용자와 연결된 관리자에 대한 세부정보입니다.

    데이터 유형: 객체

    "manager": {
  "value": "String"
}
    관리자.값 관리자가 게시물에 포함된 경우 필수입니다. 관리자 기록의 Sys_id입니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 82. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 83. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 84. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    409 사용자가 이미 있습니다. 매개변수는 userName 고유해야 합니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    active 관련된 사용자가 인스턴스 내에서 활성 상태인지 여부를 나타내는 플래그입니다 ServiceNow .
    가능한 값:
    • true: 사용자가 활성 상태입니다.
    • false: 사용자가 비활성 상태입니다.

    데이터 유형: 부울
    addresses 사용자의 현재 우편 주소에 대한 세부 정보입니다.

    데이터 유형: 객체

    "addresses": {
  "country": "String",
  "locality": "String",
  "postalCode": "String",
  "region": "String",
  "streetAddress": "String",
  "type": "String"
}
    주소.국가 국가 이름입니다.

    데이터 유형: 문자열
    주소.구/군/시 도시 또는 지역 이름입니다.

    데이터 유형: 문자열
    addresses.postalCode 우편 번호.

    데이터 유형: 문자열
    주소.지역 주 또는 지역입니다.

    데이터 유형: 문자열
    주소.거리 주소 전체 주소. 여기에는 집 번호, 거리 이름, 사서함 및 여러 줄로 확장 된 거리 주소 정보가 포함될 수 있습니다.

    데이터 유형: 문자열
    주소.유형 주소 유형입니다. 현재는 홈만 지원합니다.

    데이터 유형: 문자열
    displayName 사용자 표시 이름입니다. 이 값은 필드를 연결하여 name 자동으로 생성됩니다.

    데이터 유형: 문자열
    이메일 사용자와 연결된 이메일 계정의 목록입니다.

    데이터 형식: 객체 배열

    "emails:" [
  {
    "type": "String",
    "value": "String"
  }
]
    emails.type 사용자 이메일 유형입니다. 현재는 "작업" 유형만 지원합니다.

    데이터 유형: 문자열
    emails.value 사용자의 이메일 주소입니다. 연결된 사용자의 고유 키입니다.

    데이터 유형: 문자열
    오류 요청을 처리하는 동안 발생했을 수 있는 오류를 설명하는 응답입니다.

    데이터 유형: 객체

    "errors": {
  "details": "String",
  "schemas": "String",
  "scimType": "String",
  "status": "String"
}
    오류.세부 정보 요청 실패 이유에 대한 자세한 오류 메시지입니다.

    데이터 유형: 문자열
    오류.scimType SCIM 오류 상세 정보 키워드입니다.

    데이터 유형: 문자열
    오류.스키마 오류 응답을 처리하는 데 사용되는 SCIM 스키마의 URI입니다.

    데이터 형식: 문자열 배열
    오류.상태 오류 응답의 HTTP 상태 코드입니다.

    데이터 유형: 문자열
    externalId 프로비저닝하는 엔터티에서 사용자에게 할당한 고유 식별자입니다.

    데이터 유형: 문자열
    그룹 직접 구성원 자격, 중첩된 그룹 또는 동적으로 계산된 사용자를 속한 그룹 목록입니다.

    데이터 형식: 객체 배열

    "groups": [
  {
    "display": "String",
    "type": "String",
    "value": "String",
    "$ref": "String"
  }
]
    그룹.디스플레이 연결된 그룹의 이름입니다.

    데이터 유형: 문자열
    groups.type 직접 또는 간접과 같은 그룹 연결 유형입니다.

    데이터 유형: 문자열
    그룹.값 연결된 그룹 기록의 Sys_id입니다.

    데이터 유형: 문자열
    그룹.$ref 연결된 그룹의 URI입니다.

    데이터 유형: 문자열
    id 연결된 사용자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    메타 사용자와 관련된 메타데이터입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": String",
  "resourceType": String"
}
    meta.created입니다. 사용자 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 사용자 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 검색 중인 사용자의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 사용자의 자원 유형입니다.

    데이터 유형: 문자열
    이름 사용자 이름 정보.

    데이터 유형: 객체

    "name": {
  "familyName": "String",
  "givenName": "String",
  "honorificPrefix": "String",
  "middleName": "String"
}
    name.familyName 사용자의 가족 또는 성입니다.

    데이터 유형: 문자열
    name.givenName (이름.givenName) 사용자의 이름 또는 이름입니다.

    데이터 유형: 문자열
    name.honorificPrefix 사용자의 존칭 또는 직함(예: Dr., Bishop 또는 Baron)입니다.

    데이터 유형: 문자열
    이름.중간 사용자의 중간 이름입니다.

    데이터 유형: 문자열
    phoneNumbers 사용자와 연결된 전화 번호 목록입니다.

    데이터 형식: 객체 배열

    "phoneNumbers": [
  {
    "type": "String",
    "value": "String"
  }
]
    phoneNumbers.type 전화 번호 유형입니다.

    가능한 값:

    • 홈
    • 모바일
    • 일하다

    데이터 유형: 문자열
    phoneNumbers.값 사용자의 전화 번호입니다.

    데이터 유형: 문자열
    preferredLanguage 사용자가 선호하는 말하기 및 쓰기 언어입니다.

    데이터 유형: 문자열
    스키마 요청을 처리하는 데 사용되는 SCIM 사용자 스키마의 URI 목록입니다.

    데이터 형식: 문자열 배열
    시간대 사용자의 시간대입니다.

    데이터 유형: 문자열
    직위 CEO 또는 사장과 같은 사용자 직함입니다.

    데이터 유형: 문자열
    userName 연결된 사용자의 고유한 사용자 이름입니다.

    데이터 유형: 문자열
    사용자 유형 사용자 유형입니다. 이 값은 조직과 사용자 관계를 식별하는 데 사용됩니다.
    이 값은 모든 값이 될 수 있지만 일반적인 값에는 다음이 포함될 수 있습니다.
    • 협력업체
    • 직원
    • 인턴
    • 임시 직원
    • 외부
    • 알 수 없음

    데이터 유형: 문자열

    반환된 확장 매개변수

    이름 설명
    회사 사용자와 연결된 회사에 대한 상세 정보입니다.

    데이터 유형: 객체

    "company": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    회사.디스플레이 회사의 이름입니다.

    데이터 유형: 문자열
    회사.가치 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    회사.$ref 회사의 참조 URI입니다.

    데이터 유형: 문자열
    비용 센터 사용자의 연결된 비용 센터에 대한 상세 정보입니다.

    데이터 유형: 객체

    "costCenter": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    costCenter.display 비용 센터의 이름입니다.

    데이터 유형: 문자열
    costCenter.value 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    costCenter.$ref 비용 센터의 참조 URI입니다.

    데이터 유형: 문자열
    부서 사용자의 연결된 부서에 대한 상세 정보입니다.

    데이터 유형: 객체

    "department": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    부서.표시 부서 이름.

    데이터 유형: 문자열
    부서.값 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    부서.$ref 부서의 참조 URI입니다.

    데이터 유형: 문자열
    employeeNumber 숫자 또는 영숫자 직원 번호입니다.

    데이터 유형: 문자열
    성별 사용자의 성별(예: 남성 또는 여성)입니다.

    데이터 유형: 문자열
    위치 사용자의 연결된 위치에 대한 세부 정보입니다.

    데이터 유형: 객체

    "location": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    location.display (위치.표시) 위치 이름입니다.

    데이터 유형: 문자열
    위치.값 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    위치.$ref 위치에 대한 참조 URI입니다.

    데이터 유형: 문자열
    매니저 사용자와 연결된 관리자에 대한 세부정보입니다.

    데이터 유형: 객체

    "manager": {
  "display": "String",
  "value": "String",
  "$ref": "String"
}
    관리자.디스플레이 관리자의 이름입니다.

    데이터 유형: 문자열
    관리자.값 관리자 기록의 Sys_id입니다.

    데이터 유형: 문자열
    관리자.$ref 관리자의 참조 URI입니다.

    데이터 유형: 문자열

    PUT을 사용하여 사용자 정보를 업데이트하는 cURL 요청

    이 예제에서는 PUT 엔드포인트를 사용하여 기존 사용자의 정보를 업데이트하는 방법을 보여줍니다.

    curl -X PUT \
  https://instance-servicenow.com/api/now/scim/Users/cdfef423e0423010f8778ac6d674f5ae \
  -d '{
  "schemas": [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "123457",
  "userName": "john.Doe",
  "name": {
    "familyName": "Doe",
    "givenName": "John"
  },
  "title": "Sir",
  "preferredLanguage": "en",
  "timezone": "ET",
  "active": true,
  "emails": [
    {
      "value": "john.doe@abc.com",
      "display": null,
      "type": "work",
      "primary": true
    }
  ],
  "phoneNumbers": [
    {
      "value": "9977553312",
      "type": "mobile",
      "primary": true
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": {
    "gender": "Male",
    "employeeNumber" : "13453",
    "location" : {
      "value" : "0002c0a93790200044e0bfc8bcbe5df5"
    },
    "company" : {
      "value" : "81fd65ecac1d55eb42a426568fc87a63"
    },
    "costCenter" : {
      "value" : "7fb1cc99c0a80a6d30c04574d14c0acf"
    },
    "department" : {
      "value":"221db0edc611228401760aec06c9d929"
    }
  }
}'

    응답

    {
  "schemas": [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "b7c5015f778330102e8cc5179e5a9992",
  "externalId": "123457",
  "meta": {
    "resourceType": "User",
    "created": "2021-10-12T10:05:32Z",
    "lastModified": "2021-10-12T10:08:04Z",
    "location":
      "http://instance-servicenow.com/api/now/scim/Users/b7c5015f778330102e8cc5179e5a9992"
  },
  "userName": "john.doe",
  "name": {
    "familyName": "Doe",
    "givenName": "John"
  },
  "displayName": "John Doe",
  "title": "Sir",
  "preferredLanguage": "en",
  "timezone": "ET",
  "active": true,
  "emails": [
    {
      "value": "tony.stark@abc.com",
      "type": "work"
    }
  ],
  "phoneNumbers": [
    {
      "value": "9977553312",
      "type": "mobile"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": {
    "employeeNumber": "13453",
    "gender": "Male",
    "costCenter": {
      "value": "7fb1cc99c0a80a6d30c04574d14c0acf",
      "name": "Sales",
      "$ref":
       "http://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf"
    },
    "company": {
      "value": "81fd65ecac1d55eb42a426568fc87a63",
      "name": "ACME Japan",
      "$ref":
       "http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
    },
    "department": {
      "value": "221db0edc611228401760aec06c9d929",
      "name": "Sales",
      "$ref":
        "http://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929"
    },
    "manager": {
      "value": "7027fda8773230102e8cc5179e5a99ea",
      "displayName": "Jack Sparrow",
      "$ref":
        "http://instance-servicenow.com/api/now/scim/Users/7027fda8773230102e8cc5179e5a99ea"
    },
    "location": {
      "value": "0002c0a93790200044e0bfc8bcbe5df5",
      "name": "2-10-1 Yurakucho, Chiyoda-ku, Tokyo",
      "$ref":
        "http://instance-servicenow.com/api/now/scim/Locations/0002c0a93790200044e0bfc8bcbe5df5"
    }
  }
}

    SCIM - GET /scim/ResourceTypes

    연결된 ServiceNow 인스턴스에서 지원하는 모든 SCIM(System for Cross-domain Identity Management) 자원 유형에 대한 정보를 검색합니다.

    퍼블릭 엔드포인트이며 액세스하는 데 역할이 필요하지 않습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/ResourceTypes

    기본 URL: /api/now/scim/ResourceTypes

    지원되는 요청 매개변수

    표 85. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 86. 쿼리 매개변수
    이름 설명
    없음
    표 87. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 88. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 89. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 90. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    itemsPerPage 반환 결과에 반환된 기록 수입니다.

    데이터 유형: 숫자
    자원 사용 가능한 자원 유형의 목록입니다.

    데이터 형식: 객체 배열

    "Resources": [
  {
    "description": "String",
    "endpoint": "String",
    "id": "String",
    "meta": {Object},
    "name": "String",
    "schema": "String"
    "schemas": [Array],
    "schemaExtensions": [Array]
  }
]
    Resources.description 자원 유형에 대한 간략한 설명입니다.

    데이터 유형: 문자열
    Resources.endpoint 서비스 제공자의 기본 URL을 기준으로 하는 HTTP 주소 지정 가능 엔드포인트의 이름(예: "사용자")입니다.

    데이터 유형: 문자열
    Resources.id 자원의 고유 식별자입니다. GET /scim/ResourceType/{resource_id} 엔드포인트를 호출할 때 이 특성을 사용합니다.

    데이터 유형: 문자열
    리소스.메타 관련 자원을 자세히 설명하는 정보입니다.

    데이터 유형: 객체

    "metadata": {
  "location": "String",
  "resourceType": "String"
}
    Resources.meta.location 연결된 ServiceNow 인스턴스에 있는 연결된 자원 유형의 URI입니다.

    데이터 유형: 문자열
    Resources.meta.resourceType 항상 "ResourceType"입니다.

    데이터 유형: 문자열
    Resources.name 사용자 또는 그룹과 같은 자원 유형의 이름입니다.

    데이터 유형: 문자열
    Resources.schema 자원 유형의 기본/기본 스키마 URI입니다. 예: "urn:ietf:params:scim:schemas:core:2.0:User".

    데이터 유형: 문자열
    Resources.schemas /ResourceType 요청을 처리하는 데 사용되는 스키마입니다. 예: "urn:ietf:params:scim:schemas:core:2.0:ResourceType".

    데이터 유형: 문자열
    Resources.schemaExtensions 연결된 자원 유형에 적용되는 스키마 확장의 목록입니다. 예: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User".

    데이터 형식: Object 배열

    "schemaExtensions": {
  "required": Boolean,
  "schema": "String"
}
    Resources.schemaExtensions.required 자원 유형에 스키마 확장이 필요한지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 이 형식의 리소스에는 이 스키마 확장이 포함되어야 하며 이 스키마 확장에 필요한 대로 선언된 모든 특성도 포함되어야 합니다.
    • false: 이 형식의 리소스는 이 스키마 확장을 생략할 수 있습니다.

    데이터 유형: 부울
    Resources.schemaExtensions.schema 확장 스키마의 URI입니다. 예: "urn:ietf:params:scim:schemas:extension:servicenow: 2.0:User".

    데이터 유형: 문자열
    스키마 요청에 대한 목록 응답을 처리하는 데 사용되는 스키마입니다. 예: "urn:ietf:params:scim:api:messages:2.0:ListResponse"

    데이터 유형: 문자열
    startIndex 기록이 검색된 자원 테이블에 대한 1부터 시작하는 인덱스입니다.

    데이터 유형: 문자열
    totalResults 요청과 일치하는 총 기록 수입니다.

    데이터 유형: 숫자

    cURL 요청

    다음 예제에서는 인스턴스에서 지원하는 ServiceNow SCIM 리소스 종류를 가져오는 방법을 보여 줍니다.

    curl "https://instance-servicenow.com/api/now/scim/ResourceTypes \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":6,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"User",
      "name":"User",
      "description":"User Account",
      "endpoint":"/Users",
      "schema":"urn:ietf:params:scim:schemas:core:2.0:User",
      "schemaExtensions":[
        {
          "schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
          "required":false
        },
        {
          "schema":"urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
          "required":false
        }
      ],
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/User"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Group",
      "name":"Group",
      "description":"Group",
      "endpoint":"/Groups",
      "schema":"urn:ietf:params:scim:schemas:core:2.0:Group",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.service-now.com/api/now/scim/ResourceTypes/Group"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Company",
      "name":"Company",
      "description":"Company",
      "endpoint":"/Companies",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Company"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Department",
      "name":"Department",
      "description":"Department",
      "endpoint":"/Departments",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Department"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"CostCenter",
      "name":"CostCenter",
      "description":"CostCenter",
      "endpoint":"/CostCenters",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/CostCenter"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Location",
      "name":"Location",
      "description":"Location",
      "endpoint":"/Locations",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Location"
      }
    }
  ],
  "startIndex":1,
  "itemsPerPage":6
}

    SCIM - GET /scim/ResourceTypes/{ResourceName}

    지정된 SCIM(교차 도메인 ID 관리 시스템) 자원 유형에 대한 정보를 검색합니다.

    퍼블릭 엔드포인트이며 액세스하는 데 역할이 필요하지 않습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/ResourceTypes/{ResourceName}

    기본 URL: /api/now/scim/ResourceTypes/{ResourceName}

    지원되는 요청 매개변수

    표 91. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    리소스 이름 검색할 자원 유형의 고유 ID입니다.
    유효한 값은 다음과 같습니다.
    • 회사
    • CostCenter
    • 부서
    • 그룹
    • 위치
    • 사용자

    데이터 유형: 문자열
    표 92. 쿼리 매개변수
    이름 설명
    없음
    표 93. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 94. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 95. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 96. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    설명 자원 유형에 대한 간략한 설명입니다.

    데이터 유형: 문자열
    endpoint 서비스 제공자의 기본 URL을 기준으로 하는 HTTP 주소 지정 가능 엔드포인트의 이름(예: "회사")입니다.

    데이터 유형: 문자열
    id 자원의 고유 식별자입니다. GET /scim/ResourceType/{resource_id} 엔드포인트를 호출할 때 이 특성을 사용합니다.

    데이터 유형: 문자열
    메타 관련 자원을 자세히 설명하는 정보입니다.

    데이터 유형: 객체

    "metadata": {
  "location": "String",
  "resourceType": "String"
}
    meta.location입니다. 연결된 ServiceNow 인스턴스에 있는 연결된 자원 유형의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType 항상 "ResourceType"입니다.

    데이터 유형: 문자열
    이름 사용자 또는 그룹과 같은 자원 유형의 이름입니다.

    데이터 유형: 문자열
    schema 자원 유형의 기본/기본 스키마 URI입니다. 예: "urn:ietf:params:scim:schemas:core:2.0:User".

    데이터 유형: 문자열
    스키마 /ResourceType 요청을 처리하는 데 사용되는 스키마입니다. 예: "urn:ietf:params:scim:schemas:core:2.0:ResourceType".

    데이터 유형: 문자열
    schemaExtensions (스키마익스텐션) 연결된 자원 유형에 적용되는 스키마 확장의 목록입니다. 예: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User".

    데이터 형식: Object 배열

    "schemaExtensions": {
  "required": Boolean,
  "schema": "String"
}
    schemaExtensions.required 자원 유형에 스키마 확장이 필요한지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 이 형식의 리소스에는 이 스키마 확장이 포함되어야 하며 이 스키마 확장에 필요한 대로 선언된 모든 특성도 포함되어야 합니다.
    • false: 이 형식의 리소스는 이 스키마 확장을 생략할 수 있습니다.

    데이터 유형: 부울
    schemaExtensions.스키마 확장 스키마의 URI입니다. 예: "urn:ietf:params:scim:schemas:extension:servicenow: 2.0:User".

    데이터 유형: 문자열
    스키마 요청에 대한 목록 응답을 처리하는 데 사용되는 스키마입니다. 예: "urn:ietf:params:scim:api:messages:2.0:ListResponse"

    데이터 유형: 문자열

    cURL 요청

    다음 예제에서는 인스턴스에서 ServiceNow 사용자 SCIM 리소스 유형을 가져오는 방법을 보여 줍니다.

    curl "https://instance-servicenow.com/api/now/scim/ResourceTypes/"User" \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
  ],
  "id":"User",
  "name":"User",
  "description":"User Account",
  "endpoint":"/Users",
  "schema":"urn:ietf:params:scim:schemas:core:2.0:User",
  "schemaExtensions":[
    {
      "schema":"urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
      "required":false
    },
    {
      "schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
      "required":false
    }
  ],
  "meta":{
    "resourceType":"ResourceType",
    "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/User"
  }
}

    SCIM - GET /scim/스키마

    인스턴스에서 지원하는 모든 SCIM(System for Cross-domain Identity Management) 자원 스키마에 ServiceNow 대한 정보를 검색합니다. 이러한 스키마는 각 자원 유형에 사용할 수 있는 속성을 정의합니다.

    퍼블릭 엔드포인트이며 액세스하는 데 역할이 필요하지 않습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/schemas

    기본 URL: /api/now/scim/schemas

    지원되는 요청 매개변수

    표 97. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 98. 쿼리 매개변수
    이름 설명
    없음
    표 99. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 100. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 101. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 102. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    표준 RFC7643 반환 결과 메서드는 RFC7643 표준을 준수하는 결과를 반환합니다. 자세한 내용은 RFC7643 사양의 스키마 정의를 참조하십시오.

    cURL 요청

    다음 예제에서는 인스턴스에서 ServiceNow 지원하는 SCIM 스키마를 가져오는 방법을 보여 줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Schemas \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":8,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
      ],
      "id":"urn:ietf:params:scim:schemas:core:2.0:User",
      "name":"User",
      "description":"User Account",
      "attributes":[
        {
          "name":"active",
          "type":"boolean",
          "multiValued":false,
          "description":"A Boolean value indicating the User's administrative status.",
          "required":false,
          "caseExact":true,
          "mutability":"readWrite",
          "returned":"default",
          "uniqueness":"none"
        },
        {
          "name":"addresses",
          "type":"complex",
          "subAttributes":[
            {
              "name":"country",
              "type":"string",
              "multiValued":false,
              "description":"The country name component.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"formatted",
              "type":"string",
              "multiValued":false,
              "description":"The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"locality",
              "type":"string",
              "multiValued":false,
              "description":"The city or locality component.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"postalCode",
              "type":"string",
              "multiValued":false,
              "description":"The zipcode or postal code component.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"primary",
              "type":"boolean",
              "multiValued":false,
              "description":"A Boolean value indicating the 'primary' or 
                preferred attribute value for this attribute, e.g., the preferred address. 
                The primary attribute value 'true' MUST appear no more than once.",
              "required":false,
              "caseExact":true,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"region",
              "type":"string",
              "multiValued":false,
              "description":"The state or region component.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"streetAddress",
              "type":"string",
              "multiValued":false,
              "description":"The full street address component, which may include house number, 
                street name, PO BOX, and multi-line extended street address information. This 
                attribute MAY contain newlines.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"type",
              "type":"string",
              "multiValued":false,
              "description":"A label indicating the attribute's function; e.g., 'work' or 'home'.",
              "required":false,
              "canonicalValues":["other","work","home"],
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            }
          ],
          "multiValued":true,
          "description":"Physical mailing addresses for this User.",
          "required":false,
          "caseExact":true,
          "mutability":"readWrite",
          "returned":"default",
          "uniqueness":"none"
        },
.
.
.
      {
        "schemas":[
          "urn:ietf:params:scim:schemas:core:2.0:Schema"
        ],
        "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department",
        "name":"Department",
        "description":"Department",
        "attributes":[
          {
            "name":"name",
            "type":"string",
            "multiValued":false,
            "description":"The name of the department.",
            "required":false,
            "caseExact":false,
            "mutability":"readOnly",
            "returned":"default",
            "uniqueness":"none"
          }
        ],
        "meta":{
          "resourceType":"Schema",
          "location":"https://instance-servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department"
        }
      },
      {
        "schemas":[
          "urn:ietf:params:scim:schemas:core:2.0:Schema"
        ],
        "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter",
        "name":"CostCenter",
        "description":"CostCenter",
        "attributes":[
          {
            "name":"name",
            "type":"string",
            "multiValued":false,
            "description":"The name of the cost center.",
            "required":false,
            "caseExact":false,
            "mutability":"readOnly",
            "returned":"default",
            "uniqueness":"none"
          }
        ],
        "meta":
          {
            "resourceType":"Schema",
            "location":"https://instance.servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter"
         }
        },
        {
          "schemas":[
            "urn:ietf:params:scim:schemas:core:2.0:Schema"
          ],
        "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location",
        "name":"Location",
        "description":"Location",
        "attributes":[
          {
            "name":"name",
            "type":"string",
            "multiValued":false,
            "description":"The location name.",
            "required":false,
            "caseExact":false,
            "mutability":"readOnly",
            "returned":"default",
            "uniqueness":"none"
          }
        ],
        "meta":{
          "resourceType":"Schema",
          "location":"https://instance.servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"
        }
      }
    ],
    "startIndex":1,
  "itemsPerPage":8
}

    SCIM - GET /scim/Schemas/{SchemaName}

    인스턴스에서 지원하는 지정된 SCIM(System for Cross-domain Identity Management) 자원 스키마에 ServiceNow 대한 정보를 검색합니다. 이러한 스키마는 각 자원 유형에 사용할 수 있는 속성을 정의합니다.

    퍼블릭 엔드포인트이며 액세스하는 데 역할이 필요하지 않습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Schemas/{SchemaName}

    기본 URL: /api/now/scim/Schemas/{SchemaName}

    지원되는 요청 매개변수

    표 103. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    스키마 이름 반환할 자원 스키마의 URI입니다.
    유효한 값은 다음과 같습니다.
    • urn:ietf:params:scim:schemas:core:2.0:사용자
    • urn:ietf:params:scim:schemas:extension: enterprise:2.0:User
    • urn:ietf:params:scim:schemas:extension: servicenow:2.0:User
    • urn:ietf:params:scim:schemas:core:2.0:그룹
    • urn:ietf:params:scim:schemas:사용자 지정: servicenow:2.0:회사
    • urn:ietf:params:scim:schemas:custom: servicenow:2.0:부서
    • urn:ietf:params:scim:schemas:사용자 지정: servicenow:2.0:CostCenter
    • urn:ietf:params:scim:schemas:custom: servicenow:2.0:위치

    데이터 유형: 문자열
    표 104. 쿼리 매개변수
    이름 설명
    없음
    표 105. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 106. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 107. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 108. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    표준 RFC7643 반환 결과 메서드는 RFC7643 표준을 준수하는 결과를 반환합니다. 자세한 내용은 RFC7643 사양의 스키마 정의를 참조하십시오.

    cURL 요청

    다음 예제에서는 인스턴스에서 핵심 그룹 SCIM 스키마를 ServiceNow 가져오는 방법을 보여 줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Schemas/"urn:ietf:params:scim:schemas:core:2.0:Group" \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "id":"urn:ietf:params:scim:schemas:core:2.0:Group",
  "name":"Group",
  "description":"Group",
  "attributes":[
    {
      "name":"displayName",
      "type":"string",
      "multiValued":false,
      "description":"A human-readable name for the Group.",
      "required":true,
      "caseExact":false,
      "mutability":"readWrite",
      "returned":"default",
      "uniqueness":"none"
    },
    {
      "name":"members",
      "type":"complex",
      "subAttributes":[
        {
          "name":"display",
          "type":"string",
          "multiValued":false,
          "description":"A human readable name, primarily used for display purposes.",
          "required":false,
          "caseExact":false,
          "mutability":"immutable",
          "returned":"default",
          "uniqueness":"none"
        },
        {
          "name":"value",
          "type":"string",
          "multiValued":false,
          "description":"The identifier of a group member.",
          "required":true,
          "caseExact":false,
          "mutability":"immutable",
          "returned":"default",
          "uniqueness":"none"
        },
        {
          "name":"$ref",
          "type":"reference",
          "multiValued":false,
          "description":"The URI of the member resource.",
          "required":false,
          "caseExact":true,
          "mutability":"immutable",
          "returned":"default",
          "uniqueness":"none",
          "referenceTypes":["Group","User"]
        }
      ],
      "multiValued":true,
      "description":"A list of members of the Group.",
      "required":false,
      "caseExact":true,
      "mutability":"readWrite",
      "returned":"default",
      "uniqueness":"none"
    }
  ],
  "meta":{
    "resourceType":"Schema",
    "location":"https://instance-servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
  }
}

    SCIM - GET /scim/ServiceProviderConfig

    인스턴스 내에서 사용할 수 있는 SCIM(System for Cross-domain Identity Management) 엔드포인트의 서비스 역량, 구성, 스키마 및 자원 유형에 대한 정보를 가져오는 데 사용할 구성 메타데이터를 ServiceNow 반환합니다.

    퍼블릭 엔드포인트이며 액세스하는 데 역할이 필요하지 않습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/ServiceProviderConfig

    기본 URL: /api/now/scim/ServiceProviderConfig

    지원되는 요청 매개변수

    표 109. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 110. 쿼리 매개변수
    이름 설명
    없음
    표 111. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 112. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 113. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 114. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    표준 RFC7643 반환 결과 메서드는 RFC7643 표준을 준수하는 결과를 반환합니다. 자세한 내용은 RFC7643 사양의 서비스 공급자 구성 스키마 를 참조하세요.

    cURL 요청

    다음 예제에서는 인스턴스에 대한 SCIM 구성 메타데이터를 가져오는 방법을 보여 줍니다 ServiceNow .

    curl "https://instance-servicenow.com/api/now/scim/ServiceProviderConfig \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
  ],
  "patch": {
    "supported": true
  },
  "bulk": {
    "supported": false,
    "maxOperations": 0,
    "maxPayloadSize": 1000000
  },
  "filter": {
    "supported": true,
    "maxResults": 500
  },
  "changePassword": {
    "supported": false
  },
  "sort": {
    "supported": false
  },
  "etag": {
    "supported": false
  },
  "authenticationSchemes": [
    {
      "name": "OAuth 2.0 Bearer Token",
      "description": "The OAuth 2.0 Bearer Token Authentication scheme. OAuth
        enables clients to access protected resources by obtaining an access token, which is
        defined in RFC 6750 as \"a string representing an access authorization issued to the
        client\", rather than using the resource owner's credentials directly.",
      "specUri": "http://tools.ietf.org/html/rfc6750",
      "type": "oauthbearertoken",
      "primary": true
    }
  ]
}

    SCIM - GET /scim/Companies

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 회사 [core_company] 테이블에서 하나 이상의 회사 기록을 반환합니다.

    주:
    일치 항목을 반환하지 않는 쿼리는 0으로 설정된 성공(HTTP 상태 코드 200) totalResults 을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Companies

    기본 URL: /api/now/scim/companies

    지원되는 요청 매개변수

    표 115. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 116. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    카운트 반환할 기록 수입니다. 음수 값은 0으로 해석됩니다.

    데이터 유형: 숫자

    최대값: 500 - 이보다 큰 값은 잘못된 요청 오류를 발생시킵니다.

    기본값: 10
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    필터 반환 결과에 적용할 필터 식입니다. 필드 필터는 <field_name> <operator> <"value">로 표현됩니다. 유효한 연산자 목록은 RFC7644 참조하십시오.
    주:
    이 메서드에서는 NOT 연산자를 지원하지 않습니다.

    예를 들어 이름이 "Acme"로 시작하는 모든 회사를 필터링하려면 displayName SW "Acme"를 입력합니다.

    둘 이상의 필드 필터를 지정하려면 AND 피연산자를 사용하여 필터를 연결합니다. 예를 들어 이름이 "Acme"로 시작하고 2021년 10월 3일 이전에 마지막으로 수정된 모든 회사를 필터링하려면 displayName SW "Acme" AND meta.lastModified lt "2021-10-03T00:00:00Z"를 입력합니다. 닷워킹을 사용하여 중첩된 속성을 지정합니다.

    데이터 유형: 문자열

    기본값: 필터링 안 함
    정렬 기준 매개변수와 sortOrder 함께 지정해야 합니다. 반환 결과를 정렬할 필드입니다. 정렬은 대소문자를 구분하지 않습니다.

    매개변수 필터링 sortBy 에 사용할 수 있는 매개변수만 사용할 수 있습니다(허용되지 않는 경우 externalId ).

    null인 값의 경우:
    • 오름차순으로 정렬 - Null 값이 맨 위로 정렬됩니다.
    • sorted by descending - Null 값이 맨 아래로 정렬됩니다.

    데이터 유형: 문자열

    기본값: 정렬 안 함
    sortOrder 매개변수와 sortBy 함께 지정해야 합니다. sortBy 매개 변수가 반환 결과에 적용되는 순서입니다.
    유효한 값은 다음과 같습니다.
    • 오름차순
    • 내림차순

    데이터 유형: 문자열

    기본값: 오름차순
    startIndex 기록 검색을 시작할 테이블에 대한 1부터 시작하는 인덱스입니다. 예를 들어 이 매개 변수를 100 count 으로 설정하고 매개 변수를 20으로 설정하면 엔드포인트는 100에서 119까지의 레코드를 반환합니다.
    주:
    1보다 작게 설정된 값은 1로 해석됩니다.

    데이터 유형: 문자열

    기본값: 1
    표 117. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 118. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 119. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 120. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    itemsPerPage 반환 결과에 반환된 기록 수입니다.

    데이터 유형: 숫자
    자원 반환된 비용 센터 기록의 목록입니다.

    데이터 유형: 객체

    "Resources": {
  "id": "String",
  "meta": {Object},
  "name": "String",
  "schemas": "String"
}
    Resources.id 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    리소스.메타 회사 기록과 관련된 정보입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": "String",
  "resourcType": "String"
}
    Resources.meta.created 연결된 회사 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.lastModified 연결된 회사 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.location 연결된 회사 기록의 URI입니다.

    데이터 유형: 문자열
    Resources.meta.resourceType SCIM 자원 유형; 항상 회사.

    데이터 유형: 문자열
    Resources.name 회사 이름입니다.

    데이터 유형: 문자열
    Resources.schemas 요청을 처리할 때 사용되는 스키마입니다.

    데이터 유형: 문자열
    스키마 요청에 대한 목록 응답을 처리하는 데 사용되는 스키마입니다. 예: "urn:ietf:params:scim:api:messages:2.0:ListResponse"

    데이터 유형: 문자열
    startIndex 기록이 반환된 회사 [core_company] 테이블에 대한 1부터 시작하는 인덱스입니다.

    데이터 유형: 문자열
    totalResults 요청과 일치하는 총 기록 수입니다.

    데이터 유형: 숫자

    cURL 요청

    이 예에서는 처음 두 회사 기록을 검색하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Companies?count=2" \
--request GET \
--header "Accept:application/scim+json" \

    응답:

    {
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":182,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company"
      ],
      "id":"0c43af40c6112275011a4bd4c0143fbf",
      "meta":{
        "resourceType":"Company",
        "created":"2005-05-24T01:14:19Z",
        "lastModified":"2013-05-06T23:44:48Z",
        "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf"
      },
      "name":"ABC Company"
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company"
      ],
      "id":"0c43b088c6112275011a4bd46a4e6cc4",
      "meta":{
        "resourceType":"Company",
        "created":"2005-05-24T01:14:19Z",
        "lastModified":"2013-06-05T17:53:26Z",
        "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43b088c6112275011a4bd46a4e6cc4"
      },
      "name":"Acme Co"
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

    SCIM - GET /scim/Companies/{company_id}

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 회사 [core_company] 테이블에서 지정된 회사 기록을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Companies/{company_id}

    기본 URL: /api/now/scim/Groups/{company_id}

    지원되는 요청 매개변수

    표 121. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    company_id 반환할 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    표 122. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 123. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 124. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 125. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 126. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    id 회사 기록의 Sys_id입니다.

    데이터 유형: 문자열
    메타 회사 기록과 관련된 정보입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": "String",
  "resourcType": "String"
}
    meta.created입니다. 연결된 회사 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 연결된 회사 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 연결된 회사 기록의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 자원 유형; 항상 회사.

    데이터 유형: 문자열
    이름 회사 이름입니다.

    데이터 유형: 문자열
    스키마 요청을 처리할 때 사용되는 스키마입니다.

    데이터 유형: 문자열

    cURL 요청

    이 예시에서는 특정 회사 기록을 검색하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf" \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company"
  ],
  "id":"0c43af40c6112275011a4bd4c0143fbf",
  "meta":{
    "resourceType":"Company",
    "created":"2005-05-24T01:14:19Z",
    "lastModified":"2013-05-06T23:44:48Z",
    "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf"
  },
  "name":"ABC Company"
}

    SCIM - GET /scim/CostCenters

    SCIM(교차 도메인 ID 관리 시스템) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 비용 센터 [cmn_cost_center] 테이블에서 하나 이상의 비용 센터 기록을 반환합니다.

    주:
    일치 항목을 반환하지 않는 쿼리는 0으로 설정된 성공(HTTP 상태 코드 200) totalResults 을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/CostCenters

    기본 URL: /api/now/scim/CostCenters

    지원되는 요청 매개변수

    표 127. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 128. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    카운트 반환할 기록 수입니다. 음수 값은 0으로 해석됩니다.

    데이터 유형: 숫자

    최대값: 500 - 이보다 큰 값은 잘못된 요청 오류를 발생시킵니다.

    기본값: 10
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    필터 반환 결과에 적용할 필터 식입니다. 필드 필터는 <field_name> <operator> <"value">로 표현됩니다. 유효한 연산자 목록은 RFC7644 참조하십시오.
    주:
    이 메서드에서는 NOT 연산자를 지원하지 않습니다.

    예를 들어 이름이 "HR"로 시작하는 모든 비용 센터를 필터링하려면 displayName SW "HR"을 입력합니다.

    둘 이상의 필드 필터를 지정하려면 AND 피연산자를 사용하여 필터를 연결합니다. 예를 들어 이름이 "HR"로 시작하고 2021년 10월 3일 이전에 마지막으로 수정된 모든 비용 센터를 필터링하려면 displayName SW "HR" 및 meta.lastModified lt "2021-10-03T00:00:00Z"를 입력합니다. 닷워킹을 사용하여 중첩된 속성을 지정합니다.

    데이터 유형: 문자열

    기본값: 필터링 안 함
    정렬 기준 매개변수와 sortOrder 함께 지정해야 합니다. 반환 결과를 정렬할 필드입니다. 정렬은 대소문자를 구분하지 않습니다.

    매개변수 필터링 sortBy 에 사용할 수 있는 매개변수만 사용할 수 있습니다(허용되지 않는 경우 externalId ).

    null인 값의 경우:
    • 오름차순으로 정렬 - Null 값이 맨 위로 정렬됩니다.
    • sorted by descending - Null 값이 맨 아래로 정렬됩니다.

    데이터 유형: 문자열

    기본값: 정렬 안 함
    sortOrder 매개변수와 sortBy 함께 지정해야 합니다. sortBy 매개 변수가 반환 결과에 적용되는 순서입니다.
    유효한 값은 다음과 같습니다.
    • 오름차순
    • 내림차순

    데이터 유형: 문자열

    기본값: 오름차순
    startIndex 기록 검색을 시작할 테이블에 대한 1부터 시작하는 인덱스입니다. 예를 들어 이 매개 변수를 100 count 으로 설정하고 매개 변수를 20으로 설정하면 엔드포인트는 100에서 119까지의 레코드를 반환합니다.
    주:
    1보다 작게 설정된 값은 1로 해석됩니다.

    데이터 유형: 문자열

    기본값: 1
    표 129. 요청 본문 매개변수(SON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 130. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 131. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 132. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    itemsPerPage 반환 결과에 반환된 기록 수입니다.

    데이터 유형: 숫자
    자원 반환된 비용 센터 기록의 목록입니다.

    데이터 유형: 객체

    "Resources": {
  "id": "String",
  "meta": {Object},
  "name": "String",
  "schemas": "String"
}
    Resources.id 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    리소스.메타 비용 센터 기록과 관련된 정보입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": "String",
  "resourcType": "String"
}
    Resources.meta.created 연결된 비용 센터 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.lastModified 연결된 비용 센터 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.location 연결된 비용 센터 기록의 URI입니다.

    데이터 유형: 문자열
    Resources.meta.resourceType SCIM 자원 유형; 항상 CostCenter입니다.

    데이터 유형: 문자열
    Resources.name 비용 센터 이름입니다.

    데이터 유형: 문자열
    Resources.schemas 요청을 처리할 때 사용되는 스키마입니다.

    데이터 유형: 문자열
    스키마 요청에 대한 목록 응답을 처리하는 데 사용되는 스키마입니다. 예: "urn:ietf:params:scim:api:messages:2.0:ListResponse"

    데이터 유형: 문자열
    startIndex 기록이 반환된 비용 센터 [cmn_cost_center] 테이블에 대한 1부터 시작하는 인덱스입니다.

    데이터 유형: 문자열
    totalResults 요청과 일치하는 총 기록 수입니다.

    데이터 유형: 숫자

    cURL 요청

    이 예에서는 처음 두 개의 비용 센터 기록을 검색하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/CostCenters?count=2" \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":8,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter"
      ],
      "id":"7fb1cc99c0a80a6d30c04574d14c0acf",
      "meta":{
        "resourceType":"CostCenter",
        "created":"2012-01-19T21:02:39Z",
        "lastModified":"2012-02-25T23:06:36Z",
        "location":"https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf"
      },
      "name":"Sales"
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter"
      ],
      "id":"91e8bbf43710200044e0bfc8bcbe5daa",
      "meta":{
        "resourceType":"CostCenter",
        "created":"2012-02-18T04:40:24Z",
        "lastModified":"2012-02-25T23:05:58Z",
        "location":"https://instance-servicenow.com/api/now/scim/CostCenters/91e8bbf43710200044e0bfc8bcbe5daa"
      },
      "name":"Customer Support"
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

    SCIM - GET /scim/CostCenters/{cost_center_id}

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 비용 센터 [cmn_cost_center] 테이블에서 지정된 비용 센터 기록을 반환합니다.

    주:
    일치 항목을 반환하지 않는 쿼리는 0으로 설정된 성공(HTTP 상태 코드 200) totalResults 을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/CostCenters/{cost_center_id}

    기본 URL: /api/now/scim/CoostCenters/{cost_center_id}

    지원되는 요청 매개변수

    표 133. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    cost_center_id 반환할 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    표 134. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 135. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 136. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 137. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 138. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    id 비용 센터 기록의 Sys_id입니다.

    데이터 유형: 문자열
    메타 비용 센터 기록과 관련된 정보입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": "String",
  "resourcType": "String"
}
    meta.created입니다. 연결된 비용 센터 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 연결된 비용 센터 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 연결된 비용 센터 기록의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 자원 유형; 항상 CostCenter입니다.

    데이터 유형: 문자열
    이름 비용 센터 이름입니다.

    데이터 유형: 문자열
    스키마 요청을 처리할 때 사용되는 스키마입니다.

    데이터 유형: 문자열

    cURL 요청

    이 예에서는 특정 비용 센터 기록을 검색하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf" \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter"
  ],
  "id":"7fb1cc99c0a80a6d30c04574d14c0acf",
  "meta":{
    "resourceType":"CostCenter",
    "created":"2012-01-19T21:02:39Z",
    "lastModified":"2012-02-25T23:06:36Z",
    "location":"https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf"
  },
  "name":"Sales"
}

    SCIM - GET /scim/Departments

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 부서 [cmn_department] 테이블에서 하나 이상의 부서 기록을 반환합니다.

    주:
    일치 항목을 반환하지 않는 쿼리는 0으로 설정된 성공(HTTP 상태 코드 200) totalResults 을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Departments

    기본 URL: /api/now/scim/departments

    지원되는 요청 매개변수

    표 139. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 140. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    카운트 반환할 기록 수입니다. 음수 값은 0으로 해석됩니다.

    데이터 유형: 숫자

    최대값: 500 - 이보다 큰 값은 잘못된 요청 오류를 발생시킵니다.

    기본값: 10
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    필터 반환 결과에 적용할 필터 식입니다. 필드 필터는 <field_name> <operator> <"value">로 표현됩니다. 유효한 연산자 목록은 RFC7644 참조하십시오.
    주:
    이 메서드에서는 NOT 연산자를 지원하지 않습니다.

    예를 들어 이름이 "Engineer"로 시작하는 모든 부서를 필터링하려면 displayName SW "Engineer"를 입력합니다.

    둘 이상의 필드 필터를 지정하려면 AND 피연산자를 사용하여 필터를 연결합니다. 예를 들어 이름이 "Engineer"로 시작하고 2021년 10월 3일 이전에 마지막으로 수정된 모든 부서를 필터링하려면 displayName SW "Engineer" AND meta.lastModified lt "2021-10-03T00:00:00Z"를 입력합니다. 닷워킹을 사용하여 중첩된 속성을 지정합니다.

    데이터 유형: 문자열

    기본값: 필터링 안 함
    정렬 기준 매개변수와 sortOrder 함께 지정해야 합니다. 반환 결과를 정렬할 필드입니다. 정렬은 대소문자를 구분하지 않습니다.

    매개변수 필터링 sortBy 에 사용할 수 있는 매개변수만 사용할 수 있습니다(허용되지 않는 경우 externalId ).

    null인 값의 경우:
    • 오름차순으로 정렬 - Null 값이 맨 위로 정렬됩니다.
    • sorted by descending - Null 값이 맨 아래로 정렬됩니다.

    데이터 유형: 문자열

    기본값: 정렬 안 함
    sortOrder 매개변수와 sortBy 함께 지정해야 합니다. sortBy 매개 변수가 반환 결과에 적용되는 순서입니다.
    유효한 값은 다음과 같습니다.
    • 오름차순
    • 내림차순

    데이터 유형: 문자열

    기본값: 오름차순
    startIndex 기록 검색을 시작할 테이블에 대한 1부터 시작하는 인덱스입니다. 예를 들어 이 매개 변수를 100 count 으로 설정하고 매개 변수를 20으로 설정하면 엔드포인트는 100에서 119까지의 레코드를 반환합니다.
    주:
    1보다 작게 설정된 값은 1로 해석됩니다.

    데이터 유형: 문자열

    기본값: 1
    표 141. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 142. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 143. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 144. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    itemsPerPage 반환 결과에 반환된 기록 수입니다.

    데이터 유형: 숫자
    자원 반환된 부서 기록의 목록입니다.

    데이터 유형: 객체

    "Resources": {
  "id": "String",
  "meta": {Object},
  "name": "String",
  "schemas": "String"
}
    Resources.id 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    리소스.메타 부서 기록과 관련된 정보입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": "String",
  "resourcType": "String"
}
    Resources.meta.created 연결된 부서 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.lastModified 연결된 부서 기록을 마지막으로 수정한 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.location 연결된 부서 기록의 URI입니다.

    데이터 유형: 문자열
    Resources.meta.resourceType SCIM 자원 유형; 항상 부서.

    데이터 유형: 문자열
    Resources.name 부서 이름입니다.

    데이터 유형: 문자열
    Resources.schemas
    스키마
    startIndex 기록이 반환된 부서[cmn_department] 테이블에 대한 1부터 시작하는 인덱스입니다.

    데이터 유형: 문자열
    totalResults 요청과 일치하는 총 기록 수입니다.

    데이터 유형: 숫자

    cURL 요청

    이 예에서는 처음 두 부서 기록을 검색하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Departments?count=2" \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":7,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department"
      ],
      "id":"221db0edc611228401760aec06c9d929",
      "meta":{
        "resourceType":"Department",
        "created":"2006-01-31T20:18:24Z",
        "lastModified":"2012-02-18T07:01:40Z",
        "location":"https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929"
      },
      "name":"Sales"
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department"
      ],
      "id":"221f3db5c6112284009f4becd3039cc9",
      "meta":{
        "resourceType":"Department",
        "created":"2008-03-20T20:20:06Z",
        "lastModified":"2012-02-18T07:01:22Z",
        "location":"https://instance-servicenow.com/api/now/scim/Departments/221f3db5c6112284009f4becd3039cc9"
      },
      "name":"Development"
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

    SCIM - GET /scim/Departments/{deparment_id}

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 부서 [cmn_department] 테이블에서 지정된 부서 기록을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Departments/{department_id}

    기본 URL: /api/now/scim/Departments/{department_id}

    지원되는 요청 매개변수

    표 145. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    department_id 반환할 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    표 146. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 147. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 148. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 149. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 150. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    id 부서 기록의 Sys_id입니다.

    데이터 유형: 문자열
    메타 부서 기록과 관련된 정보입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": "String",
  "resourcType": "String"
}
    meta.created입니다. 연결된 부서 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 연결된 부서 기록을 마지막으로 수정한 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 연결된 부서 기록의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 자원 유형; 항상 부서.

    데이터 유형: 문자열
    이름 부서 이름입니다.

    데이터 유형: 문자열
    스키마 요청을 처리할 때 사용되는 스키마입니다.

    데이터 유형: 문자열

    cURL 요청

    이 예는 특정 부서 기록을 검색하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929" \
--request GET \
--header "Accept:application/scim+json" \

    응답:

    {
  "schemas":[
    "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department"
  ],
  "id":"221db0edc611228401760aec06c9d929",
  "meta":{
    "resourceType":"Department",
    "created":"2006-01-31T20:18:24Z",
    "lastModified":"2012-02-18T07:01:40Z",
    "location":"https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929"
  },
  "name":"Sales"
}

    SCIM - GET /scim/Locations

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스 내의 ServiceNow 위치 [cmn_location] 테이블에서 하나 이상의 위치 기록을 반환합니다.

    주:
    일치 항목을 반환하지 않는 쿼리는 0으로 설정된 성공(HTTP 상태 코드 200) totalResults 을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Locations

    기본 URL: /api/now/scim/locations

    지원되는 요청 매개변수

    표 151. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 152. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    카운트 반환할 기록 수입니다. 음수 값은 0으로 해석됩니다.

    데이터 유형: 숫자

    최대값: 500 - 이보다 큰 값은 잘못된 요청 오류를 발생시킵니다.

    기본값: 10
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    필터 반환 결과에 적용할 필터 식입니다. 필드 필터는 <field_name> <operator> <"value">로 표현됩니다. 유효한 연산자 목록은 RFC7644 참조하십시오.
    주:
    이 메서드에서는 NOT 연산자를 지원하지 않습니다.

    예를 들어 이름이 "Ch"로 시작하는 모든 위치를 필터링하려면 displayName SW "Ch"를 입력합니다.

    둘 이상의 필드 필터를 지정하려면 AND 피연산자를 사용하여 필터를 연결합니다. 예를 들어 이름이 "Ch"로 시작하고 2021년 10월 3일 이전에 마지막으로 수정된 모든 위치를 필터링하려면 displayName SW "Ch" AND meta.lastModified lt "2021-10-03T00:00:00Z"를 입력합니다. 닷워킹을 사용하여 중첩된 속성을 지정합니다.

    데이터 유형: 문자열

    기본값: 필터링 안 함
    정렬 기준 매개변수와 sortOrder 함께 지정해야 합니다. 반환 결과를 정렬할 필드입니다. 정렬은 대소문자를 구분하지 않습니다.

    매개변수 필터링 sortBy 에 사용할 수 있는 매개변수만 사용할 수 있습니다(허용되지 않는 경우 externalId ).

    null인 값의 경우:
    • 오름차순으로 정렬 - Null 값이 맨 위로 정렬됩니다.
    • sorted by descending - Null 값이 맨 아래로 정렬됩니다.

    데이터 유형: 문자열

    기본값: 정렬 안 함
    sortOrder 매개변수와 sortBy 함께 지정해야 합니다. sortBy 매개 변수가 반환 결과에 적용되는 순서입니다.
    유효한 값은 다음과 같습니다.
    • 오름차순
    • 내림차순

    데이터 유형: 문자열

    기본값: 오름차순
    startIndex 기록 검색을 시작할 테이블에 대한 1부터 시작하는 인덱스입니다. 예를 들어 이 매개 변수를 100 count 으로 설정하고 매개 변수를 20으로 설정하면 엔드포인트는 100에서 119까지의 레코드를 반환합니다.
    주:
    1보다 작게 설정된 값은 1로 해석됩니다.

    데이터 유형: 문자열

    기본값: 1
    표 153. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 154. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 155. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 156. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    itemsPerPage 반환 결과에 반환된 기록 수입니다.

    데이터 유형: 숫자
    자원 반환된 위치 기록의 목록입니다.

    데이터 유형: 객체

    "Resources": {
  "id": "String",
  "meta": {Object},
  "name": "String",
  "schemas": "String"
}
    Resources.id 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    리소스.메타 위치 기록과 관련된 정보입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": "String",
  "resourceType": "String"
}
    Resources.meta.created 연결된 위치 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.lastModified 연결된 위치 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    Resources.meta.location 연결된 위치 기록의 URI입니다.

    데이터 유형: 문자열
    Resources.meta.resourceType SCIM 자원 유형; 항상 위치.

    데이터 유형: 문자열
    Resources.name 위치 이름입니다.

    데이터 유형: 문자열
    Resources.schemas 요청을 처리할 때 사용되는 스키마입니다.

    데이터 유형: 문자열
    스키마 요청에 대한 목록 응답을 처리하는 데 사용되는 스키마입니다. 예: "urn:ietf:params:scim:api:messages:2.0:ListResponse"

    데이터 유형: 문자열
    startIndex 기록이 반환된 위치 [cmn_location] 테이블에 대한 1부터 시작하는 인덱스입니다.

    데이터 유형: 문자열
    totalResults 요청과 일치하는 총 기록 수입니다.

    데이터 유형: 숫자

    cURL 요청

    이 예제에서는 처음 두 회사 레코드를 검색하는 방법을 보여 줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Locations?count=2" \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":426,
  "Resources":[
    {
      "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"],
      "id":"0002c0a93790200044e0bfc8bcbe5df5",
      "meta":{
        "resourceType":"Location",
        "created":"2012-02-19T18:39:00Z",
        "lastModified":"2012-02-19T18:39:00Z",
        "location":"https://instance-servicenow.com/api/now/scim/Locations/0002c0a93790200044e0bfc8bcbe5df5"
      },
      "name":"2-10-1 Yurakucho, Chiyoda-ku, Tokyo"
    },
    {
      "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"],
      "id":"0594ed7437d0200044e0bfc8bcbe5df0",
      "meta":{
        "resourceType":"Location",
        "created":"2012-02-17T17:54:15Z",
        "lastModified":"2021-08-31T14:13:11Z",
        "location":"https://instance-servicenow.com/api/now/scim/Locations/0594ed7437d0200044e0bfc8bcbe5df0"
      },
      "name":"Colombia"
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

    SCIM - GET /scim/Locations/{location_id}

    SCIM(System for Cross-domain Identity Management) 프로토콜을 사용하여 인스턴스 내 ServiceNow 위치 [cmn_location] 테이블에서 지정된 위치 기록을 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/scim/Locations/{location_id}

    기본 URL: /api/now/scim/Locations/{location_id}

    지원되는 요청 매개변수

    표 157. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    location_id 반환할 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    표 158. 쿼리 매개변수
    이름 설명
    속성 응답에 반환할 쉼표로 구분된 필드 목록입니다. 다른 필드는 반환되지 않습니다.

    매개변수와 excludedAttributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 지정되지 않은 경우 excludedAttributes 모든 필드를 반환합니다.
    excludedAttributes (영문) 응답에서 반환된 기록에서 제외할 필드의 쉼표로 구분된 목록입니다. 다른 모든 필드가 반환됩니다.

    매개변수와 attributes 함께 사용할 수 없습니다.

    데이터 유형: 문자열

    기본값: 필드를 제외하지 않습니다.
    표 159. 요청 본문 매개변수(JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 160. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/scim+json.

    기본값: application/json
    표 161. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 162. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    • 및 excludedAttributes 쿼리 매개변수가 attributes 요청에 전달되지 않았는지 확인합니다.
    • 매개변수가 count 500보다 크지 않은지 확인합니다.
    • 모든 filter 매개변수가 유효한지 확인합니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    id 위치 기록의 Sys_id입니다.

    데이터 유형: 문자열
    메타 위치 기록과 관련된 정보입니다.

    데이터 유형: 객체

    "meta": {
  "created": "String",
  "lastModified": "String",
  "location": "String",
  "resourceType": "String"
}
    meta.created입니다. 연결된 위치 기록이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.lastModified 연결된 위치 기록이 마지막으로 수정된 날짜 및 시간입니다.

    데이터 유형: 문자열
    meta.location입니다. 연결된 위치 기록의 URI입니다.

    데이터 유형: 문자열
    meta.resourceType SCIM 자원 유형; 항상 위치.

    데이터 유형: 문자열
    이름 위치 이름입니다.

    데이터 유형: 문자열
    스키마 요청을 처리할 때 사용되는 스키마입니다.

    데이터 유형: 문자열

    cURL 요청

    이 예는 특정 위치 기록을 검색하는 방법을 보여줍니다.

    curl "https://instance-servicenow.com/api/now/scim/Locations/0c43af40c6112275011a4bd4c0143fbf" \
--request GET \
--header "Accept:application/scim+json" \

    응답

    {
  "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"],
  "id":"0594ed7437d0200044e0bfc8bcbe5df0",
  "meta":{
    "resourceType":"Location",
    "created":"2012-02-17T17:54:15Z",
    "lastModified":"2021-08-31T14:13:11Z",
    "location":"https://instance-servicenow.com/api/now/scim/Locations/0594ed7437d0200044e0bfc8bcbe5df0"
  },
  "name":"Colombia"
}