logout

AppDelegate.reachfive().logout()

Description

Kills the main SSO session as well as all provider sessions.

Use the Revoke refresh token endpoint to invalidate all active user tokens on a specific client_id.

Examples

AppDelegate
  .reachfive()
  .logout()
  .onSuccess{ _ in
      // Do something
  }
  .onFailure { error in
      // Return a ReachFive error
  }

Response

Type: Future<(), ReachFiveError>

ReachFiveError

Based on the problem, the ReachFiveError will be:

  • RequestError(requestErrors: RequestErrors) if it’s a bad request error.

    error string

    The main error message.

    errorId string

    The identifier of the error.

    errorUserMsg string

    The user-friendly error message.

    This property is translated according to the user’s browser settings. Currently supported languages:
    Currently supported languages

    • de - Deutsch German

    • en - English

    • es - Español Spanish

    • fr - Français French

    • hu - Magyar Hungarian

    • it - Italiano Italian

    • nl - Nederlands Dutch

    • ru - Ру́сский Russian

    • sk - Slovenský Slovak

    • pt - Portuguese

    errorMessageKey string

    The error message key.

    errorDescription string

    The technical error message.

    errorDetails FieldError[]

    field string

    The field concerned by the error.

    message string

    The message error returned for the field.

    code string

    The code error returned for the field.

  • AuthFailure(reason: String) if the authentication has failed.

  • AuthCanceled if the authentication was cancelled.

  • TechnicalError(reason: String) if it’s an internal server error.