UCIDM API

UCIDM は ID 連携のための Web API を提供します。

認証を必要としない Web API

例えば、API サーバーとの疎通確認のために使う ping API は次のように実行します。

$ curl "https://${ホスト名}:${ポート番号}/status/ping"
{
  "message": "pong",
  "remoteAddr": "172.18.0.1:54960",
  "realIP": "172.18.0.1",
  "updatedAt": "2024-11-28T08:07:08.680627934Z"
}

他にも UCIDM のバージョン情報を取得もできます。

$ curl "https://${ホスト名}:${ポート番号}/status/version"
{
  "serverVersion": "f8802cf",
  "idFederationClientVersion": "ef562e7",
  "mongoDBVersion": "8.0.3",
  "rabbitMQVersion": "4.0.3"
}

認証を必要とする Web API

UCIDM の大半の Web API を呼び出すには認証を必要とします。UCIDM は次の認証に対応しています。

• ベーシック認証
• アカウント認証
• LDAP 認証
• SAML 認証

例えば、ベーシック認証であれば次のように実行します。

$ curl --basic --user "unico:${Basic 認証パスワード}" \
       "https://${ホスト名}:${ポート番号}/p/ping"
{
  "message": "pong",
  "remoteAddr": "172.18.0.1:54960",
  "realIP": "172.18.0.1",
  "updatedAt": "2024-11-28T08:07:08.680627934Z"
}

認証を行わない場合は 401 エラーが返ります。

$ curl -i "https://${ホスト名}:${ポート番号}/p/ping"
HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=UTF-8
Www-Authenticate: basic realm=Restricted
Date: Mon, 26 Feb 2024 05:28:45 GMT
Content-Length: 27

{"message":"Unauthorized"}

UCIDM API ドキュメント

Web API の仕様については UCIDM API に同梱している次のドキュメントを参照してください。

https://${ホスト名}:${ポート番号}/docs