モジュール名: connection

機能名	説明
list	指定するコネクション情報の一覧を取得します
show	指定するコネクション情報を取得します
create	コネクション情報を作成します
copy	コネクション情報を複製します
update	コネクション情報を変更します
delete	コネクション情報を削除します

機能名: list

指定するコネクション情報の一覧を取得します。

administrator、developer、operator

HTTPメソッド	リクエストURL
GET	http://{Hostname}:{Port}/mcapi/connection/list

パラメーター	必須	説明
type	いいえ	コネクションタイプを指定します。 rdb - RDB http - HTTP ftp - FTP smtp - SMTP pop3 - POP3 imap4 - IMAP4 AWSConnection - AWS KintoneConnection - kintone queue - Queue jndi - JNDI generic - 汎用 指定しなかった場合は全てのタイプを取得します。
userName	いいえ	取得するユーザーコネクションのユーザー名を指定します。 ただし、ログインユーザー以外のユーザーコネクション情報を取得するためには、「administrator」あるいは「operator」の権限が必須です。 「userName」が指定された場合、「showAllUsers」は無視されて、指定されたユーザーのユーザーコネクション情報のみを取得します。 「userName」と「showAllUsers」の両方を指定しなかった場合、ログインユーザーのユーザーコネクション情報を取得します。
showAllUsers	いいえ	ログインユーザーが取得可能なすべてのユーザーコネクション情報を取得するには「true」を設定します。「false」あるいは未設定の場合は取得しません。 ただし、すべてのユーザーコネクション情報を取得するためには「administrator」あるいは「operator」の権限が必須です。 「userName」が指定された場合、「showAllUsers」は無視されて、指定されたユーザーのユーザーコネクション情報のみを取得します。 「userName」と「showAllUsers」の両方を指定しなかった場合、ログインユーザーのユーザーコネクション情報を取得します。

指定するユーザーの情報を取得する場合

GET /mcapi/connection/list?type=rdb&userName=/guest HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4

取得可能なすべてのユーザーの情報を取得する場合

GET /mcapi/connection/list?type=rdb&showAllUsers=true HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行に成功するとシステムコネクション情報と指定したユーザーコネクション情報の一覧が返ります。
各種コネクション情報の共通の情報として、次の情報が取得できます。

• 接続名（name）

以下に各種コネクション情報の内容と実行結果の例を記します。

RDBの個別の情報としては次の情報が取得できます。

• データベースタイプ（dbType）
• URL（url）
• データベースのユーザー名（userName）

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "rdb": [
                    {
                        "name": "test_rdb",
                        "dbType": "Oracle(Thin)",
                        "url": "jdbc:oracle:thin:@oracle.test.com:53140:ORCL",
                        "userName": ""
                    },
                    {
                        "name": "test_rdb2",
                        "dbType": "DB2(app)",
                        "url": "jdbc:db2:db2_test",
                        "userName": "sa"
                    }
                ]
            },
            "user": {
            	"/guest": {
                    "rdb": [
                        {
                            "name": "test_conn",
                            "dbType": "DB2(app)",
                            "url": "jdbc:db2:user_test",
                            "userName": ""
                        }
                    ]
            	}
            }
        }
    }
}

取得可能なすべてのユーザーの情報を取得する場合

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "rdb": [
                    {
                        "name": "test_rdb",
                        "dbType": "Oracle(Thin)",
                        "url": "jdbc:oracle:thin:@oracle.test.com:53140:ORCL",
                        "userName": ""
                    },
                    {
                        "name": "test_rdb2",
                        "dbType": "DB2(app)",
                        "url": "jdbc:db2:db2_test",
                        "userName": "sa"
                    }
                ]
            },
            "user": {
            	"/user1": {
                    "rdb": [
                        {
                            "name": "test_conn",
                            "dbType": "DB2(app)",
                            "url": "jdbc:db2:user_test",
                            "userName": ""
                        }
                    ]
            	},
            	"/domain1/user1": {
                    "rdb": [
                        {
                            "name": "test_conn",
                            "dbType": "DB2(app)",
                            "url": "jdbc:db2:user_test",
                            "userName": ""
                        }
                    ]
            	}
            }
        }
    }
}

Httpの個別の情報として次の情報が取得できます。

• URL（url）
• ユーザー名（userName）

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "http": [
                    {
                        "name": "test_http",
                        "url": "http://www.httptest.com",
                        "userName": "test"
                    }
                ]
            }
        }
    }
}

Ftpの個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• プロトコル（protocol）
  「FTP」の場合は「ftp」、「SFTP」場合は「sftp」
