리소스: 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 ( |
필드 | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
사용자의 고유 ID입니다. 사용자 |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
사용자의 기본 이메일 주소입니다. 이 속성은 사용자 계정을 만들기 위한 요청에 필요합니다. |
||||||||||||||||||||||||||||||||||||||||||
password |
사용자 계정의 비밀번호를 저장합니다. 사용자의 비밀번호 값은 사용자 계정을 만들 때 필요합니다. 사용자 업데이트 시 선택사항이며 사용자가 계정 비밀번호를 업데이트하는 경우에만 제공되어야 합니다. 비밀번호 값은 API의 응답 본문에 반환되지 않습니다. |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
라운드가 접두사의 일부로 지정되는 경우 10,000 이하여야 합니다. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
출력 전용입니다. 최고 관리자 권한이 있는 사용자를 나타냅니다. |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
출력 전용입니다. 사용자가 위임된 관리자인지를 나타냅니다. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
출력 전용입니다. 사용자가 최초 로그인을 완료하고 서비스 약관에 동의한 경우 이 속성은 |
||||||||||||||||||||||||||||||||||||||||||
suspended |
사용자가 정지되었는지 여부를 나타냅니다. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
사용자가 다음 로그인 시 비밀번호를 변경해야 하는지 여부를 나타냅니다. 이 설정은 사용자가 서드 파티 ID 공급업체를 통해 로그인하는 경우에는 적용되지 않습니다. |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
|
||||||||||||||||||||||||||||||||||||||||||
name |
사용자의 성 및 읽기 전용 |
||||||||||||||||||||||||||||||||||||||||||
kind |
출력 전용입니다. API 리소스의 유형입니다. 사용자 리소스의 경우 값은 |
||||||||||||||||||||||||||||||||||||||||||
etag |
출력 전용입니다. 리소스의 eETag입니다. |
||||||||||||||||||||||||||||||||||||||||||
emails |
사용자의 이메일 주소 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
사용자의 외부 ID 목록(예: 직원 또는 네트워크 ID) 허용되는 최대 데이터 크기는 2KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
relations |
사용자와 다른 사용자의 관계 목록입니다. 이 필드에 허용되는 최대 데이터 크기는 2KB입니다. 자세한 내용은 사용자 계정 관리하기를 참고하세요.
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
출력 전용입니다. 사용자의 별칭 이메일 주소 목록입니다. |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
출력 전용입니다. 사용자의 Google 편지함이 생성되었는지 여부를 나타냅니다. 이 속성은 사용자에게 Gmail 라이선스가 할당된 경우에만 적용됩니다. |
||||||||||||||||||||||||||||||||||||||||||
customerId |
출력 전용입니다. 모든 계정 사용자를 검색하는 고객 ID입니다. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
사용자의 주소 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
사용자가 속한 조직의 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
출력 전용입니다. 사용자가 사용자 계정에 마지막으로 로그인한 시간입니다. 값은 ISO 8601 날짜 및 시간 형식입니다. 시간은 완전한 날짜에 |
||||||||||||||||||||||||||||||||||||||||||
phones |
사용자의 전화번호 목록입니다. 허용되는 최대 데이터 크기는 1KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
출력 전용입니다. 정지 시점에 관리자 또는 Google에 의해 사용자 계정이 정지된 이유가 있음 이 속성은 |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
출력 전용입니다. 사용자 프로필 사진의 URL입니다. URL은 임시 URL일 수도 있고 비공개 URL일 수도 있습니다. |
||||||||||||||||||||||||||||||||||||||||||
languages |
사용자의 언어 목록입니다. 허용되는 최대 데이터 크기는 1KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
사용자의 POSIX 계정 정보 목록입니다.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
출력 전용입니다. 사용자 계정이 생성된 시간입니다. 값은 ISO 8601 날짜 및 시간 형식입니다. 시간은 완전한 날짜에 |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
출력 전용입니다. 사용자가 수정할 수 없는 별칭 이메일 주소 목록입니다. 이러한 계정은 일반적으로 계정의 기본 도메인 또는 하위 도메인 외부에 있습니다. |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
SSH 공개 키 목록입니다.
|
||||||||||||||||||||||||||||||||||||||||||
notes |
중첩된 객체인 사용자를 위한 메모입니다.
|
||||||||||||||||||||||||||||||||||||||||||
websites |
사용자의 웹사이트 목록입니다.
|
||||||||||||||||||||||||||||||||||||||||||
locations |
사용자의 위치 목록입니다. 허용되는 최대 데이터 크기는 10KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
도메인에 연락처 공유 기능이 사용 설정된 경우 사용자 프로필이 Google Workspace 전체 주소록에 표시되는지 여부를 나타냅니다. 사용자 프로필 제외에 대한 자세한 내용은 관리 고객센터를 참고하세요. |
||||||||||||||||||||||||||||||||||||||||||
keywords |
사용자의 키워드 목록입니다. 허용되는 최대 데이터 크기는 1KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
출력 전용입니다. 사용자의 계정이 삭제된 시간입니다. 값은 ISO 8601 날짜 및 시간 형식입니다. 시간은 완전한 날짜에 |
||||||||||||||||||||||||||||||||||||||||||
gender |
사용자의 성별이 포함된 중첩된 객체입니다. 이 필드에 허용되는 최대 데이터 크기는 1KB입니다.
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
출력 전용입니다. 사용자 사진의 infoType (읽기 전용) |
||||||||||||||||||||||||||||||||||||||||||
ims |
사용자의 인스턴트 메신저 (IM) 계정. 사용자 계정은 여러 개의
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
사용자의 맞춤 입력란입니다. 키는
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
출력 전용입니다. 2단계 인증에 등록되어 있음 (읽기 전용) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
출력 전용입니다. 2단계 인증 시행 여부 (읽기 전용) |
||||||||||||||||||||||||||||||||||||||||||
archived |
사용자가 보관처리되었는지 여부를 나타냅니다. |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
사용자와 연결된 상위 조직의 전체 경로입니다. 상위 조직이 최상위 조직인 경우 슬래시 ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
사용자의 복구 이메일입니다. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
사용자의 복구 전화번호 전화번호는 더하기 기호 (+)로 시작하는 E.164 형식이어야 합니다. 예: +16506661212. |
UserName
JSON 표현 |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
필드 | |
---|---|
fullName |
성과 이름 값을 연결하여 형성된 사용자의 전체 이름입니다. |
familyName |
사용자의 성입니다. 사용자 계정을 만들 때 필요합니다. |
givenName |
사용자의 이름입니다. 사용자 계정을 만들 때 필요합니다. |
displayName |
사용자의 표시 이름 최대 256자(영문 기준)까지 입력할 수 있습니다. |
메서드 |
|
---|---|
|
사용자를 삭제합니다. |
|
사용자를 검색합니다. |
|
사용자를 만듭니다. |
|
삭제된 사용자 또는 도메인의 모든 사용자가 페이지로 나눈 목록을 검색합니다. |
|
사용자를 최고 관리자로 지정합니다. |
|
패치 시맨틱을 사용하여 사용자를 업데이트합니다. |
|
사용자를 모든 웹 및 기기 세션에서 로그아웃하고 로그인 쿠키를 재설정합니다. |
|
삭제된 사용자를 삭제 취소합니다. |
|
사용자를 업데이트합니다. |
|
사용자 목록의 변경사항을 감시합니다. |