User 생성

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

Classic/VPC 환경에서 이용 가능합니다.

User를 생성합니다.

요청

POST /users

요청 Body

{
  "loginId": "string",
  "description": "string",
  "userProfile": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "empNo": "string",
    "phoneCountryCode": "string",
    "phoneNo": "string",
    "deptName": "string"
  },
  "accessRules": {
    "consoleAccessAllowed": "boolean",
    "apiAccessAllowed": "boolean"
  }
}

파라미터	필수 여부	타입	설명	제약 사항
loginId	Y	String	로그인 아이디	email 형식
description	N	String	유저 설명	최대 300 bytes
userProfile	N	Object	User profile
userProfile.firstName	N	String	이름	최대 200 bytes
userProfile.lastName	N	String	성	최대 200 bytes
userProfile.email	N	String	이메일	최대 200 bytes, email 형식
userProfile.empNo	N	String	사원 번호	최대 200 bytes
userProfile.phoneCountryCode	N	String	핸드폰 번호 국가 번호	최대 10 bytes, 국가 번호 형식만 허용
userProfile.phoneNo	N	String	핸드폰 번호	최대 200 bytes, 핸드폰 번호 형식만 허용
userProfile.deptName	N	String	부서명	최대 200 bytes
accessRules	Y	Object	접근 규칙
accessRules.consoleAccessAllowed	Y	Boolean	콘솔 접근 허용 여부
accessRules.apiAccessAllowed	Y	Boolean	API 접근 허용 여부

응답

응답 바디

{
  "userId" : "string",
  "loginId" : "string",
  "nrn" : "string",
  "userProfile" : {
    "firstName" : "string",
    "lastName" : "string",
    "email" : "string",
    "emailVerified" : "boolean",
    "empNo" : "string",
    "phoneCountryCode" : "string",
    "phoneNo" : "string",
    "phoneNoVerified" : "boolean",
    "deptName" : "string"
  },
  "accessRules" : {
    "consoleAccessAllowed" : "boolean",
    "apiAccessAllowed" : "boolean"
  },
  "status" : "string",
  "description" : "string",
  "lastLoginAt" : "string",
  "createdAt" : "string",
  "updatedAt" : "string"
}

파라미터	타입	설명
userId	String	유저 아이디
loginId	String	로그인 아이디 (email)
nrn	String	생성된 유저 nrn
userProfile	Object	User profile
userProfile.firstName	String	이름
userProfile.lastName	String	성
userProfile.email	String	이메일
userProfile.emailVerified	Boolean	이메일 검증 여부
userProfile.empNo	String	사원 번호
userProfile.phoneCountryCode	String	핸드폰 번호 국가 번호
userProfile.phoneNo	String	핸드폰 번호
userProfile.phoneNoVerified	Boolean	핸드폰 번호 검증 여부
userProfile.deptName	String	부서명
accessRules	Object	접근 규칙
accessRules.consoleAccessAllowed	Boolean	콘솔 접근 허용 여부
accessRules.apiAccessAllowed	Boolean	API 접근 허용 여부
status	String	유저 상태 (active, suspended, deleted)
lastLoginAt	String	최종 로그인 일시 (UTC, ex. 2023-04-25T131150Z)
createdAt	String	생성 일시 (UTC, ex. 2023-04-25T131150Z)
updatedAt	String	수정 일시 (UTC, ex. 2023-04-25T131150Z)
description	String	유저 설명

에러

아래 에러 코드는 이 액션(Action)에서 특징적으로 발생하는 에러입니다. 에러 응답 형식은 ErrorResponse를 참조해 주십시오.
공통적으로 발생하는 에러에 대한 상세한 설명은 NAVER Cloud Platform API를 참고해 주십시오.

HTTP status code	에러 코드	에러 메시지
400	400	잘못된 요청

이 문서가 도움이 되었습니까?

What's Next

User 대량 생성

요청
응답
에러