• ポート番号（port）
• ユーザー名（userName）

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "ftp": [
                    {
                        "name": "test_ftp",
                        "hostName": "test.ftp.com",
                        "protocol": "ftp",
                        "port": 21,
                        "userName": "test"
                    }
                ]
            }
        }
    }
}

SMTPの個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• ポート番号（port）
• 認証方法（authenticationType）
  「POP before SMTP認証」の場合は「POP3」、「SMTP認証」の場合は「SMTP」、認証を行わない場合は「NONE」
  「POP before SMTP認証」あるいは「SMTP認証」の場合は、次の個別の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "smtp": [
                    {
                        "name": "test_smtp_smtp",
                        "hostName": "test.smtp.com",
                        "port": 25,
                        "authenticationType": "SMTP"
                    },
                    {
                        "name": "test_smtp_pop3",
                        "hostName": "test.smtp.com",
                        "port": 25,
                        "authenticationType": "POP before SMTP"
                    },
                    {
                        "name": "test_smtp_none",
                        "hostName": "test.smtp.com",
                        "port": 25,
                        "authenticationType": "none"
                    }
                ]
            }
        }
    }
}

POP3の個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• ポート番号（port）
• ユーザー名（userName）

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "pop3": [
                    {
                        "name": "test_pop3",
                        "hostName": "test.pop3.com",
                        "port": 110,
                        "userName": "test"
                    }
                ]
            }
        }
    }
}

IMAP4の個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• ポート番号（port）
• ユーザー名（userName）
• メールボックス（mailBox）

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "imap4": [
                    {
                        "name": "test_imap4",
                        "hostName": "test.imap4.com",
                        "port": 143,
                        "userName": "test",
                        "mailbox": "INBOX"
                    }
                ]
            }
        }
    }
}

AWSの個別の情報として次の情報が取得できます。

• アクセスキー（accessKey）
• リージョン（region）

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "AWSConnection": [
                    {
                        "name": "test",
                        "accessKey": "accessKey",
                        "region": "region"
                    }
                ]
            }
        }
    }
}

kintoneの個別の情報として次の情報が取得できます。

• URL（url）
• 認証方法（auth）
  「パスワード認証」の場合は「PASSWORD」、「APIトークン認証」の場合は「API TOKEN」

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "KintoneConnection": [
                    {
                        "name": "test",
                        "url": "https://test.cybozu.com/k/v1/",
                        "auth": "PASSWORD"
                    }
                ]
            }
        }
    }
}

Queueの個別の情報として次の情報が取得できます。

• JNDI接続名（jndi）
• ユーザー名（userName）

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "queue": [
                    {
                        "name": "test_queue",
                        "jndi": "test_jndi",
                        "userName": "test"
                    }
                ]
            }
        }
    }
}

JNDIの個別の情報として次の情報が取得できます。

• Provider URL（url）

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "jndi": [
                    {
                        "name": "test_jndi",
                        "url": "test.jndi.com"
                    }
                ]
            }
        }
    }
}

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "generic": [
                    {
                        "name": "test_generic"
                    }
                ]
            }
        }
    }
}

下記以外のエラーについては、共通エラーコードを参照してください。

<

HTTPステータスコード	エラーコード	説明
400 Bad Request	2001	パラメーター type の値が正しくなかった場合
403 Forbidden	3001	ログインしていなかった場合
	3101	権限が不足していた場合
404 Not Found	4002	パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error	5101	内部の通信に失敗した場合
	5102	サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: show

指定したコネクション情報を取得します。

administrator、developer、operator

HTTPメソッド	リクエストURL
GET	http://{Hostname}:{Port}/mcapi/connection/show

パラメーター	必須	説明
type	はい	コネクションタイプを指定します。 rdb - RDB http - HTTP ftp - FTP smtp - SMTP pop3 - POP3 imap4 - IMAP4 AWSConnection - AWS KintoneConnection - kintone queue - Queue jndi - JNDI generic - 汎用
name	はい	コネクション名を指定します。
ownerType	はい	コネクション情報の種別を指定します。 「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName	いいえ	取得するユーザーコネクションのユーザー名を指定します。 指定しなかった場合はログインユーザーとなります。

GET /mcapi/connection/show?type=rdb&name=test_conn HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行に成功すると指定したコネクション情報が返ります。 各種コネクション情報の共通の情報として、次の情報が取得できます。

• 接続名（name）
• 動的に変更する（dynamic）
  動的に変更する場合は「true」、動的に変更しない場合は「false」

以下に各種コネクション情報の内容と実行結果の例を記します。

RDBの個別の情報としては次の情報が取得できます。

• データベースタイプ（dbType）
• URL（url）
• ユーザー名（userName）
• ドライバー（driver）
• スキーマ（schema）
• コネクションプール（pool）
  使用する場合は「true」、使用しない場合は「false」
