APIが実施された後に、XML形式のレスポンスが返送されます。
APIによるログイン及び追加・変更・削除などの実施結果は下記のようなXMLデータがレスポンスされます。
|
<?xml version=”1.0″ encoding=”UTF-8″?>
<response>
<message>メッセージ</message>
<code>エラーコード</code>
<sessid>セッションID</sessid>
</response>
|
また、検索APIの場合、<entries>が含まれた検索結果が返送されます。
|
<?xml version=”1.0″ encoding=”UTF-8″?>
<response>
<message>メッセージ</message>
<code>エラーコード</code>
<entries>
<entry>
<パラメータ>値</パラメータ>
…
<role>
<service>サービス名</service>
<name>ロール名</name>
</role>
…
<login>
<service>サービス名</service>
<id>ログインID</id>
</login>
…
</entry>
</entries>
</response>
|
※Microsoft365の場合ライセンス名と管理者ロール名、Salesforceの場合プロファイル名になります。
返送されたレスポンスにある<code>に示すエラーコードの内容は下記のようになります。
APIエラーコード一覧
| コード |
内容 |
| 0 |
更新が成功しました。 |
| 1 |
更新に失敗しました。 |
| 16 |
削除する値が存在しません。 |
| 19 |
不正な値です。 |
| 20 |
追加する値は既に存在しています。 |
| 32 |
更新対象が存在しません。 |
| 49 |
認証に失敗しました。 |
| 50 |
更新する権限がありません。 |
| 66 |
配下の組織、またはセキュリティグループを削除してから、削除して下さい。 |
| 68 |
追加対象が既に存在しています。 |
| 80 |
その他のエラーです。 |
以下は検索APIにより実施結果例となります。
|
response: <?xml version=”1.0″ encoding=”UTF-8″?>
<response>
<message>Succeeded to search users</message>
<code>0</code>
<entries>
<entry>
<id>demouser@demo.com</id>
<empnum>00001</empnum>
<sname>デモ</sname>
<gname>太郎</gname>
<skana>でも</skana>
<gkana>たろう</gkana>
<aliasname>デモユーザ</aliasname>
<mail>demousermail@demo.secioss.info</mail>
<mailalias></mailalias>
<lang>ja</lang>
<locale>ja_JP</locale>
<org></org>
<addorg></addorg>
<status>active</status>
<lockout>false</lockout>
<admin_role></admin_role>
<admin_scope></admin_scope>
<immutableid>※Microsoft 365との連携に使用するImmutableID</immutableid>
<service>GakuninTestFed-demo.com</service>
<service>office365</service>
<role>
<service>office365</service>
<name>Exchange Online</name>
<type>Microsoft365 Business Premium</type>
</role>
<role>
<service>office365</service>
<name>Lync Online (Plan 2)</name>
<type>Microsoft365 Business Premium</type>
</role>
<role>
<service>office365</service>
<name>SharePoint Online</name>
<type>Microsoft365 Business Premium</type>
</role>
<role>
<service>office365</service>
<name>Security Administrator</name>
<type>管理者ロール</type>
</role>
<title>係長</title>
<company>セシオス</company>
<department>サポート</department>
<office>東京本社</office>
<country>日本</country>
<postalcode>1710022</postalcode>
<state>tokyo</state>
<city>南池袋</city>
<street>2-13-10</street>
<telephone>07012345678</telephone>
<fax>0362650977</fax>
<mobile>08012345678</mobile>
<homephone>0368775217</homephone>
<contactattr1></contactattr1>
<contactattr2></contactattr2>
<contactattr3></contactattr3>
<contactattr4></contactattr4>
<contactattr5></contactattr5>
<contactattr6></contactattr6>
<contactattr7></contactattr7>
<contactattr8></contactattr8>
<contactattr9></contactattr9>
<contactattr10></contactattr10>
<nmail>sales@secioss.co.jp</nmail>
<simplename>seciossdemo</simplename>
<hiddenfromaddresslists>FALSE</hiddenfromaddresslists>
<edupersonaffiliation></edupersonaffiliation>
<attr_departmentNumber>001</attr_departmentNumber>
<attr_employeeType>正社員</attr_employeeType>
<attr_homePostalAddress>東京都豊島区南池袋2-13-10</attr_homePostalAddress>
<attr_initials>D.U</attr_initials>
<attr_seciossBirthDay>2000/04/01</attr_seciossBirthDay>
<attr_seciossextensionattribute_x-custom-01>追加属性①</attr_seciossextensionattribute_x- custom-01>
<attr_seciossextensionattribute_x-custom-02>追加属性②</attr_seciossextensionattribute_x-custom-02>
<attr_seciossextensionattribute_x-custom-03>追加属性③</attr_seciossextensionattribute_x-custom-03>
<attr_seciossextensionattribute_x-custom-04>追加属性④</attr_seciossextensionattribute_x-custom-04>
<attr_seciossextensionattribute_x-custom-05>追加属性⑤</attr_seciossextensionattribute_x-custom-05>
</entry>
</entries>
</response>
|