REST Resource: users

리소스: User

Directory API를 사용하면 계정의 사용자, 사용자 별칭, 사용자 Google 프로필 사진을 만들고 관리할 수 있습니다. 일반적인 작업에 대한 자세한 내용은 사용자 계정 개발자 가이드 및 사용자 별칭 개발자 가이드를 참고하세요.

JSON 표현

{ "id": string, "primaryEmail": string, "password": value, "hashFunction": string, "isAdmin": boolean, "isDelegatedAdmin": boolean, "agreedToTerms": boolean, "suspended": boolean, "changePasswordAtNextLogin": boolean, "ipWhitelisted": boolean, "name": { object (UserName) }, "kind": string, "etag": string, "emails": value, "externalIds": value, "relations": value, "aliases": [ string ], "isMailboxSetup": boolean, "customerId": string, "addresses": value, "organizations": value, "lastLoginTime": string, "phones": value, "suspensionReason": string, "thumbnailPhotoUrl": string, "languages": value, "posixAccounts": value, "creationTime": string, "nonEditableAliases": [ string ], "sshPublicKeys": value, "notes": value, "websites": value, "locations": value, "includeInGlobalAddressList": boolean, "keywords": value, "deletionTime": string, "gender": value, "thumbnailPhotoEtag": string, "ims": value, "customSchemas": value, "isEnrolledIn2Sv": boolean, "isEnforcedIn2Sv": boolean, "archived": boolean, "orgUnitPath": string, "recoveryEmail": string, "recoveryPhone": string, "isGuestUser": boolean, "guestAccountInfo": { object (GuestAccountInfo) } }

