POST api/v1/User/summary

特定のユーザーのサマリーを取得します。

要求の例

http://hostname:port/api/v1/User/summary

 

{

StartPage: 1,

PageSize: 100,

Language: en-US

}

応答の例

{

results: [

        {

            displayName: Demo@domain.com,

            loginName: Demo@domain.com,

            email: Demo@domain.com,

            userStatus: Active,

            trustStatus: Not Trusted,

            sensitiveItems: 16,

            lastSignin: None,

            createdOn: 2021-12-21T05:05:20

        }

],

status: 200,

message: “”,

content: null,

nextToken: null

}

要求情報

要素

説明

種類

必須

Language

取得しようとしている情報の言語を設定します。

String

有効な値は次のとおりです。

en-US (英語) (既定)

ja-JP (日本語)

fr-FR (フランス語)

いいえ

StartPage

グループ サマリーを取得する開始ページを設定します。

Int

既定の値は 1 です。

はい

PageSize

結果の各ページに表示するユーザーの数を設定します。その数は 100 以内で設定する必要があります。

Int

いいえ

応答情報

要素

説明

種類

results

displayName

ユーザーの表示名

String

loginName

ユーザーのログイン名

String

Email

ユーザーのメール アドレス

String

userStatus

Microsoft 365 におけるユーザーのサインイン状態

有効な値は次のとおりです。

ブロック済み (Microsoft 365 へのサインインがブロックされている Microsoft Entra のユーザーの場合)

アクティブ化 (Microsoft 365 へのサインインがアクティブ化されている Microsoft Entra のユーザーの場合)

String

trustStatus

Insights for Microsoft 365 におけるユーザーの信頼状態

有効な値は次のとおりです。

信頼済み (Insights for Microsoft 365 で信頼されているユーザーの場合)

未信頼 (Insights for Microsoft 365 で信頼されていないユーザーの場合)

String

senstiveItems

ユーザーに直接権限が付与されている機密アイテムの数

Int

lastSignin

ユーザーの Microsoft 365 への最後のサインイン日時

String

createdOn

ユーザーが Microsoft Entra で作成された日時

DateTime

status

HTTP の応答状態コード

Int

message

エラー メッセージ

String

content

備考です。この要素はこの API で使用されません。既定は null が応答されます。

String

nextToken

このリクエストの残りの結果を得るために使用されるトークンです。この要素はこの API で使用されません。既定は null が応答されます。

String