User 作成

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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	ログイン ID	email形式
description	N	String	ユーザーの説明	最大300byte
userProfile	N	Object	User profile
userProfile.firstName	N	String	名	最大200byte
userProfile.lastName	N	String	姓	最大200byte
userProfile.email	N	String	メールアドレス	最大200byte、email形式
userProfile.empNo	N	String	社員番号	最大200byte
userProfile.phoneCountryCode	N	String	携帯電話番号国番号	最大10byte、国番号形式のみ許可
userProfile.phoneNo	N	String	携帯電話番号	最大200byte、携帯電話番号形式のみ許可
userProfile.deptName	N	String	部署名	最大200byte
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	ユーザー ID
loginId	String	ログイン ID(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 の一括作成

リクエスト
レスポンス
エラー