• XA対応（xa）
  対応する場合は「true」、対応しない場合は「false」

{
    "result": {
        "status": "success",
        "data": {
            "rdb": {
                "name": "test_rdb",
                "dbType": "Oracle(Thin)",
                "url": "jdbc:oracle:thin:@oracle.test.com:53140:ORCL",
                "userName": "",
                "driver": "oracle.jdbc.OracleDriver",
                "schema": "",
                "pool": false,
                "xa": false,
                "dynamic": true
            }
        }
    }
}

Httpの個別の情報として次の情報が取得できます。

• URL（url）
• ユーザー名（userName）
• エンコーディング(encoding)
• タイムアウト（timeOut）
• ユーザーのクライアント証明書を使用（useUserClientCert）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「クライアント証明書のエイリアス」が取得できます
• クライアント証明書のエイリアス（clientCertAlias）
• OAuthを使用（useOAuth）
  使用する場合は「true」、使用しない場合は「false」
• タイムアウト（timeOut）
• プロキシサーバー（proxyServer）
  使用する場合は「true」、使用しない場合は「false」

{
    "result": {
        "status": "success",
        "data": {
            "http": {
                "name": "test_http",
                "url": "http://www.httptest.com",
                "userName": "test",
                "encoding": "utf-8",
                "timeOut": 30,
                "useUserClientCert": true,
                "clientCertAlias": "alias",
                "useOAuth": false,
                "proxyServer": false,
                "dynamic": false
            }
        }
    }
}

Httpの個別の情報として次の情報が取得できます。

• URL（url）
• ユーザー名（userName）
• エンコーディング(encoding)
• タイムアウト（timeOut）
• ユーザーのクライアント証明書を使用（useUserClientCert）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「クライアント証明書のエイリアス」が取得できます
• クライアント証明書のエイリアス（clientCertAlias）
• OAuthを使用（useOAuth）
  使用する場合は「true」、使用しない場合は「false」
• タイムアウト（timeOut）
• プロキシサーバー（proxyServer）
  使用する場合は「true」、使用しない場合は「false」
• コールバックURL（oauthCallbackUrl）
• 認可エンドポイント（oauthAuthorizationServerUrl）
• トークンエンドポイント（oauthTokenServerUrl）
• クライアントID（oauthClientId）
• スコープ（oauthScope）
• 認証の送信方法（oauthAuthType）
  「なし」の場合は「none」、「Bearer認証」の場合は「Bearer」

{
    "result": {
        "status": "success",
        "data": {
            "http": {
                "name": "test_http",
                "url": "http://www.httptest.com",
                "userName": "test",
                "encoding": "utf-8",
                "timeOut": 30,
                "useUserClientCert": true,
                "clientCertAlias": "alias",
                "useOAuth": true,
                "oauthCallbackUrl": "http://localhost:33333",
                "oauthAuthorizationServerUrl": "https://accounts.google.com/o/oauth2/auth",
                "oauthTokenServerUrl": "https://oauth2.googleapis.com/token",
                "oauthClientId": "xxxxx",
                "oauthScope": "https://mail.google.com/",
                "oauthAuthType": "none",
                "proxyServer": false,
                "timeOut": 60,
                "dynamic": true
            }
        }
    }
}

Ftpの個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• プロトコル（protocol）
  「FTP」の場合は「ftp」、「SFTP」場合は「sftp」
• ポート番号（port）
• ユーザー名（userName）
• ファイル名エンコーディング(encoding)
• タイムアウト（timeOut）
• 公開鍵認証のキーファイル（keyFile）
• パッシブモード（passiveMode）

{
    "result": {
        "status": "success",
        "data": {
            "ftp": {
                "name": "test_ftp",
                "hostName": "test.ftp.com",
                "protocol": "ftp",
                "port": 21,
                "userName": "anonymous",
                "encoding": "utf-8",
                "timeOut": 60,
                "keyFile": "file.key",
                "passiveMode": true,
                "dynamic": false
            }
        }
    }
}

SMTPの個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• SMTP over SSLの使用設定（useSmtpOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• ポート番号（port）
• タイムアウト（timeOut）
• 認証方法（authenticationType）
  「POP before SMTP認証」の場合は「POP3」
• POP3サーバー名（pop3HostName）
• POP over SSLの使用設定（usePopOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTlsForPop）
  使用する場合は「true」、使用しない場合は「false」
• POP3ポート番号（pop3Port）
• APOPの使用設定（useApop）
  使用する場合は「true」、使用しない場合は「false」
• 間隔（pop3Interval）
• ユーザー名（userName）

