User リスト照会

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Userリストを照会します。

リクエスト

GET /users

リクエストパラメータ

パラメータ	要否	タイプ	説明	制約事項
searchColumn	N	String	検索カラム	loginId, status, nrn, userId
searchWord	N	String	検索キーワード
page	N	int	ページ番号	デフォルト値: 0
size	N	int	結果リストのサイズ	デフォルト値: 20

レスポンス

レスポンスボディ

{
  "page" : "integer",
  "totalPages" : "integer",
  "totalItems" : "integer",
  "hasPrevious" : "boolean",
  "hasNext" : "boolean",
  "items" : [ {
    "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"
  } ],
  "isFirst" : "boolean",
  "isLast" : "boolean"
}

パラメータ	タイプ	説明
page	Number	返された結果の page
totalPages	Number	返された結果の totalPage
totalItems	Number	返された結果の totalItems
hasPrevious	Boolean	現在のページ基準で前のページの存在有無
hasNext	Boolean	現在のページ基準で次のページの存在有無
isFirst	Boolean	全ページ基準で現在のページのトップページ有無
isLast	Boolean	全ページ基準で現在のページの最終ページ有無
items.[].userId	String	ユーザー ID
items.[].loginId	String	ログイン ID(email)
items.[].nrn	String	作成されたユーザー nrn
items.[].userProfile	Object	User profile
items.[].userProfile.firstName	String	名
items.[].userProfile.lastName	String	姓
items.[].userProfile.email	String	メールアドレス
items.[].userProfile.emailVerified	Boolean	メールアドレスの検証有無
items.[].userProfile.empNo	String	社員番号
items.[].userProfile.phoneCountryCode	String	携帯電話番号国番号
items.[].userProfile.phoneNo	String	携帯電話番号
items.[].userProfile.phoneNoVerified	Boolean	携帯電話番号の検証有無
items.[].userProfile.deptName	String	部署名
items.[].accessRules	Object	アクセスルール
items.[].accessRules.consoleAccessAllowed	Boolean	コンソールへのアクセス許可の有無
items.[].accessRules.apiAccessAllowed	Boolean	APIへのアクセス許可の有無
items.[].status	String	ユーザー状態(active、suspended、deleted)
items.[].lastLoginAt	String	最終ログイン日時(UTC、例: 2023-04-25T13:11:50Z)
items.[].createdAt	String	作成日時(UTC、例: 2023-04-25T13:11:50Z)
items.[].updatedAt	String	修正日時(UTC、例: 2023-04-25T13:11:50Z)
items.[].description	String	ユーザーの説明

エラー

以下のエラーコードは、このアクション(Action)で発生する特徴的なエラーです。エラーレスポンス形式は Error Responseをご参照ください。
よく発生するエラーについての詳細は、NAVER Cloud Platform APIをご参照ください。

HTTP status code	エラーコード	エラーメッセージ
400	400	不正なリクエストです。

この記事は役に立ちましたか?

What's Next

User の個別照会

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