REST Resource: customers.v2.Users

리소스: User

사용자의 SCIM 표현입니다.

JSON 표현

{ "schemas": [ string ], "emails": [ { object (Email) } ], "addresses": [ { object (Address) } ], "phoneNumbers": [ { object (Phone) } ], "groups": [ { object (GroupReference) } ], "id": string, "externalId": string, "meta": { object (Meta) }, "userName": string, "name": { object (Name) }, "displayName": string, "active": boolean, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { object (EnterpriseUserExtension) } }

필드
schemas[]	string 필수 항목입니다. 현재 JSON 구조에 있는 속성을 정의하는 SCIM 스키마의 네임스페이스를 나타내는 URI 목록입니다. 사용자 ResourceType에 대해 schema 및 schemaExtensions로 정의된 값만 포함해야 합니다.
emails[]	object (Email) 선택사항입니다. 사용자의 이메일 주소 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다. userName에 해당하는 이메일이 primary 하위 속성이 true로 설정된 상태로 이 목록에 자동으로 추가됩니다. 이 기본 이메일 항목은 읽기 전용이며 이 속성을 통해 수정할 수 없습니다.
addresses[]	object (Address) 선택사항입니다. 사용자의 실제 주소 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다.
phoneNumbers[]	object (Phone) 선택사항입니다. 사용자의 전화번호 목록입니다. 허용되는 최대 데이터 크기는 1KB입니다.
groups[]	object (GroupReference) 출력 전용입니다. 사용자가 직접 회원으로 속한 그룹 목록입니다. 최대 1, 000개의 그룹으로 잘립니다. 이 속성은 기본적으로 반환되지 않으며 attributes 쿼리 매개변수를 사용하여 요청해야 합니다. 이 속성을 읽으려면 고객 허용 목록이 필요합니다. 지원팀에 문의하여 사용 사례를 설명하고 액세스를 요청하세요.
id	string 식별자. 사용자의 고유 ID입니다. 속성 특성은 true인 caseExact, readOnly의 변경 가능성, always의 returned 특성입니다.
externalId	string 선택사항입니다. SCIM 사용자의 클라이언트 정의 식별자입니다. 이 필드는 대소문자를 구분하며 변경할 수 있습니다. 서버에서 고유성을 적용하지 않으므로 클라이언트가 고유성을 보장해야 합니다.
meta	object (Meta) 출력 전용입니다. 리소스 메타데이터가 포함된 복잡한 속성입니다. 모든 meta 하위 속성은 서비스 제공업체에서 할당하며 (mutability이 readOnly임) 이러한 모든 하위 속성의 returned 특성은 default입니다. 이 속성은 클라이언트에서 제공하는 경우 무시됩니다.
userName	string 필수 항목입니다. 사용자의 기본 이메일 주소입니다. 사용자의 고유 식별자로 사용됩니다.
name	object (Name) 필수 항목입니다. 사용자의 이름
displayName	string 선택사항입니다. 사용자의 표시 이름 제한: 256자(영문 기준)
active	boolean 선택사항입니다. 사용자의 계정 상태입니다 (false은 계정이 정지되었음을 의미함). 기본값: true
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	object (EnterpriseUserExtension) 선택사항입니다. SCIM 엔터프라이즈 사용자 확장 프로그램 속성입니다.

이름

사용자 이름의 SCIM 표현입니다.

JSON 표현
{ "familyName": string, "givenName": string }

필드
familyName	string 필수 항목입니다. 사용자의 성입니다.
givenName	string 필수 항목입니다. 사용자의 이름입니다.

이메일

사용자 이메일의 SCIM 표현입니다.

JSON 표현
{ "value": string, "type": string, "primary": boolean }

필드
value	string 필수 항목입니다. 사용자의 이메일 주소
type	string 이메일 계정 유형입니다. 유효한 값은 home, work, other입니다.
primary	boolean 출력 전용입니다. 사용자의 기본 이메일인지 여부를 나타냅니다. 이 값은 userName에 해당하는 이메일에 대해서만 true로 설정됩니다.

주소

사용자 주소의 SCIM 표현입니다.

JSON 표현
{ "formatted": string, "streetAddress": string, "locality": string, "region": string, "postalCode": string, "country": string, "type": string, "primary": boolean }

필드
formatted	string 표시할 형식의 전체 주소입니다.
streetAddress	string 상세 주소입니다.
locality	string 도시 또는 지역입니다.
region	string 지역 또는 주입니다.
postalCode	string 우편번호입니다.
country	string 국가입니다.
type	string 주소 유형입니다. 유효한 값은 home, work, other입니다.
primary	boolean 사용자의 기본 주소인지 여부를 나타냅니다.

전화

사용자 전화번호의 SCIM 표현입니다.

JSON 표현
{ "value": string, "type": string, "primary": boolean }

필드
value	string 필수 항목입니다. 전화번호입니다.
type	string 전화번호 유형입니다. 유효한 값은 home, work, mobile, fax, pager, other입니다.
primary	boolean 사용자의 기본 전화번호인지 여부를 나타냅니다.

EnterpriseUserExtension

SCIM 엔터프라이즈 사용자 확장 프로그램의 속성을 정의합니다. 이 확장 프로그램의 스키마 URN은 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User입니다. 자세한 내용은 RFC 7643 섹션 4.3을 참고하세요.

JSON 표현
{ "employeeNumber": string, "costCenter": string, "organization": string, "department": string }

필드
employeeNumber	string 선택사항입니다. 조직 내에서 사용자를 식별하는 데 사용되는 식별자입니다(일반적으로 조직에서 할당함).
costCenter	string 선택사항입니다. 사용자의 지출이 귀속되는 비용 센터의 식별자입니다.
organization	string 선택사항입니다. 사용자가 속한 조직의 이름입니다.
department	string 선택사항입니다. 부서 사용자가 속한 부서의 이름입니다(텍스트 형식).

GroupReference

사용자의 그룹 멤버십에 대한 SCIM 표현입니다.

JSON 표현
{ "value": string, "$ref": string, "type": string }

필드
value	string 출력 전용입니다. 그룹을 나타내는 SCIM 리소스의 id입니다.
$ref	string 출력 전용입니다. 그룹을 나타내는 SCIM 리소스의 URI입니다.
type	string 출력 전용입니다. 그룹 멤버십 유형입니다. 유효한 값은 direct, indirect입니다.

메서드
create	사용자를 만듭니다.
delete	사용자를 삭제합니다.
get	사용자를 가져옵니다.
list	사용자 목록을 가져옵니다.
patch	SCIM 패치 시맨틱스를 사용하여 사용자를 업데이트합니다.