Creating user

Article summary

Did you find this summary helpful?

Thank you for your feedback

You can create a user.

Requests

POST /users

Request bodies

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

Parameters	Requirement status	Type	Description	Restrictions
loginId	Y	String	Login ID	email format
description	N	String	User description	Up to 300 bytes
userProfile	N	Object	User profile
userProfile.firstName	N	String	First name	Up to 200 bytes
userProfile.lastName	N	String	Last name	Up to 200 bytes
userProfile.email	N	String	Email	Up to 200 bytes, email format only
userProfile.empNo	N	String	Employee number	Up to 200 bytes
userProfile.phoneCountryCode	N	String	Country code for mobile phone number	Up to 10 bytes, country code format only
userProfile.phoneNo	N	String	Mobile phone number	Up to 200 bytes, mobile phone number format only
userProfile.deptName	N	String	Department name	Up to 200 bytes
accessRules	Y	Object	Access rules
accessRules.consoleAccessAllowed	Y	Boolean	Whether console access is allowed
accessRules.apiAccessAllowed	Y	Boolean	Whether API access is allowed

Responses

Response bodies

{
  "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"
}

Parameters	Type	Description
userId	String	User ID
loginId	String	Login ID (email)
nrn	String	nrn of the created user
userProfile	Object	User profile
userProfile.firstName	String	First name
userProfile.lastName	String	Last name
userProfile.email	String	Email
userProfile.emailVerified	Boolean	Email verification status
userProfile.empNo	String	Employee number
userProfile.phoneCountryCode	String	Country code for mobile phone number
userProfile.phoneNo	String	Mobile phone number
userProfile.phoneNoVerified	Boolean	Mobile phone number verification status
userProfile.deptName	String	Department name
accessRules	Object	Access rules
accessRules.consoleAccessAllowed	Boolean	Whether console access is allowed
accessRules.apiAccessAllowed	Boolean	Whether API access is allowed
status	String	User status (active, suspended, deleted)
lastLoginAt	String	Last login time (UTC, e.g., 2023-04-25T131150Z)
createdAt	String	Creation time (UTC, e.g., 2023-04-25T131150Z)
updatedAt	String	Edit time (UTC, e.g., 2023-04-25T131150Z)
description	String	User description

Errors

Errors that may occur while using this action are listed below. For error response format, see ErrorResponse.
For more information on common errors, see NAVER Cloud Platform API.

HTTP status code	Error code	Error message
400	400	Invalid request.

Was this article helpful?

What's Next

Creating users in batch

Table of contents

Requests
Responses
Errors