REST Resource: customers.v2.Schemas

리소스: Schema

RFC 7643 섹션 7에서 발췌. 스키마에 관한 메타데이터를 지정합니다.

JSON 표현 
{
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "id": string,
  "name": string,
  "description": string
}
필드
attributes[]

object (Attribute)

필수 항목입니다. 스키마의 속성 목록입니다.
id

string

필수 항목입니다. 스키마의 고유 URI입니다. 해당하는 경우 서비스 제공업체는 URI(예: urn:ietf:params:scim:schemas:core:2.0:User)를 지정해야 합니다. id에 일종의 전역적으로 고유한 식별자 (GUID)를 사용하는 대부분의 다른 스키마와 달리 스키마 id는 URI이므로 등록할 수 있고 여러 서비스 제공업체와 클라이언트 간에 이동할 수 있습니다.
name

string

선택사항입니다. 스키마의 사람이 읽을 수 있는 이름입니다. 해당하는 경우 서비스 제공업체는 이름(예: User 또는 Group)을 지정해야 합니다.
description

string

선택사항입니다. 스키마의 사람이 읽을 수 있는 설명입니다. 해당하는 경우 서비스 제공업체는 설명을 지정해야 합니다.

속성

RFC 7643 섹션 7에서 발췌. 속성의 특성을 정의합니다.

JSON 표현 
{
  "subAttributes": [
    {
      object (Attribute)
    }
  ],
  "canonicalValues": [
    string
  ],
  "referenceTypes": [
    string
  ],
  "name": string,
  "type": string,
  "multiValued": boolean,
  "description": string,
  "required": boolean,
  "caseExact": boolean,
  "mutability": string,
  "returned": string,
  "uniqueness": string
}
필드
subAttributes[]

object (Attribute)

속성이 complex 유형인 경우 subAttributes는 하위 속성 집합을 정의합니다. subAttributes는 attributes와 동일한 스키마 하위 속성을 갖습니다.
canonicalValues[]

string

선택사항입니다. 사용할 수 있는 제안된 정식 값 모음입니다 (예: work 및 home). 경우에 따라 서비스 제공업체는 지원되지 않는 값을 무시할 수 있습니다.
referenceTypes[]

string

참조할 수 있는 SCIM 리소스 유형을 나타내는 JSON 문자열의 다중 값 배열입니다. 유효한 값은 다음과 같습니다.

  • SCIM 리소스 유형 (예: User 또는 Group),
  • external - 리소스가 외부 리소스 (예: 사진)임을 나타내거나
  • uri - 참조가 서비스 엔드포인트 또는 식별자 (예: 스키마 URN)임을 나타냅니다.

이 속성은 reference 유형의 속성에만 적용됩니다 (섹션 2.3.7).
name

string

속성의 이름입니다.
type

string

속성의 데이터 유형입니다. 유효한 값은 string, boolean, decimal, integer, dateTime, reference, complex입니다. 속성이 complex 유형인 경우 속성의 하위 속성을 나열하는 해당 스키마 속성 subAttributes가 정의되어야 합니다.
multiValued

boolean

속성의 복수형을 나타냅니다.
description

string

속성의 사람이 읽을 수 있는 설명입니다. 해당하는 경우 서비스 제공업체는 설명을 지정해야 합니다.
required

boolean

속성이 필수인지 여부를 지정합니다.
caseExact

boolean

문자열 속성이 대소문자를 구분하는지 여부를 지정합니다. 서버는 필터를 평가할 때 대소문자 구분을 사용합니다. 대소문자를 구분하는 속성의 경우 서버는 제출된 모든 값의 대소문자를 유지합니다. 속성이 대소문자를 구분하지 않는 경우 서버는 제출된 값의 대소문자를 변경할 수 있습니다. 대소문자 구분은 속성 값을 필터 값과 비교하는 방식에도 영향을 미칩니다 (RFC 7644 섹션 3.4.2.2 참고).

