付録

    付録


    記事の要約

    応答コード

    成功

    200: OK
    リクエストが成功した (201の場合を除く)
    201: Created
    リクエストが成功し、新たなリソースを作成した

    クライアントエラー

    400: Bad Request
    パラメータが正しくない
    401: Unauthorized
    認証情報が正しくない
    403: Forbidden
    権限がない
    404: Not Found
    URLで指定した対象が存在しない
    405: Method Not Allowed
    メソッドが正しくない
    409: Conflict
    操作が競合した
    429: Too Many Requests
    リクエスト数が超過した (同一IPアドレスから1分間あたり200件まで)

    サーバエラー

    500: Internal Server Error
    システムの問題でリクエストを処理できない

    認証情報 (Authorizationヘッダ)

    OAuth 2.0
    Bearerアクセストークン
    • アクセストークンは、OAuthトークン取得APIで取得
    APIトークン
    Bearerアクセストークン
    • アクセストークンは、Web Consoleの [システム設定] > [WebAPI認証設定] > [APIトークン] で設定
    Basic認証
    BasicクライアントIDとパスワードをコロンを区切り文字として結合してBase64エンコードした文字列
    • クライアントID、パスワードは、Web Consoleの [システム設定] > [WebAPI認証設定] > [Basic認証] で設定

    パラメータ

    • 日時(string <date-time>)を指すパラメータのフォーマットは、"yyyy-mm-ddThh:mm:ss.sssZ" 形式(UTC)とする。

    コード一覧

    ターゲット種別ID

    1. Active Directory
    2. Windows
    3. Linux
    4. Solaris
    5. HP-UX
    6. AIX
    7. SQL Server
    8. Oracle (Windows)
    9. Oracle (UNIX/Linux)
    10. VMware vSphere ESXi
    11. AWS Management Console (IAM)
    12. PostgreSQL (Linux)
    13. vCenter Server Appliance
    14. Microsoft Entra ID
    15. MySQL
    16. Db2
    17. Salesforce
    18. HiRDB
    19. Azure SQL Database
    20. Amazon RDS for SQL Server
    21. AWS Managed Microsoft AD
    22. AWS Simple AD
    23. Amazon Redshift
    24. Amazon Aurora PostgreSQL
    25. Amazon Aurora MySQL
    26. Amazon RDS for PostgreSQL
    27. Amazon RDS for MySQL
    28. PostgreSQL (Windows)
    29. Box
    30. Google
    31. Amazon RDS for MariaDB
    32. Amazon RDS for Oracle
    33. MariaDB
    34. Oracle Cloud Infrastructure (IAM)
    35. IBM Cloud (IAM)
    36. LDAP
    37. DocuSign eSignature
    38. cybozu.com
    39. Others
    40. CloudSign