Assignment Target の照会

印刷する
共有
PDF

記事の要約

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

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

Assignment Targetリストを照会します。

リクエスト

GET /assignments/{assignmentId}/targets

リクエスト Path

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

リクエストパラメータ

パラメータ	要否	タイプ	制約事項	説明
targetType	Y	String	user, group	target type
page	N	int		- ページ番号基本値: 0
size	N	int		- 結果リストのサイズ基本値: 20

レスポンス

レスポンスボディ(targetType: user)

{
  "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(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、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	ユーザー説明

レスポンスボディ(targetType: group)

{
  "page" : "integer",
  "totalPages" : "integer",
  "totalItems" : "integer",
  "hasPrevious" : "boolean",
  "hasNext" : "boolean",
  "items" : [ {
    "groupId":"String",
    "groupName":"String",
    "nrn":"String",
    "createdAt":"String",
    "updatedAt":"String",
    "description":"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.[].groupId	String	グループ ID(UUID)
items.[].tenantId	String	テナントプ ID
items.[].groupName	String	グループ名
items.[].nrn	String	グループ nrn
items.[].description	String	グループ説明
items.[].createdAt	String	作成日時(UTC、ex. 2023-04-25T13:11:50Z)
items.[].updatedAt	String	修正日時(UTC、ex. 2023-04-25T13:11:50Z)
items.[].relationCreatedAt	String	修正日時(UTC、ex. 2023-04-25T13:11:50Z)

エラー

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

HTTP status code	エラーコード	エラーメッセージ
400	400	正しくないリクエスト
400	9080	Assignmentが存在しない

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

What's Next

Assignment Target の追加

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