필드
id	string 사용자의 고유 ID입니다. 사용자 id는 사용자 요청 URI의 userKey로 사용할 수 있습니다.
primaryEmail	string 사용자의 기본 이메일 주소입니다. 이 속성은 사용자 계정을 생성하는 요청에 필요합니다. primaryEmail은 고유해야 하며 다른 사용자의 별칭일 수 없습니다.
password	value (Value format) 사용자 계정의 비밀번호를 저장합니다. 사용자 계정을 만들 때는 사용자의 비밀번호 값이 필요합니다. 사용자를 업데이트할 때는 선택사항이며 사용자가 계정 비밀번호를 업데이트하는 경우에만 제공해야 합니다. 비밀번호 값은 API의 응답 본문에 반환되지 않습니다. 비밀번호는 ASCII 문자를 조합하여 만들 수 있으며 길이는 8~100자(영문 기준)여야 합니다. password 매개변수를 16진수 인코딩된 해시 값으로 전송하고 hashFunction를 적절하게 설정하는 것이 좋습니다. hashFunction이 지정된 경우 비밀번호는 유효한 해시 키여야 합니다.
hashFunction	string password 속성의 해시 형식을 저장합니다. 허용되는 hashFunction 값은 다음과 같습니다. MD5 - 간단한 16진수 인코딩 값을 허용합니다. SHA-1 - 간단한 16진수 인코딩 값을 허용합니다. crypt - C 암호화 라이브러리를 준수합니다. DES, MD5 (해시 접두사 $1$), SHA-256 (해시 접두사 $5$), SHA-512 (해시 접두사 $6$) 해시 알고리즘을 지원합니다. 라운드가 접두사의 일부로 지정된 경우 10,000 이하여야 합니다.
isAdmin	boolean 출력 전용입니다. 최고 관리자 권한이 있는 사용자를 나타냅니다. isAdmin 속성은 사용자를 관리자로 설정 작업 ( makeAdmin 메서드)에서만 수정할 수 있습니다. 사용자 insert 또는 update 메서드에서 수정하면 API 서비스에서 수정사항이 무시됩니다.
isDelegatedAdmin	boolean 출력 전용입니다. 사용자가 위임된 관리자인지 여부를 나타냅니다. 위임된 관리자는 API에서 지원되지만 사용자를 생성하거나 삭제 취소하거나 사용자를 관리자로 만들 수는 없습니다. 이러한 요청은 API 서비스에서 무시됩니다. 관리자의 역할과 권한은 관리 콘솔을 사용하여 할당됩니다.
agreedToTerms	boolean 출력 전용입니다. 이 속성은 사용자가 초기 로그인을 완료하고 서비스 약관에 동의한 경우 true입니다.
suspended	boolean 사용자가 정지되었는지 여부를 나타냅니다.
changePasswordAtNextLogin	boolean 사용자가 다음 로그인 시 비밀번호를 강제로 변경해야 하는지 여부를 나타냅니다. 사용자가 서드 파티 ID 공급업체를 통해 로그인하는 경우에는 이 설정이 적용되지 않습니다.
ipWhitelisted	boolean true인 경우 사용자 IP 주소에 지원 중단된 IP 주소 allowlist 구성이 적용됩니다.
name	object (UserName) 사용자의 이름과 성, 읽기 전용 fullName 값을 보유합니다. givenName 및 familyName 값의 최대 문자 수는 60입니다. 또한 이름 값은 유니코드/UTF-8 문자를 지원하며 공백, 영문자 (a~z), 숫자 (0~9), 대시 (-), 슬래시 (/), 마침표 (.)를 포함할 수 있습니다. 문자 사용 규칙에 대한 자세한 내용은 관리 도움말 센터를 참고하세요. 이 필드에 허용되는 최대 데이터 크기는 1KB입니다.
kind	string 출력 전용입니다. API 리소스의 유형입니다. Users 리소스의 경우 값은 admin#directory#user입니다.
etag	string 출력 전용입니다. 리소스의 ETag입니다.
emails	value (Value format) 사용자의 이메일 주소 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다. 필드 emails[].address string 사용자의 이메일 주소 이메일 ID 역할도 합니다. 이 값은 사용자의 기본 이메일 주소 또는 별칭일 수 있습니다. emails[].customType string 이메일 주소 type가 custom인 경우 이 속성에는 맞춤 값이 포함되며 설정해야 합니다. emails[].primary boolean 사용자의 기본 이메일인지 여부를 나타냅니다. 하나의 항목만 기본 항목으로 표시할 수 있습니다. emails[].type string 이메일 계정 유형입니다. custom로 설정된 경우 customType도 설정해야 합니다. 사용 가능한 값: custom, home, other, work
externalIds	value (Value format) 직원 ID 또는 네트워크 ID와 같은 사용자의 외부 ID 목록입니다. 허용되는 최대 데이터 크기는 2KB입니다. 필드 externalIds[].customType string 외부 ID type이 custom인 경우 이 속성은 맞춤 값을 포함하며 설정해야 합니다. externalIds[].type string 외부 ID 유형입니다. custom로 설정된 경우 customType도 설정해야 합니다. 사용 가능한 값: account, custom, customer, login_id, network, organization externalIds[].value string 외부 ID의 값입니다.
relations	value (Value format) 다른 사용자와의 사용자 관계 목록입니다. 이 필드에 허용되는 최대 데이터 크기는 2KB입니다. 자세한 내용은 사용자 계정 관리를 참고하세요. 필드 relations[].customType string 관계 type이 custom인 경우 이 속성에는 맞춤 값이 포함되며 설정해야 합니다. relations[].type string 관계 유형입니다. custom로 설정된 경우 customType도 설정해야 합니다. 사용 가능한 값: admin_assistant assistant brother child custom domestic_partner dotted_line_manager exec_assistant father friend manager mother parent partner referred_by relative sister spouse relations[].value string 사용자와 관련된 사람의 이메일 주소입니다.
aliases[]	string 출력 전용입니다. 사용자의 별칭 이메일 주소 목록입니다.
isMailboxSetup	boolean 출력 전용입니다. 사용자의 Google 편지함이 생성되었는지 여부를 나타냅니다. 이 속성은 사용자에게 Gmail 라이선스가 할당된 경우에만 적용됩니다.
customerId	string 출력 전용입니다. 모든 계정 사용자를 가져올 고객 ID입니다. 별칭 my_customer을 사용하여 계정의 customerId를 나타낼 수 있습니다. 리셀러 관리자는 재판매된 고객 계정의 customerId를 사용할 수 있습니다. customerId를 가져오려면 users.list 요청의 domain 매개변수에 계정의 기본 도메인을 사용하세요.
addresses	value (Value format) 사용자의 주소 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다. 필드 addresses[].country string 국가입니다. addresses[].countryCode string 국가 코드. ISO 3166-1 표준을 사용합니다. addresses[].customType string 주소 type가 custom인 경우 이 속성에는 맞춤 값이 포함되며 설정해야 합니다. addresses[].extendedAddress string 하위 지역을 포함하는 주소와 같은 확장 주소입니다. addresses[].formatted string 구조화되지 않은 전체 우편 주소입니다. 구조화된 주소 필드와 동기화되지 않습니다. 상세 주소, 사서함, 도시, 주/도, 우편번호, 국가/지역 속성이 포함됩니다. addresses[].locality string 주소의 도시입니다. addresses[].poBox string 사서함(있는 경우) addresses[].postalCode string 우편번호입니다(해당되는 경우). addresses[].primary boolean 사용자의 기본 주소인 경우 주소 목록에는 기본 주소 하나만 포함될 수 있습니다. addresses[].region string 약어로 된 주 또는 도입니다. addresses[].sourceIsStructured boolean 사용자가 제공한 주소의 형식이 지정되었는지 여부를 나타냅니다. 형식이 지정된 주소는 현재 지원되지 않습니다. addresses[].streetAddress string 상세 주소입니다(예: 1600 Amphitheatre Parkway). 문자열 내의 공백은 무시되지만 줄바꿈은 중요합니다. addresses[].type string 주소 유형입니다. custom로 설정된 경우 customType도 설정해야 합니다. 사용 가능한 값: custom, home, other, work
organizations	value (Value format) 사용자가 속한 조직 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다. 필드 organizations[].costCenter string 사용자 조직의 비용 센터입니다. organizations[].customType string 유형 값이 custom인 경우 이 속성에는 맞춤 유형이 포함됩니다. organizations[].department string 조직 내 부서(예: sales 또는 engineering)를 지정합니다. organizations[].description string 조직에 대한 설명입니다. organizations[].domain string 조직이 속한 도메인입니다. organizations[].fullTimeEquivalent integer 조직 내 정규직 상당 백분율 (100000 = 100%)입니다. organizations[].location string 조직의 실제 위치입니다. 정규화된 주소일 필요는 없습니다. organizations[].name string 조직의 이름입니다. organizations[].primary boolean 사용자의 기본 조직인지 여부를 나타냅니다. 사용자는 하나의 기본 조직만 가질 수 있습니다. organizations[].symbol string 조직의 텍스트 문자열 기호입니다. 예를 들어 Google의 텍스트 기호는 GOOG입니다. organizations[].title string 조직 내 사용자의 직책입니다. 예를 들면 member 또는 engineer입니다. organizations[].type string 조직 유형입니다. 허용되는 값: domain_only, school, unknown, work
lastLoginTime	string 출력 전용입니다. 사용자가 사용자 계정에 마지막으로 로그인한 시간입니다. 값은 ISO 8601 날짜 및 시간 형식입니다. 시간은 YYYY-MM-DDThh:mm:ssTZD 형식의 완전한 날짜와 시간, 분, 초입니다. 2010-04-05T17:30:04+01:00를 예로 들 수 있습니다.
phones	value (Value format) 사용자의 전화번호 목록입니다. 허용되는 최대 데이터 크기는 1KB입니다. 필드 phones[].customType string 전화번호 type이 custom인 경우 이 속성은 맞춤 값을 포함하며 설정해야 합니다. phones[].primary boolean true인 경우 사용자의 기본 전화번호입니다. 사용자는 기본 전화번호를 하나만 가질 수 있습니다. phones[].type string 전화번호 유형입니다. custom로 설정된 경우 customType도 설정해야 합니다. 허용되는 값: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager phones[].value string 사람이 읽을 수 있는 전화번호. 전화번호 형식은 어떤 형식이든 상관없습니다.
suspensionReason	string 출력 전용입니다. 사용 중지 시점에 관리자 또는 Google에 의해 사용자 계정이 사용 중지된 이유가 있습니다. 이 속성은 suspended 속성이 true인 경우에만 반환됩니다.
thumbnailPhotoUrl	string 출력 전용입니다. 사용자 프로필 사진의 URL입니다. URL이 임시적이거나 비공개일 수 있습니다.
languages	value (Value format) 사용자의 언어 목록입니다. 허용되는 최대 데이터 크기는 1KB입니다. 필드 languages[].customLanguage string 기타 언어 해당하는 ISO 639 언어 코드가 없는 경우 사용자가 자체 언어 이름을 제공할 수 있습니다. 이 값이 설정되면 languageCode를 설정할 수 없습니다. languages[].languageCode string 언어의 ISO 639 문자열 표현입니다. 지원되는 코드 목록은 언어 코드를 참고하세요. 지원되는 언어 집합 외의 유효한 언어 코드는 API에서 허용되지만 예기치 않은 동작이 발생할 수 있습니다. 잘못된 값은 SchemaException를 발생시킵니다. 이 값이 설정되면 customLanguage를 설정할 수 없습니다. languages[].preference string 선택사항입니다. 지정된 languageCode가 사용자의 기본 언어인지 여부를 제어합니다(있는 경우). customLanguage가 설정된 경우 이를 설정할 수 없습니다. 허용되는 값은 preferred 및 not_preferred입니다.
posixAccounts	value (Value format) 사용자의 POSIX 계정 정보 목록입니다. 필드 posixAccounts[].accountId string POSIX 계정 필드 식별자입니다. posixAccounts[].gecos string 이 계정의 GECOS (사용자 정보)입니다. posixAccounts[].gid unsigned long 기본 그룹 ID입니다. posixAccounts[].homeDirectory string 이 계정에 사용할 홈 디렉토리의 경로입니다. posixAccounts[].operatingSystemType string 이 계정의 운영체제 유형입니다. 사용 가능한 값: linux, unspecified, windows posixAccounts[].primary boolean SystemId 내에서 사용자의 기본 계정인 경우 posixAccounts[].shell string 이 계정의 로그인 셸 경로입니다. posixAccounts[].systemId string 계정 사용자 이름 또는 Uid가 적용되는 시스템 식별자입니다. posixAccounts[].uid unsigned long POSIX 규격 사용자 ID입니다. posixAccounts[].username string 계정의 사용자 이름입니다.
creationTime	string 출력 전용입니다. 사용자 계정이 생성된 시간입니다. 값은 ISO 8601 날짜 및 시간 형식입니다. 시간은 YYYY-MM-DDThh:mm:ssTZD 형식의 완전한 날짜와 시간, 분, 초입니다. 2010-04-05T17:30:04+01:00를 예로 들 수 있습니다.
nonEditableAliases[]	string 출력 전용입니다. 사용자의 수정 불가능한 별칭 이메일 주소 목록입니다. 일반적으로 계정의 기본 도메인 또는 하위 도메인 외부에 있습니다.
sshPublicKeys	value (Value format) SSH 공개 키 목록입니다. 필드 sshPublicKeys[].expirationTimeUsec long 에포크 후의 만료 시간(단위: 마이크로초)입니다. sshPublicKeys[].fingerprint string SSH 공개 키의 SHA-256 지문입니다. (읽기 전용) sshPublicKeys[].key string SSH 공개 키입니다.
notes	value (Value format) 사용자를 위한 메모(중첩 객체)입니다. 필드 notes.contentType string 메모의 콘텐츠 유형입니다(일반 텍스트 또는 HTML). 기본값은 일반 텍스트입니다. 사용 가능한 값: text_plain, text_html notes.value string 메모의 내용입니다.
websites	value (Value format) 사용자의 웹사이트 목록입니다. 필드 websites[].customType string 웹사이트 type가 custom인 경우 이 속성은 맞춤 값을 포함하며 설정해야 합니다. websites[].primary boolean true인 경우 사용자의 기본 웹사이트입니다. websites[].type string 웹사이트의 유형 또는 목적입니다. 예를 들어 웹사이트에 home 또는 blog 라벨을 지정할 수 있습니다. 또는 항목에 custom 유형이 있을 수 있습니다. custom로 설정된 경우 customType도 설정해야 합니다. 허용되는 값: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work websites[].value string 웹사이트의 URL입니다.
locations	value (Value format) 사용자 위치 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다. 필드 locations[].area string 텍스트 위치입니다. 위치를 간결하게 표시하는 데 가장 유용합니다. 예를 들면 Mountain View, CA 또는 Near Seattle입니다. locations[].buildingId string 건물 식별자입니다. locations[].customType string 위치 type가 custom인 경우 이 속성은 맞춤 값을 포함하며 설정해야 합니다. locations[].deskCode string 개별 데스크 위치의 가장 구체적인 텍스트 코드입니다. locations[].floorName string 층 이름/번호입니다. locations[].floorSection string 층 섹션 층 내에서 더 구체적인 위치입니다. 예를 들어 층이 A, B, C 섹션으로 나뉘는 경우 이 필드는 이러한 값 중 하나를 식별합니다. locations[].type string 위치 유형입니다. custom로 설정된 경우 customType도 설정해야 합니다. 허용되는 값: custom, default, desk
includeInGlobalAddressList	boolean 도메인에 연락처 공유 기능이 사용 설정된 경우 사용자의 프로필이 Google Workspace 전체 주소 목록에 표시되는지 여부를 나타냅니다. 사용자 프로필 제외에 대한 자세한 내용은 관리 고객센터를 참고하세요.
keywords	value (Value format) 사용자의 키워드 목록입니다. 허용되는 최대 데이터 크기는 1KB입니다. 필드 keywords[].customType string 키워드 type가 custom인 경우 이 속성에는 맞춤 값이 포함되며 설정해야 합니다. keywords[].type string 각 항목에는 해당 항목의 표준 유형을 나타내는 유형이 있을 수 있습니다. 예를 들어 키워드는 occupation 또는 outlook 유형일 수 있습니다. 표준 유형 외에도 항목에 custom 유형이 있을 수 있으며 원하는 이름을 지정할 수 있습니다. custom로 설정된 경우 customType도 설정해야 합니다. 사용 가능한 값: custom, mission, occupation, outlook keywords[].value string 키워드
deletionTime	string 출력 전용입니다. 사용자 계정이 삭제된 시간입니다. 값은 ISO 8601 날짜 및 시간 형식입니다. 시간은 YYYY-MM-DDThh:mm:ssTZD 형식의 완전한 날짜와 시간, 분, 초입니다. 예를 들면 2010-04-05T17:30:04+01:00입니다.
gender	value (Value format) 사용자의 성별이 포함된 중첩 객체입니다. 이 필드에 허용되는 최대 데이터 크기는 1KB입니다. 필드 gender.addressMeAs string 사람이 프로필 소유자를 지칭하는 올바른 방법을 포함하는 사람이 읽을 수 있는 문자열입니다(예: '그/그의' 또는 '그들/그들의'). gender.customGender string 맞춤 성별의 이름입니다. gender.type string 성별 유형입니다. 사용 가능한 값: female male other unknown
thumbnailPhotoEtag	string 출력 전용입니다. 사용자 사진의 ETag (읽기 전용)
ims	value (Value format) 사용자의 인스턴트 메신저 (IM) 계정입니다. 사용자 계정에는 ims 속성이 여러 개 있을 수 있지만 이러한 ims 속성 중 하나만 기본 IM 연락처가 될 수 있습니다. 필드 ims[].customProtocol string 프로토콜 값이 custom_protocol인 경우 이 속성은 맞춤 프로토콜의 문자열을 보유합니다. ims[].customType string IM type이 custom인 경우 이 속성에는 맞춤 값이 포함되며 설정해야 합니다. ims[].im string 사용자의 IM 네트워크 ID입니다. ims[].primary boolean 사용자의 기본 IM인 경우 IM 목록의 항목 중 하나만 true 값을 가질 수 있습니다. ims[].protocol string IM 프로토콜은 IM 네트워크를 식별합니다. 값은 맞춤 네트워크 또는 표준 네트워크일 수 있습니다. 사용 가능한 값: aim: AOL Instant Messenger 프로토콜 custom_protocol: 맞춤 IM 네트워크 프로토콜 gtalk: Google Talk 프로토콜 icq: ICQ 프로토콜 jabber: Jabber 프로토콜 msn: MSN Messenger 프로토콜 net_meeting: Net Meeting 프로토콜 qq: QQ 프로토콜 skype: Skype 프로토콜 yahoo: Yahoo Messenger 프로토콜 ims[].type string IM 계정 유형입니다. custom로 설정된 경우 customType도 설정해야 합니다. 사용 가능한 값: custom, home, other, work
customSchemas	value (Value format) 사용자의 맞춤 필드입니다. 키는 schemaName이고 값은 'fieldName': 'field_value'입니다. customSchemas.(key)는 중첩된 객체입니다. customSchemas.(key).(key)은 어떤 값이든 될 수 있습니다.
isEnrolledIn2Sv	boolean 출력 전용입니다. 2단계 인증에 등록되어 있음 (읽기 전용)
isEnforcedIn2Sv	boolean 출력 전용입니다. 2단계 인증이 시행되었는지 여부 (읽기 전용)
archived	boolean 사용자가 보관처리되었는지 여부를 나타냅니다.
orgUnitPath	string 사용자와 연결된 상위 조직의 전체 경로입니다. 상위 조직이 최상위 조직인 경우 슬래시 (/)로 표시됩니다.
recoveryEmail	string 사용자의 복구 이메일입니다.
recoveryPhone	string 사용자의 복구 전화번호입니다. 전화번호는 더하기 기호 (+)로 시작하는 E.164 형식이어야 합니다. 예: [phone]
isGuestUser	boolean 변경할 수 없습니다. 사용자가 게스트인지 여부를 나타냅니다.
guestAccountInfo	object (GuestAccountInfo) 변경할 수 없습니다. 추가 게스트 관련 메타데이터 필드

