IMAP/CalDAV ログイン API

    IdP 側で「図4 SAML 2.0 による API 認証」の 3~4 のプロセスにあたるロジックを実装し、IMAP/CalDAV を通じて LINE WORKS サービスをで使用できるようにするための API です。

    IdP 側の認証システムで SAML Request を検証後に Base64 エンコードされた ID およびパスワードを用いてユーザー認証を行い、SAML Response を生成して ACS URL に返します。

    注意

    • SSO システム側でアカウントロックなどの機能を実装している場合、 IMAP/CalDAV ログインの際にユーザーの登録ミスによるアクセスエラー等によりアカウントがロックされることがあります。この API については例外処理することをお勧めします。

    Request URL

    https://クライアントドメイン/API ログイン

    ユーザーパスワードを取り扱うため、必ず SSL(https) を使用してください。

    作成した Request URL は、Developer Console の SSO 設定ページにて IMAP/CalDAV Login API に登録します。

    図21 SAML 2.0 による IMAP/CalDAV ログイン API の登録

    図21 SAML 2.0 による IMAP/CalDAV ログイン API の登録

    HTTP Method

    POST

    Request

    パラメータ タイプ 必須 説明
    email String Y メールアドレス(LINE WORKS のログイン ID)(Base64 でエンコードした値)
    password String Y パスワード(Base64 でエンコードした値)
    SAMLRequest String Y SAML 2.0 Request 形式に従った文字列(Base64 でエンコードした値)
    RelayState String Y 認証に失敗した場合の再試行のための URL。(モバイルでは使用しない。)

    Response

    以下のデータを JSON 形式で作成し HTTP-POST で渡します。

    プロパティ タイプ 必須 説明
    SAMLResponse String Y SAML 2.0 Response 形式に従った文字列(Base64 でエンコードした値)
    RelayState String Y 認証に失敗した場合の再試行のための URL。(モバイルでは使用しない。)