{
    "result": {
        "status": "success",
        "data": {
            "smtp": {
                "name": "test_smtp_pop3",
                "hostName": "test.smtp.com",
                "port": 25,
                "authenticationType": "POP before SMTP",
                "useSmtpOverSsl": false,
                "useStartTls": false,
                "pop3HostName": "test.smtp.com/pop3",
                "usePopOverSsl": false,
                "useStartTlsForPop": false,
                "pop3Port": 443,
                "userName": "test",
                "useApop": false,
                "pop3Interval": 5,
                "timeOut": 60,
                "dynamic": false
            }
        }
    }
}

SMTPの個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• SMTP over SSLの使用設定（useSmtpOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• ポート番号（port）
• タイムアウト（timeOut）
• 認証方法（authenticationType）
  「SMTP認証」の場合は「SMTP」
• ユーザー名（userName）
• SMTP認証の方式（smtpAuthenticationType）
  「プレーンテキスト認証」の場合は「plain」、「CRAM-MD5認証」の場合は「cram-md5」、「OAuth認証」の場合は「oauth」

{
    "result": {
        "status": "success",
        "data": {
            "smtp": {
                "name": "test_smtp_smtp",
                "hostName": "test.smtp.com",
                "port": 25,
                "authenticationType": "SMTP",
                "useSmtpOverSsl": true,
                "useStartTls": false,
                "userName": "",
                "smtpAuthenticationType": "plain",
                "timeOut": 60,
                "dynamic": true
            }
        }
    }
}

SMTPの個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• SMTP over SSLの使用設定（useSmtpOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• ポート番号（port）
• タイムアウト（timeOut）
• 認証方法（authenticationType）
  「SMTP認証」の場合は「SMTP」
• ユーザー名（userName）
• SMTP認証の方式（smtpAuthenticationType）
  「プレーンテキスト認証」の場合は「plain」、「CRAM-MD5認証」の場合は「cram-md5」、「OAuth認証」の場合は「oauth」
• コールバックURL（oauthCallbackUrl）
• 認可エンドポイント（oauthAuthorizationServerUrl）
• トークンエンドポイント（oauthTokenServerUrl）
• クライアントID（oauthClientId）
• スコープ（oauthScope）
• 認証の送信方法（oauthAuthCommandSendingMethod）
  「1行で送信」の場合は「one line」、「2行で送信」の場合は「two lines」

{
    "result": {
        "status": "success",
        "data": {
            "smtp": {
                "name": "test_smtp_smtp",
                "hostName": "test.smtp.com",
                "port": 25,
                "authenticationType": "SMTP",
                "useSmtpOverSsl": true,
                "useStartTls": false,
                "userName": "",
                "smtpAuthenticationType": "oauth",
                "oauthCallbackUrl": "http://localhost:33333",
                "oauthAuthorizationServerUrl": "https://accounts.google.com/o/oauth2/auth",
                "oauthTokenServerUrl": "https://oauth2.googleapis.com/token",
                "oauthClientId": "xxxxx",
                "oauthScope": "https://mail.google.com/",
                "oauthAuthCommandSendingMethod": "one line",
                "timeOut": 60,
                "dynamic": true
            }
        }
    }
}

SMTPの個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• SMTP over SSLの使用設定（useSmtpOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• ポート番号（port）
• タイムアウト（timeOut）
• 認証方法（authenticationType）
  認証を行わない場合は「NONE」

{
    "result": {
        "status": "success",
        "data": {
            "smtp": {
                "name": "test_smtp_none",
                "hostName": "test.smtp.com",
                "port": 25,
                "authenticationType": "none",
                "useSmtpOverSsl": true,
                "useStartTls": true,
                "timeOut": 60,
                "dynamic": false
            }
        }
    }
}

POP3の個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• ポート番号（port）
• ユーザー名（userName）
• POP over SSLの使用設定（usePopOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• 認証の方式（authenticationType）
  「プレーンテキスト認証」の場合は「none」、「APOP認証」の場合は「APOP」、「OAuth認証」の場合は「oauth」
• タイムアウト（timeOut）

{
    "result": {
        "status": "success",
        "data": {
            "pop3": {
                "name": "test_pop3",
                "hostName": "test.pop3.com",
                "port": 110,
                "userName": "test",
                "usePopOverSsl": true,
                "useStartTls": true,
                "authenticationType": "none",
                "timeOut": 60,
                "dynamic": false
            }
        }
    }
}

POP3の個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• ポート番号（port）
• ユーザー名（userName）
• POP over SSLの使用設定（usePopOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• 認証の方式（authenticationType）
  「プレーンテキスト認証」の場合は「none」、「APOP認証」の場合は「APOP」、「OAuth認証」の場合は「oauth」
