사용자 생성

싸인투게더의 사용자를 등록합니다.

API 사용이 가능하더라도 기본적으로는 사용할 수 없으며, 싸인투게더 운영팀에 소통하신 후 권한을 부여 받으신 후에 사용 가능합니다.

API 계정 그룹의 권한에 따라 해당 그룹 및 하위 그룹의 사용자만 등록 가능합니다.

사용자 생성

POST /rest/api/user

파라미터는 파라미터 셋을 배열로 받아 다중으로 요청이 가능합니다.

1개의 세트만 처리하고 싶은 경우 배열에 1개의 파라미터 셋만 세팅하여 전달해주면 됩니다.

Headers

Name	Type	Description
apiKey*	String	apiKey

Request Body

Name	Type	Description
groupId*	Number	사용자가 소속된 그룹 Id
userName*	String	사용자의 이름
loginId*	String	사용자의 로그인 Id
privateEmail*	String	사용자의 email
phoneNumber	String	사용자의 휴대전화 번호
password*	String	사용자의 로그인 암호
linkedType	String	사용자가 속한그룹에 대한 구분자 필요한 경우 싸인투게더와 해당값을 소통하여 결정.
userConsent	Object	사용자의 서비스 사용 동의 } "serviceuse":"true", "privacycollection":"true", "marketinguse":"false" } marketinguse를 제외하면 모두 true로 전달해야 하며, margetinguse의 경우 true/false에 따라 광고성 메일을 받을것인지에 대해 선택된다.
sharedPermissionType*	String	사용자 권한 - 관리자 : "Manager" - 일반사용자 : "Normal"
flag*	String	동작에 대한 구분자 생성 시 "C"

Request Example

요청 예시

[
  {
    "userName":"김사용",  			// 사용자 name
    "loginId":"user0001",			// 사용자 login id
    "privateEmail":"[e-mail]",	// 사용자 email
    "phoneNumber":"01000000000",		// 사용자 폰번호	(선택)
    "password": "password12#$",			// 사용자 비밀번호
    "linkedType":"",			        // 사용자 그룹 타입	(선택)
    "userConsent": {				// 사용자 동의 관련
      "marketinguse": true,			// (true, false 선택)
      "privacycollection": true,
      "serviceuse": false
    },
    "sharedPermissionType":"Manager",           // 사용자 권한(Manager,Normal)
    "flag":"C",					// 생성,갱신 flag
    "groupId":1                                 // 생성할 사용자의 로그인된 그룹 또는 하위그룹의 id
  }
]

Response Example

200: OK 성공 또는 핸들링된 오류

Example

{
    "successCount": 1,
    "failCount": 0,
    "successList": [
        {
            "groupId": 1,
            "loginId": "user0001",
            "message": "",
            "sharedPermissionType": "Manager",
            "update": null,
            "success": true,
            "userId": 100,
            "userName": "김사용"
        }
    ],
    "failList": []
}

400: Bad Request 핸들링하지 못한 오류에 대한 처리

Example

{
  "timestamp": "2023-09-01T14:27:27.971+00:00",
  "status": 400,
  "error": "Bad Request",
  "message": "[|COM_002]Invalid_Parameter|파라미터 정보가 정상적이지 않습니다.",
  "path": "/rest/create-document"
}

401: Unauthorized keyauth 토큰(apikey)이 잘못된 경우

Example

{
    "message": "Bad token; invalid JSON"
}

401: Unauthorized Header에 apikey를 전달하지 않은 경우

Example

{
    "message": "Unauthorized"
}