User Read Method
User APIは、Userに対するアクセスを提供します。
User Readでは、指定した条件に対応するUserのリストを取得することができます。
GET |
https://{Request Host}/v1/user?partition=[value]&request_type=[value]&user_type=[value]&count=[value]&start=[value]&field=[value] |
---|
Scope
User Readを行うために必要なアクセス権は次の通りです。
user_r
Input Variables
GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。
また、指定できるParameterは以下の通りです。
必須 | Parameter | Definition |
---|---|---|
● | partition | Partition Idを数値で指定します。 アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。 |
● | request_type |
取得するユーザーの種別を指定します。次の値を指定することができます。 ・response_type = code_direct で認証を行った場合、ユーザー名がアプリ名(APIを実行している当該 app id のアプリ名)のユーザーを取得
|
ー | user_type | PORTERSの[設定]>[ユーザー]で設定する[ユーザータイプ]の種別で、「システム管理者」と「標準ユーザー」が存在します。 次の値を指定することができます。省略した場合は-1が指定されたものとみなします。 -1:すべての種類のユーザーを取得 0:「システム管理者」を取得 1:「標準ユーザー」を取得 |
ー | count | 取得するデータの件数を数値で指定します。 指定できる値の範囲は、1~200までです。省略した場合は10が指定されたものとみなします。 |
ー | start | 取得するデータの開始インデックスです。 0以上の値を数値で指定します。省略した場合は0が指定されたものとみなします。 |
ー | field |
出力する項目を指定します。指定できるFieldは、User - Field List / Timezone Listを参照してください。 |
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。User APIで取扱可能な任意のFieldはありません。
Tag | Definition |
---|---|
User | 条件に該当するUserを含むルート要素です。 取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。 |
Total | Userの属性。指定した検索条件で取得できる総件数を示します。 |
Count | Userの属性。今回取得したデータの件数を示します。 |
Start | Userの属性。今回取得したデータの開始インデックスを示します。 |
Code | 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。 |
Item | 一つのUser情報を表します。 |
Field | 指定された項目の値を格納します。 要素の名称は、User - Field List / Timezone Listを参照してください。 |
User Read Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、すべてのユーザー情報を取得する場合の例です。
Input Parameter https://{Request Host}/v1/user?partition=999999&request_type=1&user_type=-1 |
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |