API設定
AD360 REST APIは、AD360とサードパーティのアプリケーションまたはWebサービスとの間のデータの共有を容易にします。ドメイン設定、プロキシサーバー設定、メールサーバー設定など、AD360で利用可能なさまざまな設定を管理できます。これらのAPIは、HTTP要求を作成できる任意のアプリケーションから利用できます。
利用可能なAPI
次のリストには、現在利用可能なAD360 APIとその機能が含まれています。
| API | 関数 |
| ドメイン設定を取得する | AD360で構成されているドメインの詳細を読み取ります。 |
| ドメイン資格情報を更新する | AD360で構成されたドメイン資格情報を追加/変更します。 |
| プロキシ設定を取得する | AD360で構成されているプロキシサーバーの設定を読み取ります。 |
| プロキシ設定を更新する | AD360で構成されたプロキシサーバー設定を追加/変更します。 |
| メールサーバー設定を取得する | AD360で構成されたメールサーバー設定を読み取ります。 |
| メールサーバー設定の更新 | AD360で構成されたメールサーバー設定を追加/変更します。 |
注意：JSON要求（Content-Type: application/x-www-form-urlencoded）とレスポンス（Content-Type: application/json）のみがサポートされています。
AD360のAPIにアクセスするにはどうすればよいですか？
AD360のAPIにアクセスするには、最初にAuthTokenを作成する必要があります。次の手順に従ってください。
- 管理者としてAD360にログインします。
- [管理]→[一般設定]→[API設定]に移動します。
- [新しいAuthTokenを作成]をクリックします。
- [スコープを選択]にて、スコープを選択します。
スコープとは何ですか？
スコープは、AuthTokenを使用してアクセスできるAPIを定義します。1つまたはグループのAPIをスコープの一部にすることができます。 - [期限]にて、AuthTokenの有効期限を選択します。
- [作成]をクリックします。
- AuthTokenが作成されます。
※このAuthTokenをコピーして、後で使用できるように安全に保管してください。紛失した場合、取得できず、再生成する必要があります。
APIの使用
AD360 APIにアクセスするには、以下のURL形式を使用します。
<scheme:port[/context] >/RestAPI/*.*[?query][#fragment]
例：http://ad360-server:8082/RestAPI/DomainSettings/getDomains
認証：ベアラー<authtoken>
AuthTokenの管理
作成したすべてのAuthTokenは、AD360の[API設定]ページにあります。ここから、有効期限、スコープ、作成日、最終アクセス時刻など、AuthTokenのさまざまな詳細を確認できます。AuthTokenを取り消して、完全に無効にすることもできます。AuthTokenを管理するには、以下の手順に従ってください。
- 管理者としてAD360にログインします。
- [管理]→[一般設定]→[API設定]に移動します。作成したすべてのAuthTokenを含むテーブルが表示されます。
- 特定のAuthTokenを表示するには：[表示]のドロップダウンにて、任意の項目を選択します。ｋろえにより、有効なAuthToken、期限切れのAuthTokenなどに絞って表示できます。
- AuthTokenのスコープを表示するには：[スコープ名]列に表示されているスコープをクリックします。AuthTokenがアクセスを提供するすべてのスコープが表示されます。
- AuthTokenアクセスを監査するには：[最終アクセス時間]列の値にマウスを合わせます。監査アイコンが表示されます。クリックすると、AuthTokenにアクセスしたユーザーの詳細な監査証跡が表示されます。
- AuthTokenを取り消すには：[最終アクセス時刻]列にカーソルを置きます。[取り消す]リンクが表示されます。クリックしてAuthTokenを取り消します。
※ AuthTokenを取り消し後、取り消したAuthTokenに依存するAPIは機能しなくなります。
ドメイン設定APIを取得する
このAPIを使用すると、AD360で構成されたドメインの詳細を取得できます。
- 要求URL：http://<ad360-server>: <port>/RestAPI/DomainSettings/getDomains
- HTTPメソッド：GET
- 認証：ベアラー<authtoken>
- 要求パラメータ：
パラメータ 必須 説明 なし - パラメータは必要ありません - 応答パラメータ：
パラメータ 必須 説明 DEFAULT_NAMING_CONTEXT はい ドメインのデフォルトの命名コンテキストを表します。 IS_DEFAULT_DOMAIN はい ドメインがログインページのデフォルトドメインとして使用されているかどうかを表します。 DC_LIST はい ドメインのドメインコントローラーを一覧表示します。 DOMAIN_FLAT_NAME はい ドメインのドメインフラット名を表示します。 DOMAIN_NAME はい ドメイン名を表示します。 DOMAIN_DNS_NAME はい ドメインのDNS名を表示します。 USER_NAME いいえ AD360でドメインを構成するために使用されるアカウントのユーザー名を表示します。 DOMAIN_FUNCTIONAL_LEVEL はい ドメインのドメイン機能レベルを表示します。 IS_AUTHENTICATION_REQUIRED いいえ ドメインの構成時に認証の詳細が提供されたかどうかを表します。 IS_LDAP_SSL_ENABLED いいえ ドメインとAD360間の接続がLDAPS対応かどうかを表します。 STATUS_MESSAGE いいえ 以前のドメイン構成操作の結果を表示します。
サンプル要求：
http://ad360-dc1:8082/RestAPI/DomainSettings/getDomains
認証：Bearer ztfhotq5ytctmgy4zi00nzk2lwjiodkmtwvlymvjyja3yjm5
応答例：
[{"DEFAULT_NAMING_CONTEXT":"DC=ad360,DC=local","IS_DEFAULT_DOMAIN":"true","DC_LIST":["win2k12master.ad360.local","EST-ADC.ad360.local"],"DOMAIN_FLAT_NAME":"AD360","DOMAIN_NAME":"ad360.local","DOMAIN_DNS_NAME":"ad360.local","DOMAIN_FUNCTIONAL_LEVEL":"Windows Server 2008"}]
ドメイン設定APIを更新する
このAPIを使用すると、AD360のドメイン設定を更新できます。
- 要求URL: http://<ad360-server>:<port>/RestAPI/DomainSettings/updateDomainCredential
- HTTPメソッド：POST
- 認証：ベアラー<authtoken>
- 要求パラメータ：
パラメータ 必須 説明 ドメイン はい 次の属性を持つJSON入力が必要です（キーと値のペア） 属性 必須 説明 DOMAIN_NAME はい ドメイン名を表します。 USER_NAME いいえ 認証に有効なユーザー名。 USER_PASSWORD いいえ 認証用の有効なパスワード。 - 応答パラメータ：
パラメータ 必須 説明 ステータス はい 要求全体のステータス（成功または失敗など）を表示します。 ドメイン はい 各ドメインの要求のステータスを表示します。
サンプル要求：
http://ad360-dc1:8082/RestAPI/DomainSettings/updateDomainCredential
認証：Bearer ztfhotq5ytctmgy4zi00nzk2lwjiodkmtwvlymvjyja3yjm5
DOMAINS=[{"DOMAIN_NAME":"ad360.local","USER_NAME":"admin","USER_PASSWORD":"Test123"}]
応答例：
{"STATUS":"SUCCESS","DOMAINS":{"ad360.local":"{\"DOMAIN_STATUS\":\"SUCCESS\"}"}}
- エラー応答：
INVALID_DOMAIN 例：{"STATUS":"SUCCESS","DOMAINS":{"--":"{\"DOMAIN_STATUS\":\"FAILURE\",\"ERROR_MSG\":\"INVALID_DOMAIN\"}"}} DOMAIN_NOT_AVAILABLE 例：{"STATUS":"SUCCESS","DOMAINS":{"ad360.local":"{\"DOMAIN_STATUS\":\"FAILURE\",\"ERROR_MSG\":\"INVALID_OR_INSUFFICIENT_CREDENTIAL\"}"}} INVALID_OR_INSUFFICIENT_CREDENTIAL FAILURE_IN_SERVER 例：{"STATUS":"SUCCESS","DOMAINS":{"ad360.local":"{\"DOMAIN_STATUS\":\"FAILURE\",\"ERROR_MSG\":\"FAILURE_IN_SERVER\"}"}}
{"STATUS":"FAILURE","ERROR_MSG":"FAILURE_IN_SERVER"}
プロキシ設定APIを取得する
このAPIを使用すると、AD360で構成されたプロキシサーバーの詳細を取得できます。
- 要求URL: http://<ad360-server>:<port>/RestAPI/ProxySettings/getSettings
- HTTPメソッド：GET
- 認証：ベアラー<authtoken>
- 要求パラメータ：
パラメータ 必須 説明 なし パラメータは必要ありません。 - 応答パラメータ：
パラメータ 必須 説明 ENABLE_PROXY はい プロキシサーバーを有効または無効にします。 SERVER_NAME いいえ プロキシサーバーのホスト名またはIPアドレス。 PORT いいえ プロキシサーバーのポート番号。 USER_NAME いいえ プロキシサーバー認証に使用されるユーザー名。
サンプル要求：
http://ad360-dc1:8082/RestAPI/ProxySettings/getSettings
認証：Bearer ztfhotq5ytctmgy4zi00nzk2lwjiodkmtwvlymvjyja3yjm5
応答例：
{"ENABLE_PROXY":"true","SERVER_NAME":"ad360-dc1","PORT":"5005","USER_NAME":"admin"}
プロキシ設定APIの更新
このAPIを使用すると、AD360のプロキシ設定を更新できます。
- 要求URL: http://<ad360-server>:<port>/RestAPI/ProxySettings/updateSettings
- HTTPメソッド：POST
- 認証：ベアラー<authtoken>
- 要求パラメータ：
パラメータ 必須 説明 PROXY_SETTINGS はい 次の属性（キーと値のペア）を持つJSON入力が必要です。 属性 必須 説明 ENABLE_PROXY はい プロキシサーバーを有効または無効にします。 SERVER_NAME はい プロキシサーバーのサーバー名またはIPアドレス。 PORT はい プロキシサーバーを有効または無効にします。 USER_NAME いいえ プロキシサーバー認証に使用されるユーザー名。 パスワード いいえ プロキシサーバー認証に使用されるパスワード。 - 応答パラメータ：
パラメータ 必須 説明 ステータス はい 要求のステータス（成功または失敗など）を表示します。
サンプル要求：
http://ad360-dc1:8082/RestAPI/ProxySettings/updateSettings
認証：Bearer ztfhotq5ytctmgy4zi00nzk2lwjiodkmtwvlymvjyja3yjm5
PROXY_SETTINGS={"ENABLE_PROXY":"true","SERVER_NAME":"ad360-dc1","PORT":"5005","USER_NAME":"admin","PASSWORD":"Test123"}
応答例：
{"STATUS": "SUCCESS"}
- エラー応答：
PS001 - プロキシサーバーにアクセスするには認証が必要です。
PS002 - プロキシサーバーがダウンしています。後でもう一度やり直してください。
PS003 - プロキシ設定の保存に失敗しました。
メール設定APIを取得する
このAPIを使用すると、AD360で構成されたメールサーバーの詳細を取得できます。
- 要求URL: http://<ad360-server>:<port>/RestAPI/MailSettings/getSettings
- HTTPメソッド：GET
- 認証：ベアラー<authtoken>
- 要求パラメータ：
パラメータ 必須 説明 なし - パラメータは必要ありません。 - 応答パラメータ：
パラメータ 必須 説明 SERVER_NAME はい メールサーバーのホスト名またはIPアドレスを表します。 PORT はい メールサーバーのポート番号。 FROM_MAIL_ID はい 通知メールの送信に使用されるメールアドレスを表します。 ADMIN_MAIL_ID はい 通知メールの送信先となるメールアドレスのコンマ区切りのリストを表します。 USER_NAME いいえ メールサーバー認証に使用されるユーザー名。 CONNECTION_SECURITY はい 安全な接続タイプ（SSLまたはTLS）を表します。
サンプル要求：
http://ad360-dc1:8082/RestAPI/MailSettings/getSettings
認証：Bearer ztfhotq5ytctmgy4zi00nzk2lwjiodkmtwvlymvjyja3yjm5
応答例：
{"PORT":"25","FROM_MAIL_ID":"no-reply@ad360.local","SERVER_NAME":"smtp","USER_NAME":"admin","ADMIN_MAIL_ID":"admin@ad360.local,super-admin@ad360.local"}
メール設定APIの更新
このAPIを使用すると、AD360のメールサーバー設定を更新できます。
- 要求URL: http://<ad360-server>:<PORT>/RestAPI/MailSettings/updateSettings
- HTTPメソッド：POST
- 認証：ベアラー<authtoken>
- 要求パラメータ：
パラメータ 必須 説明 MAIL_SETTINGS はい 次の属性を持つJSON入力が必要です（キーと値のペア） 属性 必須 説明 SERVER_NAME はい メールサーバーのサーバー名またはIPアドレス。 PORT はい メールサーバーのポート番号 FROM_MAIL_ID はい 通知の送信元の電子メールアドレス。 ADMIN_MAIL_ID はい 受信者のリスト。 USER_NAME いいえ メールサーバー認証に使用されるユーザー名。 パスワード いいえ メールサーバー認証に使用されるパスワード。 CONNECTION_SECURITY はい 受け入れられる値はSSLまたはTLSです。 - 応答パラメータ：
パラメータ 必須 説明 ステータス はい 要求のステータス（成功または失敗など）を表示します。
サンプル要求：
http://ad360-dc1:8082/RestAPI/MailSettings/updateSettings
認証：Bearer ztfhotq5ytctmgy4zi00nzk2lwjiodkmtwvlymvjyja3yjm5
MAIL_SETTINGS={"PORT":"25","FROM_MAIL_ID":"no-reply@ad360.local","SERVER_NAME":"smtp","USER_NAME":"admin","ADMIN_MAIL_ID":"admin@ad360.local","PASSWORD":"Test123"}
応答例：
{"STATUS": "SUCCESS"}
- エラー応答：
MS001 - 送信元のメールアドレスが無効です。
MS002 - 管理者の電子メールアドレスが無効です。
MS003 - 無効な電子メールアドレス、またはメールサーバーに認証が必要です。
MS004 - サーバー名/IP、ポート番号、接続タイプが正しいか確認して、再試行してください。
MS005 - ネットワーク障害、またはメールサーバーがダウンしています。
MS006 - メールサーバーの認証の詳細が正しくありません。
MS007 - 認識されないSSLメッセージ：セキュア接続が有効化されました。
MS008 - 無効なドメイン名。
MS009 - メールアドレスに「zohocorp」ドメインが含まれていないことを確認してください。
MS010 - サーバー名またはポート番号が無効です。
MS011 - ユーザー名またはパスワードが無効です。
MS012 - TLSを有効にしてSMTPサーバーを構成できません。
MS013 - 接続タイプが無効です。接続タイプはSSLまたはTLSである必要があります。
MS014 - 無効なポート番号。
一般的なエラー応答コード
AT001 - AuthTokenが無効または欠落しています。AuthTokenが取り消されていないか、有効期限が切れていないか確認します。
AT002 - 指定されたAuthTokenには、要求されたAPIにアクセスするために必要な権限がありません。
AT003 - 要求されたAPIはこのHTTPメソッドをサポートしていません。
AT004 - アクセスが拒否されました。ユーザーロールが変更され、ユーザーはこのAPIにアクセスする権限を失いました。
AT005 - アクセスが拒否されました。このAPIにアクセスする許可を所有していません。管理者に連絡してください。
CE001 - 必須パラメーターが無効または欠落しています。
CE002 - 問題が発生しました。
CE003 - 無効なユーザー名またはパスワード。