• コールバックURL（oauthCallbackUrl）
• 認可エンドポイント（oauthAuthorizationServerUrl）
• トークンエンドポイント（oauthTokenServerUrl）
• クライアントID（oauthClientId）
• スコープ（oauthScope）
• 認証の送信方法（oauthAuthCommandSendingMethod）
  「1行で送信」の場合は「one line」、「2行で送信」の場合は「two lines」

{
    "result": {
        "status": "success",
        "data": {
            "pop3": {
                "name": "test_pop3",
                "hostName": "test.pop3.com",
                "port": 110,
                "userName": "test",
                "usePopOverSsl": true,
                "useStartTls": true,
                "authenticationType": "oauth",
                "oauthCallbackUrl": "http://localhost:33333",
                "oauthAuthorizationServerUrl": "https://accounts.google.com/o/oauth2/auth",
                "oauthTokenServerUrl": "https://oauth2.googleapis.com/token",
                "oauthClientId": "xxxxx",
                "oauthScope": "https://mail.google.com/",
                "oauthAuthCommandSendingMethod": "one line",
                "timeOut": 60,
                "dynamic": true
            }
        }
    }
}

IMAP4の個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• ポート番号（port）
• ユーザー名（userName）
• メールボックス（mailBox）
• IMAP4 over SSLの使用設定（useImap4OverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• タイムアウト（timeOut）
• 認証の方式（authenticationType）
  「プレーンテキスト認証」の場合は「none」、「CRAM-MD5認証」の場合は「CRAM-MD5」、「OAuth認証」の場合は「oauth」

{
    "result": {
        "status": "success",
        "data": {
            "imap4": {
                "name": "test_imap4",
                "hostName": "test.imap4.com",
                "port": 143,
                "userName": "test",
                "mailbox": "INBOX",
                "useImap4OverSsl": false,
                "useStartTls": false,
                "timeOut": 60,
                "authenticationType": "none",
                "dynamic": false
            }
        }
    }
}

IMAP4の個別の情報として次の情報が取得できます。

• ホスト名（hostName）
• ポート番号（port）
• ユーザー名（userName）
• メールボックス（mailBox）
• IMAP4 over SSLの使用設定（useImap4OverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• タイムアウト（timeOut）
• 認証の方式（authenticationType）
  「プレーンテキスト認証」の場合は「none」、「APOP認証」の場合は「APOP」、「OAuth認証」の場合は「oauth」
• コールバックURL（oauthCallbackUrl）
• 認可エンドポイント（oauthAuthorizationServerUrl）
• トークンエンドポイント（oauthTokenServerUrl）
• クライアントID（oauthClientId）
• スコープ（oauthScope）
• 認証の送信方法（oauthAuthCommandSendingMethod）
  「1行で送信」の場合は「one line」、「2行で送信」の場合は「two lines」

{
    "result": {
        "status": "success",
        "data": {
            "imap4": {
                "name": "test_imap4",
                "hostName": "test.imap4.com",
                "port": 143,
                "userName": "test",
                "mailbox": "INBOX",
                "useImap4OverSsl": false,
                "useStartTls": false,
                "timeOut": 60,
                "authenticationType": "oauth",
                "oauthCallbackUrl": "http://localhost:33333",
                "oauthAuthorizationServerUrl": "https://accounts.google.com/o/oauth2/auth",
                "oauthTokenServerUrl": "https://oauth2.googleapis.com/token",
                "oauthClientId": "xxxxx",
                "oauthScope": "https://mail.google.com/",
                "oauthAuthCommandSendingMethod": "one line",
                "timeOut": 60,
                "dynamic": true
            }
        }
    }
}

AWSの個別の情報として次の情報が取得できます。

• アクセスキー（accessKey）
• プロトコル（protocol）
  「HTTP」あるいは「HTTPS」
• タイムアウト（timeOut）
• リージョン（region）
  • us-east-1 - US East (Northern Virginia)
  • us-west-1 - US West (Northern California)
  • us-west-2 - US West (Oregon)
  • eu-west-1 - EU (Ireland)
  • eu-central-1 - EU (Frankfurt)
  • ap-southeast-1 - Asia Pacific (Singapore)
  • ap-southeast-2 - Asia Pacific (Sydney)
  • ap-northeast-1 - Asia Pacific (Tokyo)
  • sa-east-1 - South America (Sao Paulo)
• プロキシサーバー（useProxy）
  使用する場合は「true」、使用しない場合は「false」
• コネクションをプール（pool）
  コネクションをプールする場合は「true」、しない場合は「false」

{
    "result": {
        "status": "success",
        "data": {
            "AWSConnection": {
                "name": "test",
                "accessKey": "accessKey",
                "region": "region",
                "protocol": "HTTPS",
                "timeout": 30,
                "useProxy": true,
                "pool": true,
                "dynamic": false
            }
        }
    }
}

