本部ユーザーの役割（権限）の付与・剥奪を行えます。
役割情報を CSV ファイルで作成し、WebAPI でアップロードします。
呼び出し先URL
{your-domain} の部分をご利用環境に合わせて変更してください。
https://{your-domain}/h2/RoleAssignmentsManipurator.doリクエスト
| パラメータ名 | 意味 | 必須 | 制約・説明 |
|---|---|---|---|
key | WebAPIキー | 〇 | アカウント管理APIが利用可能な WebAPIキーを指定します。 |
csvFile | CSVファイル | 〇 | 役割情報 CSV ファイルを指定します。 |
レスポンス
API の呼び出し結果は、以下のスキーマの XML 文書として返されます。
<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="response">
<xsd:sequence>
<xsd:element name="result" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="info" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="error-lines" type="xsd:string" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:element>
</xsd:schema>
レスポンス要素
| 要素 | 意味 | 備考 |
|---|---|---|
//response/result | リザルトコード | 1 : 成功4 : 入力パラメータの内容にエラーがある8 : その他のシステムエラーが発生 |
//response/errors | エラーメッセージ | エラーが発生した場合、詳細なエラーメッセージが文字列として返されます。 |
//response/info | 更新ログ | 役割を付与・剥奪したログが文字列で出力されます。 |
//response/error-lines | エラー行番号 | エラーがあった行の行番号をカンマ区切りのデータで返します。 |
役割の付与・剥奪に成功した場合のレスポンスXML例
<response>
<result>1</result>
<info><![CDATA[
* 1: add roles to '00001'.
* 2: revoke roles from '00007'.
]]></info>
</response>
説明
//response/resultが1のため、呼び出しは成功です。//response/infoには、どのアカウントに対してどの操作が成功したかが出力されます。- 例では、次を示しています。
00001: 役割の付与に成功00007: 役割の剥奪に成功
役割の付与・剥奪に失敗した場合のレスポンスXML例
<response>
<result>4</result>
<errors><![CDATA[
* 1: 'roleId0' is not a role code.
]]></errors>
<error-lines>1</error-lines>
</response>
説明
//response/resultが4のため、呼び出しは失敗です。- CSV の 1行目 に記載された
roleId0に指定した、役割の WebAPI 用コードが見つからないことを示しています。 //response/error-linesには、エラーのあった行番号が返されます。
CSVファイルの仕様
役割情報の CSV ファイル仕様は以下の通りです。
〇: 必須△: 追加時は必須
| 列名 | 必須 | 桁数 | 内容 |
|---|---|---|---|
id | 〇 | 120 | 役割を付与・剥奪する対象の本部ユーザーのログインID、または本部グループのグループコードを指定します。 |
type | 〇 | id が本部ユーザーのときは user、本部グループのときは group を指定します。 | |
revoke | 〇 | 役割を付与するときは 0、剥奪するときは 1 を指定します。 | |
roleId0～ | 120 | 付与・剥奪する対象の役割の WebAPI 用コードを指定します。 |
補足事項
idに指定した本部ユーザーまたは本部グループが見つからない場合は、エラーにはならず、その行はスキップ されます。roleId0～roleId19まで、最大20個の役割 を同時に操作できます。- 役割の WebAPI 用コードは、役割の編集画面 で確認できます。
- 指定した WebAPI 用コードに該当する役割が見つからない場合は、エラー になります。