APIDoc Build Status - Master macOS Linux Apache 2 Slack Status


Plugin for the Credentials framework that authenticates using Facebook.


Plugin for the Kitura-Credentials framework that authenticates using the Facebook web login with OAuth and a Facebook OAuth token that was acquired by a mobile app or other client of the Kitura based backend.

Swift version

The latest version of Kitura-CredentialsFacebook requires Swift 4.0 or newer. You can download this version of the Swift binaries by following this link. Compatibility with other Swift versions is not guaranteed.


Add dependencies

Add the Kitura-CredentialsFacebook and Credentials packages to the dependencies within your application’s Package.swift file. Substitute "x.x.x" with the latest Kitura-CredentialsFacebook release and the latest Kitura-Credentials release.

.package(url: "", from: "x.x.x")
.package(url: "", from: "x.x.x")

Add CredentialsFacebook and Credentials to your target’s dependencies:

.target(name: "example", dependencies: ["CredentialsFacebook", "Credentials"]),

Import packages

import Credentials
import CredentialsFacebook

Example of Facebook web login

A complete sample can be found in Kitura-Sample.

First set up the session:

import KituraSession

router.all(middleware: Session(secret: "Very very secret..."))

Create an instance of CredentialsFacebook plugin and register it with the Credentials framework:

import Credentials
import CredentialsFacebook

let credentials = Credentials()
let fbCredentials = CredentialsFacebook(clientId: fbClientId,
                                        clientSecret: fbClientSecret,
                                        callbackUrl: serverUrl + "/login/facebook/callback",
                                        options: options)


  • fbClientId is the App ID of your app in the Facebook Developer dashboard
  • fbClientSecret is the App Secret of your app in the Facebook Developer dashboard
  • options is an optional dictionary ([String:Any]) of Facebook authentication options whose keys are listed in CredentialsFacebookOptions

Note: The callbackUrl parameter above is used to tell the Facebook web login page where the user’s browser should be redirected when the login is successful. It should be a URL handled by the server you are writing. Specify where to redirect non-authenticated requests:

credentials.options["failureRedirect"] = "/login/facebook"

Connect credentials middleware to requests to /private:

router.all("/private", middleware: credentials)
router.get("/private/data", handler:
    { request, response, next in

And call authenticate to login with Facebook and to handle the redirect (callback) from the Facebook login web page after a successful login:

           handler: credentials.authenticate(

           handler: credentials.authenticate(

Example of authentication with Facebook OAuth token

This example shows how to use CredentialsFacebookToken plugin to authenticate post requests, it shows both the server side and the client side of the request involved.

Server side

First create an instance of Credentials and an instance of CredentialsFacebookToken plugin:

import Credentials
import CredentialsFacebook

let credentials = Credentials()
let fbCredentials = CredentialsFacebookToken(options: options)


  • options is an optional dictionary ([String:Any]) of Facebook authentication options whose keys are listed in CredentialsFacebookOptions.

Now register the plugin:


Connect credentials middleware to post requests:"/collection/:new", middleware: credentials)

If the authentication is successful, request.userProfile will contain user profile information received from Facebook:"/collection/:new") {request, response, next in
  let profile = request.userProfile
  let userId =
  let userName = profile.displayName

Client side

The client needs to put Facebook access token in request’s access_token HTTP header field, and “FacebookToken” in X-token-type field:

let urlRequest = NSMutableURLRequest(URL: NSURL(string: "http://\(serverUrl)/collection/\(name)"))
urlRequest.HTTPMethod = "POST"
urlRequest.HTTPBody = ...

urlRequest.addValue(FBSDKAccessToken.currentAccessToken().tokenString, forHTTPHeaderField: "access_token")
urlRequest.addValue("FacebookToken", forHTTPHeaderField: "X-token-type")            

Alamofire.request(urlRequest).responseJSON {response in

API documentation

For more information visit our API reference.


We love to talk server-side Swift, and Kitura. Join our Slack to meet the team!


This library is licensed under Apache 2.0. Full license text is available in LICENSE.