kintoneの個別の情報として次の情報が取得できます。

• URL（url）
• 認証方法（auth）
  「パスワード認証」の場合は「PASSWORD」、「APIトークン認証」の場合は「API TOKEN」
  「パスワード認証」の場合のみ次の「ログイン名」が取得できます
  「APIトークン認証」の場合のみ次の「アプリID」が取得できます
• ログイン名（loginName）
• アプリID（appId）
• Basic認証（useBasicAuth）
  使用する場合は「true」、しない場合は「false」
  使用する場合のみ次の「Basic認証ログイン名」が取得できます
• Basic認証ログイン名 （basicAuthLoginName）
• タイムアウト（秒）（timeOut）
• プロキシサーバー（useProxy）
  使用する場合は「true」、使用しない場合は「false」
• 動的に変更する（dynamic）

{
    "result": {
        "status": "success",
        "data": {
            "KintoneConnection": {
                "name": "test",
                "url": "https://test.cybozu.com/k/v1/",
                "auth": "PASSWORD",
                "loginName": "testUser",
                "useBasicAuth": true,
                "basicAuthLoginName": "basicUser",
                "timeout": 45,
                "useProxy": true,
                "dynamic": false
            }
        }
    }
}

Queueの個別の情報として次の情報が取得できます。

• JNDI接続名（jndi）
• ユーザー名（userName）
• Queue Connection Factory（queueConnectionFactory）

{
    "result": {
        "status": "success",
        "data": {
            "queue": {
                "name": "test_queue",
                "jndi": "test_jndi",
                "userName": "test",
                "queueConnectionFactory": "test_factory",
                "dynamic": false
            }
        }
    }
}

JNDIの個別の情報として次の情報が取得できます。

• Provider URL（url）
• Initial Factory（initialFactory）
• パラメーター（parameters）
• コネクションプール（connectionPool）
  接続プールを使用する場合は「true」、接続プールを使用しない場合は「false」

{
    "result": {
        "status": "success",
        "data": {
            "jndi": {
                "name": "test_jndi",
                "url": "test.jndi.com",
                "initialFactory": "jndi_factory",
                "parameters": {
                    "param1": "abc",
                    "param2": "123"
                },
                "connectionPool": true,
                "dynamic": false
            }
        }
    }
}

汎用の個別の情報として次の情報が取得できます。

• パラメーター（parameters）
• 非表示パラメーター（maskedParameters）
  パラメーターのキーだけを取得します
• コネクションプール（connectionPool）
  接続プールを使用する場合は「true」、接続プールを使用しない場合は「false」

{
    "result": {
        "status": "success",
        "data": {
            "generic": {
                "name": "test_generic",
                "parameters": {
                    "param1": "abc"
                },
                "maskedParameters": [
                    "param2"
                ],
                "connectionPool": true,
                "dynamic": false
            }
        }
    }
}

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード	エラーコード	説明
400 Bad Request	2001	パラメーター type, ownerType の値が正しくなかった場合
	2002	パラメーター type, ownerType, name の値が設定されていなかった場合
403 Forbidden	3001	ログインしていなかった場合
	3101	権限が不足していた場合
	3103	システムコネクションへのアクセスが拒否された場合
404 Not Found	4002	パラメーター userName で指定されたユーザーが存在しなかった場合
	4005	パラメーター type, name で指定されたコネクション情報が存在しなかった場合
500 Internal Server Error	5101	内部の通信に失敗した場合
	5102	サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: create

コネクション情報を作成します。

administrator、developer

HTTPメソッド	リクエストURL
POST	http://{Hostname}:{Port}/mcapi/connection/create

パラメーター	必須	説明
ownerType	はい	コネクション情報の種別を指定します。 「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName	いいえ	ユーザーコネクションのユーザー名を指定します。 ownerTypeが「user」のときのみ有効です。 指定しなかった場合はログインユーザーとなります。

設定する情報は、showで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
ただし、必要に応じてshowで表示されない「password」の情報と非表示パラメーターの値を設定します。

• パスワード（password）

• パスワード（password）

• パスワード（password）

• パスワード（password）
• キーファイルのパスフレーズ（keyfilepassphrase）

• パスワード（password）
• SMTPパスワード（smtppassword）

• パスワード（password）

• パスワード（password）

• シークレットキー（secretKey）

• パスワード（password）
• APIトークン（apiToken）
• Basic認証パスワード（basicAuthPassword）

• パスワード（password）

• 接続名（name）
• データベースタイプ（dbType）
• URL（url）
• ドライバー（driver）

• 接続名（name）
• URL（url）

• 接続名（name）
• ホスト名（hostName）
• プロトコル（protocol）
  「FTP」の場合は「ftp」、「SFTP」場合は「sftp」

