Directory API: 사용자 별칭

사용자 별칭 만들기

사용자의 별칭은 사용자의 기본 이메일 주소에서 사용하는 것과 동일한 사서함을 사용하는 보조 이메일 주소입니다. 사용자 별칭은 사용자의 기본 이메일 주소에서 사용하는 도메인과 다른 계정 도메인과 연결될 수 있습니다. 24시간 이내 (대부분 더 빨리)에 사용자는 이 주소로 전송된 이메일을 수신하기 시작합니다. API를 사용하려면 사용자 별칭을 만들기 전에 도메인의 소유권이 확인되어야 합니다. 별칭은 게스트 사용자에게 지원되지 않습니다.

사용자 별칭을 만들려면 다음 POST 요청을 사용하고 승인 요청에 설명된 승인을 포함합니다. userKey는 사용자의 기본 이메일 주소, 사용자 id 또는 사용자 별칭 이메일 중 하나일 수 있습니다. 요청 및 응답 속성은 API 참조를 확인하세요.

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

JSON 요청

다음 JSON 요청은 사용자 별칭을 만드는 샘플 요청을 보여줍니다. 사용자는 liz@example.com이고 별칭은 chica@example.com입니다.

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

요청 본문에는 새 별칭 정보가 포함됩니다.

{  
 "alias": "chica@example.com"
}

요청이 성공하면 HTTP 201 상태 코드가 반환됩니다. 응답에는 상태 코드와 함께 새 사용자 별칭의 속성이 반환됩니다.

사용자의 모든 별칭 가져오기

모든 도메인에서 사용자의 모든 별칭을 가져오려면 다음 GET 요청을 사용하고 승인 요청에 설명된 승인을 포함합니다. userKey는 사용자의 기본 이메일 주소, 사용자 id 또는 사용자 별칭 이메일 중 하나일 수 있습니다. 요청 및 응답 속성은 API 참조를 확인하세요.

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

예를 들어 이 요청 URI는 userKey, liz@example.com의 모든 별칭을 반환합니다.

GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

모든 사용자 별칭은 알파벳순으로 반환됩니다. '모든 별칭 가져오기' 응답에 사용되는 maxResults 쿼리 문자열 또는 페이지 나누기와 같은 페이지 크기는 없습니다.

JSON 응답

요청이 성공하면 HTTP 200 상태 코드가 반환됩니다. 응답에는 상태 코드와 함께 사용자의 별칭이 알파벳순으로 반환됩니다. 이러한 별칭 도메인은 계정의 기본 도메인과 기타 여러 도메인입니다.

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "chica@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "support@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "help@hr.example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "tickets@jumboinc.com"
 }
]
}

사용자 별칭 삭제

사용자 별칭을 삭제하려면 다음 DELETE 요청을 사용하고 승인 요청에 설명된 승인을 포함합니다. 별칭이 삭제되기까지 최대 24시간이 걸릴 수 있습니다. userKey는 사용자의 기본 이메일 주소, 사용자 id 또는 사용자 별칭 이메일 중 하나일 수 있습니다. 그리고 aliasId는 삭제되는 별칭의 이메일 주소입니다. 요청 및 응답 속성은 API 참조를 확인하세요.

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId

예를 들어 이 DELETE 요청은 userKey, liz@example.com의 chica@example.com 별칭을 삭제합니다.

DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

요청이 성공하면 HTTP 200 상태 코드가 반환됩니다.