사용자 이름

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

필드
fullName	string 이름과 성 값을 연결하여 형성된 사용자의 전체 이름입니다.
familyName	string 사용자의 성입니다. 사용자 계정을 만들 때 필요합니다.
givenName	string 사용자의 이름입니다. 사용자 계정을 만들 때 필요합니다.
displayName	string 사용자의 표시 이름입니다. 제한: 256자(영문 기준)

GuestAccountInfo

게스트 사용자에게만 적용되는 계정 정보입니다.

JSON 표현
{ "primaryGuestEmail": string }

필드
primaryGuestEmail	string 변경할 수 없습니다. 게스트의 외부 이메일입니다.

메서드
createGuest	Workspace 기능의 일부에 액세스할 수 있는 게스트 사용자를 만듭니다.
delete	사용자를 삭제합니다.
get	사용자를 가져옵니다.
insert	사용자를 만듭니다.
list	도메인에서 삭제된 사용자 또는 모든 사용자의 페이지로 구분된 목록을 가져옵니다.
makeAdmin	사용자를 최고 관리자로 지정합니다.
patch	패치 시맨틱스를 사용하여 사용자를 업데이트합니다.
signOut	모든 웹 및 기기 세션에서 사용자를 로그아웃하고 로그인 쿠키를 재설정합니다.
undelete	삭제된 사용자를 삭제 취소합니다.
update	사용자를 업데이트합니다.
watch	사용자 목록의 변경사항을 감시합니다.