• 接続名（name）
• ホスト名（hostName）
• 認証方法（authenticationType）
  「POP before SMTP認証」の場合は「POP3」、「SMTP認証」の場合は「SMTP」、認証を行わない場合は「NONE」
  「POP before SMTP認証」あるいは「SMTP認証」の場合は、次の個別の情報が取得できます。
• POP3サーバー名（pop3HostName）（「POP before SMTP認証」の場合）
• ユーザー名（userName）（「POP before SMTP認証」あるいは「SMTP認証」の場合）

• 接続名（name）
• ホスト名（hostName）
• ユーザー名（userName）

• 接続名（name）
• ホスト名（hostName）
• ユーザー名（userName）
• メールボックス（mailBox）

• アクセスキー（accessKey）
• シークレットキー（secretKey）
• リージョン（region）

• 接続名（name）
• URL（url）
• 認証方法（auth）
  「パスワード認証」の場合は「PASSWORD」、「APIトークン認証」の場合は「API TOKEN」
  「パスワード認証」の場合のみ次の「ログイン名」と「パスワード」が取得できます
  「APIトークン認証」の場合のみ次の「APIトークン」と「アプリID」が取得できます
• ログイン名（loginName）（「パスワード認証」の場合）
• パスワード（password）（「パスワード認証」の場合）
• APIトークン（apiToken）（「APIトークン認証」の場合）
• アプリID（appId）（「APIトークン認証」の場合）
• Basic認証（useBasicAuth）
  使用する場合は「true」、しない場合は「false」
  使用する場合のみ次の「Basic認証ログイン名」と「Basic認証パスワード」が取得できます
• Basic認証ログイン名 （basicAuthLoginName）（Basic認証を使用する場合）
• Basic認証パスワード （basicAuthPassword）（Basic認証を使用する場合）

• 接続名（name）
• JNDI接続名（jndi）
• ユーザー名（userName）
• Queue Connection Factory（queueConnectionFactory）

• 接続名（name）

• 接続名（name）

POST /mcapi/connection/create?ownerType=user&userName=/guest HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 217

{
    "rdb": {
        "name": "test",
        "dbType": "Oracle(Thin)",
        "url": "jdbc:oracle:thin:@oracle.test.com:53140:ORCL",
        "userName": "sa",
        "password": "",
        "driver": "oracle.jdbc.OracleDriver",
        "schema": "",
        "pool": true,
        "xa": false,
        "dynamic": false
    }
}

POST /mcapi/connection/create?ownerType=user&userName=/guest HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 139

{
    "generic": {
        "name": "test_generic",
        "parameters": {
            "param1": "abc"
        },
        "maskedParameters": {
            "param2": "123"
        },
        "connectionPool": true,
        "dynamic": false
    }
}

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行に成功するとコネクション情報を作成します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード	エラーコード	説明
400 Bad Request	2001	パラメーター type, ownerType の値が正しくなかった場合
	2002	パラメーター ownerType の値は設定されていなかった場合
	2101	Jsonデータの値が正しくなかった場合
	2102	Jsonデータの必須項目が入力されなかった場合
	2103	Jsonデータの値のタイプが正しくなかった場合
	2901	指定したコネクションの初期化でエラーが発生した場合
	2903	指定したコネクションと同じ名前のコネクションが既に存在する場合
	2904	不正なコネクション名が指定された場合
403 Forbidden	3001	ログインしていなかった場合
	3101	権限が不足していた場合
	3103	システムコネクションへのアクセスが拒否された場合
404 Not Found	4002	パラメーター userName で指定されたユーザーが存在しなかった場合
500 Internal Server Error	9002	設定ファイルの書き込みに失敗した場合
	5101	内部の通信に失敗した場合
	5102	サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: copy

コネクション情報を複製します。

administrator、developer

HTTPメソッド	リクエストURL
POST	http://{Hostname}:{Port}/mcapi/connection/copy

パラメーター	必須	説明
type	はい	コネクションタイプを指定します。 rdb - RDB http - HTTP ftp - FTP smtp - SMTP pop3 - POP3 imap4 - IMAP4 AWSConnection - AWS KintoneConnection - kintone queue - Queue jndi - JNDI generic - 汎用
srcName	はい	複製元のコネクション名を指定します。
destName	はい	新しく作られる複製先のコネクション名を指定します。
ownerType	はい	コネクション情報の種別を指定します。 「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName	いいえ	ユーザーコネクションのユーザー名を指定します。 ownerTypeが「user」のときのみ有効です。 指定しなかった場合はログインユーザーとなります。

