iOS SDK
Integrate your iOS application with Authgear iOS SDK
This guide provides instructions on integrating Authgear with an iOS app. Supported platforms include:
iOS 11.0 or higher
Setup Application in Authgear
Signup for an Authgear Portal account in https://portal.authgear.com/. Or you can use your self-deployed Authgear.
From the Project listing, create a new Project or select an existing Project. After that, we will need to create an application in the project.
Step 1: Create an application in the Portal
Go to Applications on the left menu bar.
Click ⊕Add Application in the top tool bar.
Input the name of your application and select Native App as the application type. Click "Save".
You will see a list of guides that can help you for setting up, then click "Next".
Step 2: Configure the application
In your IDE (e.g. XCode), define a custom URI scheme that the users will be redirected back to your app after they have authenticated with Authgear, e.g.
com.myapp.example://host/path
.[^1]Head back to Authgear Portal, fill in the Redirect URI that you have defined in the previous steps.
Click "Save" in the top tool bar and keep the Client ID. You can also obtain it again from the Applications list later.
If you wish to validate JSON Web Token (JWT) in your own application server, turn on "Issue JWT as access token".[^2] If you wish to forward authentication requests to Authgear Resolver Endpoint, leave this unchecked. See comparisons in Backend Integration.
Install the SDK
CocoaPods
Swift Package Manager
Register URL Scheme for Redirect URI
In your application's Info.plist
, register your custom URL scheme, (e.g. com.myapp
).
Configuration Authgear SDK
SDK must be properly configured before use.
Trigger authenticate
When the user clicks login/signup on your app, you can use the following code to start authorization.
Your user is now logged in!
Get the Logged In State
When you start launching the application. You may want to know if the user has logged in. (e.g. Show users the login page if they haven't logged in). The sessionState
reflects the user logged in state in the SDK local state. That means even the sessionState
is .authenticated
, the session may be invalid if it is revoked remotely. After initializing the Authgear SDK, call fetchUserInfo
to update the sessionState
as soon as it is proper to do so.
The value of sessionState
can be .unknown
, .noSession
or .authenticated
. Initially, the sessionState
is .unknown
. After a call to authgear.configure
, the session state would become .authenticated
if a previous session was found, or .noSession
if such session was not found.
Fetching User Info
In some cases, you may need to obtain current user info through the SDK. (e.g. Display email address in the UI). Use the fetchUserInfo
function to obtain the user info, see example.
Using the Access Token in HTTP Requests
Call refreshAccessTokenIfNeeded
every time before using the access token, the function will check and make the network call only if the access token has expired. Include the access token into the Authorization header of your application request.
Logout
To log out the user from the current app session, you need to invoke thelogout
function.
Next steps
To protect your application server from unauthorized access. You will need to integrate your backend with Authgear.
Backend IntegrationiOS SDK Reference
For detailed documentation on the iOS SDK, visit iOS SDK Reference.
Footnote
[^1]: For further instruction on setting up custom URI scheme in iOS, see https://developer.apple.com/documentation/xcode/defining-a-custom-url-scheme-for-your-app [^2]: For more explanation on JWT, see https://en.wikipedia.org/wiki/JSON_Web_Token
Last updated