RFC 7643 섹션 2.3.6 및 RFC 7643 섹션 2.3.7에 따라 binary 및 reference 유형은 caseExact입니다.
mutability

string

속성 값을 (재)정의할 수 있는 상황을 나타내는 단일 키워드입니다.

  • readOnly: 속성을 수정할 수 없습니다.
  • readWrite: 기본값입니다. 속성은 언제든지 업데이트하고 읽을 수 있습니다.
  • immutable: 리소스 생성 시 (예: POST) 또는 요청을 통한 레코드 대체 시 (예: PUT) 속성을 정의할 수 있습니다. 속성은 초기 정의 후에는 수정할 수 없습니다.
  • writeOnly: 속성은 언제든지 업데이트할 수 있습니다. 속성 값은 반환되지 않습니다 (예: 값이 저장된 해시이기 때문). 참고: mutability가 writeOnly인 속성은 일반적으로 never의 반환 설정도 있습니다.
returned

string

GET 요청에 대한 응답 또는 PUT, POST 또는 PATCH 요청에 대한 응답으로 속성 및 연결된 값이 반환되는 시점을 나타내는 단일 키워드입니다. 유효한 키워드는 다음과 같습니다.

  • always: attributes 매개변수의 콘텐츠와 관계없이 속성이 항상 반환됩니다. 예를 들어 id는 SCIM 리소스를 식별하기 위해 항상 반환됩니다.
  • never: 속성이 반환되지 않습니다. 이는 서비스 제공업체가 원래 속성 값 (예: 해시된 값)을 보관하지 않기 때문에 발생할 수 있습니다. 서비스 제공업체는 속성을 검색 필터에 사용할 수 있도록 허용할 수 있습니다.
  • default: 기본값입니다. 속성 값이 반환되는 모든 SCIM 작업 응답에서 속성이 기본적으로 반환됩니다. GET 요청 attributes 매개변수가 지정된 경우 속성 값은 속성이 attributes 매개변수에 이름 지정된 경우에만 반환됩니다.
  • request: 속성이 클라이언트에 의해 지정된 경우 (예: 속성이 수정됨) PUT, POST 또는 PATCH 작업에 대한 응답으로 속성이 반환됩니다. 속성은 SCIM 쿼리 작업에서 attributes 매개변수에 지정된 경우에만 반환됩니다.
uniqueness

string

서비스 제공업체가 속성 값의 고유성을 적용하는 방법을 지정하는 단일 키워드 값입니다. 서버는 HTTP 응답 코드 400 Bad Request를 반환하여 고유성을 기반으로 잘못된 값을 거부할 수 있습니다. 클라이언트는 서비스 제공업체가 적용하는 것보다 더 높은 수준으로 클라이언트 측에서 고유성을 적용할 수 있습니다. 예를 들어 클라이언트는 값이 고유하게 만들 수 있지만 서버는 고유성이 none입니다. 유효한 키워드는 다음과 같습니다.

  • none: 기본값입니다. 값은 어떤 방식으로든 고유하지 않습니다.
  • server: 값은 현재 SCIM 엔드포인트 (또는 테넌시)의 컨텍스트 내에서 고유해야 하며 전역적으로 고유할 수 있습니다 (예: 사용자 이름, 이메일 주소 또는 기타 서버 생성 키 또는 카운터). 동일한 서버의 두 리소스가 동일한 값을 가져서는 안 됩니다.
  • global: 값은 전역적으로 고유해야 합니다 (예: 이메일 주소, GUID 또는 기타 값). 어떤 서버의 두 리소스도 동일한 값을 가져서는 안 됩니다.

RFC 7643 섹션 2.3에 지정된 대로 Boolean, DateTime, Binary, Complex 데이터 유형에는 고유성이 없습니다.

메서드

get

 스키마를 검색합니다.

list

 모든 스키마를 검색합니다.