Group に属する User リストの照会

印刷する
共有
PDF

記事の要約

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

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

Groupに属する Userリストを照会します。

リクエスト

GET /groups/{groupId}/users

リクエスト Path

パラメータ	要否	タイプ	制約事項	説明
groupId	Y	String		Group Id

リクエストパラメータ

パラメータ	要否	タイプ	制約事項	説明
searchColumn	N	String	loginId, status, nrn, userId	- 検索カラム 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(required) 返された結果の page
totalPages	Number	totalPages(required) 返された結果の totalPage
totalItems	Number	totalItems(required) 返された結果の totalItems
hasPrevious	Boolean	hasPrevious(required) 現在のページ基準で前のページの存在有無
hasNext	Boolean	hasNext(required) 現在のページ基準で次のページの存在有無
isFirst	Boolean	isFirst(required) 全ページ基準で現在のページのトップページ有無
isLast	Boolean	isLast(required) 全ページ基準で現在のページの最終ページ有無
items.[].userId	String	ユーザー ID
items.[].loginId	String	ログイン ID
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
items.[].lastLoginAt	String	最終ログイン日時(UTC、ex. 2023-04-25T13:11:50Z)
items.[].createdAt	String	作成日時(UTC、ex. 2023-04-25T13:11:50Z)
items.[].updatedAt	String	修正日時(UTC、ex. 2023-04-25T13:11:50Z)
items.[].description	String	ユーザーの説明

エラー

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

HTTP status code	エラーコード	エラーメッセージ
400	400	不正なリクエスト
400	9061	グループが存在しない

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

What's Next

Group が属する Assignment リストの照会

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