사용자 일괄 동기화(추가/수정/삭제)

POST https://openapi.exosp.com/organization/v1/member/sync-batch

사용자 정보를 일괄 동기화하는 API 입니다.

• 추가(Create)

  • 보내준 항목의 식별자가 없거나, 서버에서 찾을 수 없으면 새 항목을 만들어 넣습니다.

• 수정(Update)

  • 보내준 항목의 식별자(id 등)가 서버에 이미 있으면, 그 항목의 값을 최신 내용으로 바꿉니다.

• 삭제(Delete)

  • 서버에는 있는데 이번 요청 목록에 포함되지 않은 항목은 더 이상 필요하지 않은 것으로 보고 삭제합니다.

Request Body

항목	타입	설명
memberList*	array	MemberList
sendInstallationMail*	string	설치 메일 발송 여부(Y/N)

MemberList

항목	타입	설명
name*	string	사용자 이름
email*	string	사용자 메일
departmentFull*	string	그룹 전체 경로
isNotEmailTypeValid	string	아이디에 대한 이메일 형태 체크여부(Y: 유효성 체크함, N: 체크 안함)

Response Schema

항목	타입	설명
code	int	응답 처리 결과 코드 0 : 성공, 1 : 실패
message	string	응답 처리 결과 메세지 success : 성공, 그 외 : 실패
body	object	body 상세

body 상세

항목	타입	설명
summary	array	summary 상세
insertMemberDetail	array	member 상세
updateMemberDetail	array	member 상세
deleteMemberDetail	array	member 상세

summary 상세

항목	타입	설명
totalMember	int	총 사용자 수
originMember	int	기존 사용자 수
insertMember	int	추가 사용자 수
updateMember	int	수정 사용자 수
deleteMember	int	삭제 사용자 수

member 상세

항목	타입	설명
email	string	사용자 메일
success	string	성공 여부
message	string	오류 메세지

Example

200 Success

curl -X 'POST' \
  'https://openapi.exosp.com/organization/v1/member' \
  -H 'accept: application/json' \
  -H 'x-exosp-access: YOUR_ACCESS_KEY' \
  -H 'x-exosp-secret: YOUR_ACCESS_SECRET' 
  -d '{
  "memberList": [
    {
      "name": "ysmoon",
      "email": "[email protected]",
      "departmentFull": "dev-ys",
      "isNotEmailTypeValid": "N"
    },
    {
      "name": "test",
      "email": "[email protected]",
      "departmentFull": "dev-ys",
      "isNotEmailTypeValid": "N"
    }
  ],
  "sendInstallationMail": "N"
}'
 
{
  "code": 0,
  "message": "success",
  "body": {
    "summary": {
      "totalMember": 2,
      "originMember": 2,
      "insertMember": 1,
      "updateMember": 0,
      "deleteMember": 0
    },
    "insertMemberDetail": [
      {
        "email": "[email protected]",
        "name": "test",
        "success": true
      }
    ],
    "updateMemberDetail": [],
    "deleteMemberDetail": [
      {
        "email": "[email protected]",
        "success": false,
        "error": "Cannot delete member with manager role"
      }
    ]
  }
}

Untitled