GET/users/{userId}/calendar

대상 사용자의 기본 캘린더 공유 속성을 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

calendar
calendar.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/calendar

Path Parameters

ParameterTypeDescription
userId string 

대상 사용자 ID


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
calendarId string 

캘린더 ID


required 
calendarName string 

캘린더명


required
maxLength : 50 
members array (CalendarMember) 

사용자 목록


required
minItems : 0
uniqueItems : true 
description string 

캘린더 설명

 
isPublic boolean 

Default : false
공개 캘린더 여부를 나타내는 값

 
calendarEmail string 

캘린더 고유 이메일.
공유 캘린더에 약속 일정 생성 시 calendarEmail을 value로 하는 Organizer가 필요하다.
예)
"organizer": { "email": "{calendarEmail}" }

 
type string 

캘린더 타입


Allowed values : DOMAIN, INDIVIDUAL, GROUP, ORGUNIT, MESSAGE
readOnly : true 

CalendarMember

PropertyTypeDescription
id string 

user, group, orgunit unique id


required 
type string 

구성원 타입

  • USER: 개인 사용자
  • GROUP: 그룹
  • ORGUNIT: 조직

required
Allowed values : USER, GROUP, ORGUNIT 
role string 

구성원의 캘린더 권한

  • CALENDAR_EVENT_READ_WRITE: 캘린더 및 일정 관리
  • EVENT_READ_WRITE: 일정 관리
  • EVENT_READ: 일정 상세 정보 조회
  • EVENT_READ_FREE_BUSY: 일정의 일시만 조회

required
Allowed values : CALENDAR_EVENT_READ_WRITE, EVENT_READ_WRITE, EVENT_READ, EVENT_READ_FREE_BUSY 

Response Example

example

1{2  "calendarName": "calendar",3  "description": "memo",4  "members": [5    {6      "id": "member1@example.com",7      "type": "USER",8      "role": "CALENDAR_EVENT_READ_WRITE"9    },10    {11      "id": "member2@example.com",12      "type": "USER",13      "role": "EVENT_READ_WRITE"14    }15  ],16  "calendarEmail": "calendar-96b8-4c74-8277-7953e0b4604a@jp1-groups.example.com",17  "calendarId": "calendar-96b8-4c74-8277-7953e0b4604a",18  "isPublic": true,19  "type": "INDIVIDUAL"20}

HTTP 403

Forbidden

HTTP 404

Not Found