POST /mcapi/connection/copy?type=rdb&srcName=test_conn&destName=copy_test_conn&ownerType=user HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行に成功するとコネクション情報を複製します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード	エラーコード	説明
400 Bad Request	2001	パラメーター type, ownerType の値が正しくなかった場合
	2002	パラメーター ownerType の値が設定されていなかった場合
	2901	指定したコネクションの初期化でエラーが発生した場合
	2903	パラメーター destName で指定したコネクション情報がすでに存在していた場合
403 Forbidden	3001	ログインしていなかった場合
	3101	権限が不足していた場合
	3103	システムコネクションへのアクセスが拒否された場合
404 Not Found	4002	パラメーター userName で指定されたユーザーが存在しなかった場合
	4005	パラメーター type, srcName で指定されたコネクション情報が存在しなかった場合
500 Internal Server Error	9002	設定ファイルの書き込みに失敗した場合
	5101	内部の通信に失敗した場合
	5102	サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: update

コネクション情報を変更します。

administrator、developer

HTTPメソッド	リクエストURL
POST	http://{Hostname}:{Port}/mcapi/connection/update

パラメーター	必須	説明
type	はい	コネクションタイプを指定します。 rdb - RDB http - HTTP ftp - FTP smtp - SMTP pop3 - POP3 imap4 - IMAP4 AWSConnection - AWS KintoneConnection - kintone queue - Queue jndi - JNDI generic - 汎用
name	はい	コネクション名を指定します。
ownerType	はい	コネクション情報の種別を指定します。 「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName	いいえ	取得するユーザーコネクションのユーザー名を指定します。 ownerTypeが「user」のときのみ有効です。 指定しなかった場合はログインユーザーとなります。

設定する情報は、createの設定情報と同じ形式でリクエストのボディに設定します。
更新する情報だけを設定します。
コネクション名を変更する場合は、パラメーター name に今のコネクション名を指定し、リクエストボディに新しいコネクション名を指定します。

POST /mcapi/connection/update?type=rdb&name=test&ownerType=user&userName=/guest HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 72

{
    "rdb": {
        "name": "test2",
        "password": "abc",
        "schema": "test",
        "dynamic": true
    }
}

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行に成功するとコネクション情報を変更します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード	エラーコード	説明
400 Bad Request	2001	パラメーター type, ownerType の値が正しくなかった場合
	2002	パラメーター type, ownerType, name の値は設定されていなかった場合
	2101	Jsonデータの値が正しくなかった場合
	2102	Jsonデータの必須項目が入力されなかった場合
	2103	Jsonデータの値のタイプが正しくなかった場合
	2108	Jsonデータのキーが正しくなかった場合
	2901	指定したコネクションの初期化でエラーが発生した場合
403 Forbidden	3001	ログインしていなかった場合
	3101	権限が不足していた場合
	3103	システムコネクションへのアクセスが拒否された場合
404 Not Found	4002	パラメーター userName で指定されたユーザーが存在しなかった場合
	4005	パラメーター type, name で指定されたコネクション情報が存在しなかった場合
500 Internal Server Error	9002	設定ファイルの書き込みに失敗した場合
	5101	内部の通信に失敗した場合
	5102	サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: delete

コネクション情報を削除します。

administrator、developer

HTTPメソッド	リクエストURL
POST	http://{Hostname}:{Port}/mcapi/connection/delete

パラメーター	必須	説明
type	はい	コネクションタイプを指定します。 rdb - RDB http - HTTP ftp - FTP smtp - SMTP pop3 - POP3 imap4 - IMAP4 AWSConnection - AWS KintoneConnection - kintone queue - Queue jndi - JNDI generic - 汎用
name	はい	コネクション名を指定します。
ownerType	はい	コネクション情報の種別を指定します。 「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName	いいえ	取得するユーザーコネクションのユーザー名を指定します。 ownerTypeが「user」のときのみ有効です。 指定しなかった場合はログインユーザーとなります。

POST /mcapi/connection/delete HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 49

type=rdb&name=test&ownerType=user&userName=/guest

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行に成功するとコネクション情報を削除します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード	エラーコード	説明
400 Bad Request	2001	パラメーター type, ownerType の値が正しくなかった場合
	2002	パラメーター type, ownerType, name の値は設定されていなかった場合
403 Forbidden	3001	ログインしていなかった場合
	3101	権限が不足していた場合
	3103	システムコネクションへのアクセスが拒否された場合
404 Not Found	4002	パラメーター userName で指定されたユーザーが存在しなかった場合
	4005	パラメーター type, name で指定されたコネクション情報が存在しなかった場合
500 Internal Server Error	9002	設定ファイルの書き込みに失敗した場合
	5101	内部の通信に失敗した場合
	5102	サーバー内部にエラーが発生した場合

▲ このページのトップへ