OAuth2API

open class OAuth2API

OAuth2.0に関連するAPIへアクセスする機能を提供するクラス。

  • intdashとの間に張られたセッションの情報。

    Declaration

    Swift

    public var session: IntdashClient.Session?

  • OAuth2APIを生成します。

    Declaration

    Swift

    public init(session: IntdashClient.Session?)

    Parameters

    session

    セッション情報

  • アクセストークンを更新します。

    Declaration

    Swift

    public func refresh(completion: @escaping (_ response: OAuth2RefreshResponse?, _ error: RESTError?) -> ())

    Parameters

    completion

    処理終了時のコールバック
    response

    レスポンスデータ
    error

    エラー情報

  • 外部認証を行うURLを生成します。

    Declaration

    Swift

    public func generateAuthorizationURL(callbackURLScheme: String, completion: @escaping (_ url: String?, _ codeVerifier: String?, _ state: String?, _ error: RESTError?) -> ())

    Parameters

    callbackURLScheme

    リダイレクトURI(コールバックスキーマ)
    completion

    処理終了時のコールバック
    url

    外部認証用のURL
    codeVerifier

    生成された検証コード
    state

    CSRF対策の状態コード
    error

    エラー情報

  • 外部認証で取得した認証コードを使用してアクセストークンを取得します。 認証に成功すると、セッション情報にアクセストークンがセットされます。

    Declaration

    Swift

    public func authenticate(code: String, codeVerifier: String, callbackURLScheme: String, completion: @escaping (_ response: OAuth2AuthenticateResponse?, _ error: RESTError?) -> ())

    Parameters

    code

    外部認証で取得した認証コード
    codeVerifier

    生成された検証コード
    generateAuthorizationURL(callbackURLScheme:completion:) のコールバックで返却される codeVerifier を使用してください。
    callbackURLScheme

    リダイレクトURI(コールバックスキーマ)
    completion

    処理終了時のコールバック
    response

    レスポンスデータ
    error

    エラー情報