DigestProtocol: auth()

認証取得処理を実行します。

通常は認証エージェントから呼び出されるので、開発者が呼び出す必要はありません。

この関数は非同期関数です。

構文

digestProtocol.auth() => Promise<{ ok, entity, falied, info }>
digestProtocol.auth(options) => Promise<{ ok, entity, falied, info }>

引数

• options: { [protocolId][, retryUnauth] }?

  以下のプロパティを持つ省略可能なオブジェクトです。

  • protocolId: string?

    プロトコル名です。AuthAgent でオブジェクトリテラルを渡していた場合はそのキー名が、そうでなければ AuthAgent.login() で渡された protocolId が渡されます。

  • retryUnauth: string

    認証に失敗したときに再度認証処理を行うかどうかを表す論理値です。自動ログインなど再認証を無効にしたいときは false に設定してください。

    • 既定値は true です。

返値: Promise<({ ok, entity, failed, info })>

以下のプロパティを持つオブジェクトを返すプロミスです。

• ok: boolean

  認証取得に成功したかどうかです。

• entity: AuthEntity | undefined

  取得された認証情報を保持するエンティティです。

• failed: { code, message } | undefined

  認証取得失敗時の失敗理由を表す、以下のプロパティを持つオブジェクトです。

  • code: string

    失敗コードです。

  • message: string

    失敗理由を示すメッセージです。

• info: any | undefined

  認証取得成功時はレスポンスボディです。