ArcGIS supports secure access to ArcGIS services and portal items. It ensures that only valid, authorized users and services can access protected information. To access secure ArcGIS resources, you need an access token that you can obtain by implementing an authentication workflow in your app. The type of authentication you use will depend on the security and access requirements of your app.
There are three types of authentication that you can use to get an access token:
-
API key authentication: grants a long-lived access token to authenticate requests to ArcGIS services and secure portal items. For more information see the Introduction to API key authentication. To obtain an API key access token, go to the Create an API key tutorial using your ArcGIS account. Here you can configure the API key privileges to authorize access to different services and portal items.
-
User authentication: a collection of authentication workflows that connect your app to a user's ArcGIS account.
- OAuth 2.0: manage ArcGIS authentication and grant a short-lived access token generated via OAuth 2.0. This gives your application permission to access ArcGIS secured services authorized to an existing ArcGIS user's account. For more information see the OAuthUserCredential.
- Identity-Aware Proxy: manage identity-aware proxy authentication and grant a short-lived ID token generated from an Identity-Aware Proxy (IAP). This token gives your application permission to access the ArcGIS Enterprise portal and its services that are protected behind an Identity-Aware Proxy (IAP). ArcGIS Maps SDK for Swift currently supports the Microsort Entra Application Proxy via the Microsoft Identity Platform. For more information see the IAPCredential.
- Generate token: manages ArcGIS authentication and grants a short-lived access token generated via Esri's proprietary token-based authentication mechanism. This gives your application permission to access ArcGIS secured services authorized to an existing ArcGIS user's account. For more information see the TokenCredential and PregeneratedTokenCredential.
- Network credential: manage network authentication (also known as web-tier authentication) for ArcGIS Enterprise. This gives your application permission to access network secured services authorized to your web-tier's identity store user accounts. Supports Public Key Infrastructure (PKI), Integrated Windows Authentication (IWA), Kerberos, and HTTP Basic/Digest. For more information see the PasswordCredential, CertificateCredential, and ServerTrust.
-
App authentication: uses the registered application's credentials to access location services on ArcGIS. It manages ArcGIS authentication and grants a short-lived access token generated via OAuth 2.0 using the Application item's Client ID and Client Secret outside of the context of a user. For more information see the OAuthApplicationCredential.
Choose a type of authentication
The following considerations can help determine which type of authentication to implement:
-
Access to resources—Your app can access ArcGIS services and portal items using API key authentication, User authentication, or App authentication.
-
User experience—If you don't want to make users log in, your app can access ArcGIS services using API key authentication or App authentication. In this case, users will not need to have an ArcGIS account in order to use your app.
-
Usage charges—If you want service usage to be charged to the user's account, your app must request that the user log in using User authentication. When using API key authentication or App authentication, all access to services from your app will be charged to your ArcGIS account.
You might also need to consider the level of security required for your app, how your app will be distributed, and your available ArcGIS products and accounts.
Scenario | Solution |
---|---|
Your app requires access to ArcGIS services only, you don't want to make users log in, and you are willing to pay for all charges incurred from usage of the app. | API key authentication or App authentication |
Your app requires access to location services only and you want usage charged to the user. | User authentication |
Your app needs to access content that requires an ArcGIS Online subscription. | User authentication |
Your app needs to access private hosted data on your ArcGIS Location Platform account. | API key authentication or App authentication |
Your app allows users to view and edit private data hosted in ArcGIS Online or ArcGIS Enterprise. | User authentication |
You plan to distribute your app through ArcGIS Marketplace. | User authentication |
API key authentication
An API key can grant your public-facing application access to specific ArcGIS services and portal items.
Use API key authentication when you want to:
- Quickly write applications that consume ArcGIS services.
- Provide access to services without requiring users to sign in with an ArcGIS account.
To authorize your app to access secured resources, obtain a API key access token using the Create an API key tutorial. Set the API key access token on the ArcGISEnvironment
.
import SwiftUI
import ArcGIS
@main
struct MainApp: App {
init() {
ArcGISEnvironment.apiKey = APIKey("<#YOUR-ACCESS-TOKEN#>")
}
var body: some SwiftUI.Scene {
WindowGroup {
ContentView()
.ignoresSafeArea()
}
}
}
You will be able to view the app's usage telemetry on the respective ArcGIS Location Platform or ArcGIS Online account. You can also set the API key access token on any class that implements APIKeyResource
. This will override any access token you have set on the ArcGISEnvironment
and will enable more granular usage telemetry.
// Create a new ArcGIS basemap and apply an access token.
let basemap = Basemap(style: .arcGISNavigation)
basemap.apiKey = APIKey("<#YOUR-ACCESS-TOKEN#>")
// Create a new map with the basemap.
let map = Map(basemap: basemap)
Classes that implement APIKeyResource
include:
-
ArcGISSceneLayer
-
ArcGISTiledLayer
-
ArcGISVectorTiledLayer
-
Basemap
-
BasemapStylesService
-
ClosestFacilityTask
-
ExportTileCacheTask
-
ExportVectorTilesTask
-
GeodatabaseSyncTask
-
LocatorTask
-
RouteTask
-
ServiceAreaTask
-
ServiceFeatureTable
User authentication
User authentication is a set of authentication workflows that allow users with an ArcGIS account to sign into an application and access ArcGIS content, services, and resources. The typical authentication protocol used is OAuth2.0. When a user signs into an application with their ArcGIS account, an access token is generated that authorizes the application to access services and content on their behalf. The resources and functionality available depend on the user type, roles, and privileges of the user's ArcGIS account.
Services that your app accesses with user authentication will be billed to the authenticated user's ArcGIS account and its associated ArcGIS subscription. If your application will access your users' secure content in ArcGIS or if you plan to distribute your application through ArcGIS Marketplace, you must use user authentication.
Implement user authentication when you want to:
- Ensure users are signed in and authenticated with their own ArcGIS account.
- Use your app user's credits to pay for their private data, content, or service transactions.
- Limit the length of time users can be signed in to your app with a temporary token.
- Distribute your app through ArcGIS Marketplace.
App authentication
App authentication grants a short-lived access token, generated via OAuth 2.0, authorizing your application to access ArcGIS location services, such as basemap layers, search, and routing.
Use app authentication when you want to:
- Access location services with a more secure process and a short-lived token.
- Provide access to services without requiring users to have an ArcGIS account.
Authenticator toolkit component
In this SDK, all aspects of ArcGIS and network authentication have been encapsulated into a single ArcGIS Maps SDK for Swift toolkit component called the Authenticator. This component supports multiple types of authentication challenges, including ArcGIS authentication methods (OAuth, Identity-Aware Proxy (IAP), and ArcGIS token), Integrated Windows Authentication (IWA), and Client Certificate (PKI). It also provides default user interfaces for login prompts, certificate selection prompts, and server trust dialogs. For example, here is the default alert prompting the user for username and password credentials.

-
In the application's App struct, import the ArcGISToolkit and create an instance of the
Authenticator
. Ensure that the application'sAuthenticationManager
uses theauthenticator
to handle authentication challenges. Set the authenticator view modifier so that a prompt can be displayed if theauthenticator
is asked to handle an authentication challenge.Use dark colors for code blocks Copy import SwiftUI import ArcGIS import ArcGISToolkit struct AuthenticationApp: App { @ObservedObject var authenticator: Authenticator init() { // Creates an authenticator object. authenticator = Authenticator() // Sets the authenticator to handle authentication challenges. ArcGISEnvironment.authenticationManager.handleChallenges(using: authenticator) } var body: some SwiftUI.Scene { WindowGroup { ContentView() // Sets the authenticator view modifier. .authenticator(authenticator) } } }
-
If the
authenticator
is going to use OAuth or Identity-Aware Proxy (IAP), you must specify the necessary configurations in a task in the application'sbody
property.Use dark colors for code blocks Copy var body: some SwiftUI.Scene { WindowGroup { ContentView() // Sets the authenticator view modifier. .authenticator(authenticator) // Defines the OAuth or Identity-Aware Proxy (IAP) configurations. .task { authenticator.oAuthUserConfigurations.append( OAuthUserConfiguration( portalURL: URL(string: "Your client portal URL goes here")!, clientID: "Your client ID goes here", redirectURL: URL(string: "Your redirect URL goes here")! ) ) try? await authenticator.iapConfigurations.append( IAPConfiguration.configuration(from: URL(filePath: "Your IAP configuration JSON file path goes here")!) ) } } }
-
You can also configure the
authenticator
to persist credentials in the keychain. If the application is restarted, the store of credentials is automatically pre-populated with saved credentials and the user does not have to sign in again.Use dark colors for code blocks Copy // Persists the credentials in the keychain. .task { try? await ArcGISEnvironment.authenticationManager.setupPersistentCredentialStorage( access: .whenUnlockedThisDeviceOnly, synchronizesWithiCloud: false ) }
-
During application sign-out you should revoke all tokens then clear all credentials from the credentials stores.
Use dark colors for code blocks Copy // Revokes OAuth refresh and access tokens await ArcGISEnvironment.authenticationManager.revokeOAuthTokens() // Clears all ArcGIS and network credentials from their respective stores. await ArcGISEnvironment.authenticationManager.clearCredentialStores()
To see the Authenticator in action, check out the Authentication Example application and refer to Authentication
in your project.
Authentication manager
If you do not want to use the Authenticator toolkit component, you can manage the authentication process in your application code using the AuthenticationManager
. This is a static property of the ArcGISEnvironment
.
let authenticationManager = ArcGISEnvironment.authenticationManager
The AuthenticationManager
provides:
- Credential stores for your application to hold ArcGIS and network credentials that are automatically checked when your application attempts to connect to secure resources. These stores can be persisted in a keychain so that user does not have to sign in again when the application is re-launched. For more information, see Create and store credentials.
- ArcGIS and network challenge handlers that allow your application to respond to the authentication challenges. For example, you can write code to present the user with a login screen and then continue to authenticate with those credentials. For more information, see Handle authentication challenges.
Handle authentication challenges
If your application attempts to access a secure resource and there is no matching credential in the credential store, an authentication challenge is raised:
ArcGISAuthenticationChallenge
is raised if the ArcGIS secured resource requires OAuth, Identity-Aware Proxy (IAP), or ArcGIS Token authentication.NetworkAuthenticationChallenge
is raised if the ArcGIS secured resource requires network credentials, such as Integrated Windows Authentication (IWA) or Public Key Infrastructure (PKI).
You can catch and respond to these authentication challenges using the ArcGISAuthenticationChallengeHandler
and NetworkAuthenticationChallengeHandler
, respectively.
ArcGIS authentication challenge handler
The ArcGISAuthenticationChallengeHandler
is used to handle authentication challenges from ArcGIS secured resources that require OAuth, Identity-Aware Proxy (IAP), or ArcGIS Token authentication. Handle the challenge by returning the ArcGISAuthenticationChallenge.Disposition
with any of the following options:
continue
- Continue the challenge with the given credential.With Credential( ArcGIS Credential) continue
- The request that issued the authentication challenge will fail with the challenge's error.Without Credential cancel
- The request that issued the authentication challenge will fail withCancellation
.Error
-
Create a class that adopts the
ArcGISAuthenticationChallengeHandler
protocol to handle ArcGIS authentication challenges.Use dark colors for code blocks Copy @MainActor // Creates an ArcGIS authentication challenge handler final class MyArcGISChallengeHandler: ArcGISAuthenticationChallengeHandler { // The OAuth configurations that this challenge handler can work with. let oAuthUserConfigurations: [OAuthUserConfiguration] public init( oAuthUserConfigurations: [OAuthUserConfiguration] = [] ) { self.oAuthUserConfigurations = oAuthUserConfigurations } // Handles the challenge to an ArcGIS secured resource that requires OAuth or ArcGIS Token authentication. func handleArcGISAuthenticationChallenge( _ challenge: ArcGISAuthenticationChallenge ) async throws -> ArcGISAuthenticationChallenge.Disposition { // If an OAuth user configuration is available for the challenge then create an `OAuthUserCredential`. if let configuration = oAuthUserConfigurations.first(where: { $0.canBeUsed(for: challenge.requestURL) }) { return .continueWithCredential( try await OAuthUserCredential.credential(for: configuration) ) } else { // If not, prompt the user for a username and password to create a `TokenCredential`. // ... return .continueWithCredential( try await TokenCredential.credential(for: challenge, username: "username", password: "password") ) } } }
-
Set an instance of the class on the
AuthenticationManager.arcGISAuthenticationChallengeHandler
property of theArcGISEnvironment
.Use dark colors for code blocks Copy // Creates the challenge handler with desired OAuth user configurations and set it on the `AuthenticationManager`. let myArcGISChallengeHandler = MyArcGISChallengeHandler(oAuthUserConfigurations: [OAuthUserConfiguration(portalURL: URL(string: "my-portal-URL")!, clientID: "my-client-ID", redirectURL: URL(string: "my-redirect-URL")!)]) ArcGISEnvironment.authenticationManager.arcGISAuthenticationChallengeHandler = myArcGISChallengeHandler
Network authentication challenge handler
The NetworkAuthenticationChallengeHandler
is used to handle authentication challenges from ArcGIS secured resources that require network credentials, such as Integrated Windows Authentication (IWA) or Public Key Infrastructure (PKI). Handle the challenge by returning the NetworkAuthenticationChallenge.Disposition
with any of the following options:
continue
- Continue the challenge with the given credential.With Credential( Network Credential) continue
- The request that issued the authentication challenge will fail with the challenge's error.Without Credential cancel
- The request that issued the authentication challenge will fail withCancellation
.Error
-
Create a class that adopts the
NetworkAuthenticationChallengeHandler
protocol to handle Network authentication challenges.Use dark colors for code blocks Copy // Creates a Network authentication challenge handler final class MyNetworkChallengeHandler: NetworkAuthenticationChallengeHandler { func handleNetworkAuthenticationChallenge( _ challenge: NetworkAuthenticationChallenge ) async -> NetworkAuthenticationChallenge.Disposition { switch challenge.kind { case .ntlm, .basic, .digest: // Prompts the user for a username and password to create a `NetworkCredential`. // ... return .continueWithCredential(.password(username: "username", password: "password")) case .clientCertificate: // Prompts the user for a client certificate to create a `NetworkCredential`. // ... do { return .continueWithCredential(try .certificate(at: URL(fileURLWithPath: "/pathToCertificate"), password: "password")) } catch { return .continueWithoutCredential } case .serverTrust: // Prompts user to ask if they want to trust an untrusted host. // ... return .continueWithCredential(.serverTrust) case .negotiate: // Rejects the negotiate challenge so next authentication protection // space is tried. return .rejectProtectionSpace @unknown default: return .cancel } } }
-
Set an instance of the class on the
AuthenticationManager.networkAuthenticationChallengeHandler
property of theArcGISEnvironment
.Use dark colors for code blocks Copy // Creates the challenge handler and set it on the `AuthenticationManager`. let myNetworkChallengeHandler = MyNetworkChallengeHandler() ArcGISEnvironment.authenticationManager.networkAuthenticationChallengeHandler = myNetworkChallengeHandler
Create and store credentials
When an authentication challenge is raised, your application can create a credential that is held in the ArcGIS and network credential stores provided by the AuthenticationManager
.
ArcGISCredentialStore
stores ArcGIS credentials.NetworkCredentialStore
stores Network credentials.
These credential stores exist for the lifetime of the application. They ensure that an authentication challenge is only raised if a matching credential does not exists in the store. If you want to avoid prompting users for credentials between application sessions, persist the credential stores in the keychain by using the function make
on the authentication manager.
ArcGISEnvironment.authenticationManager.arcGISCredentialStore = try await .makePersistent(
access: .afterFirstUnlockThisDeviceOnly,
synchronizesWithiCloud: true
)
await ArcGISEnvironment.authenticationManager.setNetworkCredentialStore(
try await .makePersistent(access: .afterFirstUnlockThisDeviceOnly, synchronizesWithiCloud: true)
)
During application sign-out you should revoke all tokens and clear all credentials from the credential stores.
func signOut() async throws {
await revokeOAuthTokens()
await invalidateIAPCredentials()
arcGISCredentialStore.removeAll()
await networkCredentialStore.removeAll()
}
@discardableResult
func revokeOAuthTokens() async -> Bool {
let oAuthUserCredentials = arcGISCredentialStore.credentials.compactMap { $0 as? OAuthUserCredential }
return await withTaskGroup(of: Bool.self, returning: Bool.self) { group in
for credential in oAuthUserCredentials {
group.addTask {
do {
try await credential.revokeToken()
return true
} catch {
return false
}
}
}
return await group.allSatisfy(\.self)
}
}
@discardableResult
func invalidateIAPCredentials() async -> Bool {
let iapCredentials = arcGISCredentialStore.credentials.compactMap {
$0 as? IAPCredential
}
return await withTaskGroup(of: Bool.self, returning: Bool.self) { group in
for credential in iapCredentials {
group.addTask {
return (try? await credential.invalidate()) ?? false
}
}
return await group.allSatisfy(\.self)
}
}
ArcGIS credentials
You can access secured resources with user authentication or app authentication using any of the following credential types.
- OAuthUserCredential - A credential object used to access OAuth token-secured ArcGIS resources with a specific
OAuthUserConfiguration
. - IAPCredential - A credential object used to access ArcGIS Enterprise resources that are secured behind an Identity-Aware Proxy (IAP). You can create the credential using an
IAPConfiguration
. - OAuthApplicationCredential - A credential object used to access OAuth token-secured ArcGIS resources using the application's credentials.
- TokenCredential - A credential object used to access token-secured ArcGIS resources.
- PregeneratedTokenCredential - A credential object used to access token-secured ArcGIS resources using a token that is generated outside of your application.
If you know the services domain/server context, you can create an ArcGIS credential, independent of loading the specific resource and store it in the ArcGISCredentialStore
.
OAuthUserCredential
To create an OAuthUserCredential
, provide an OAuthUserConfiguration
with a valid portal URL, client ID, and redirect URL. This will present the OAuth sign in page for the user to enter their username and password. Once the OAuthUserCredential
is created, you will be able to access token information from the asynchronous token
property.
let configuration = OAuthUserConfiguration(
portalURL: URL(string: "portal-string")!,
clientID: "client-ID",
redirectURL: URL(string: "redirect-string")!
)
let credential = try await OAuthUserCredential.credential(for: configuration)
let tokenInfo = try await credential.tokenInfo
IAPCredential
The IAPCredential
supports access to an ArcGIS Enterprise portal and its services that are protected behind an Identity-Aware Proxy (IAP). ArcGIS Maps SDK for Swift currently supports the Microsort Entra Application Proxy via the Microsoft Identity Platform. To initiate an IAP authorization workflow, create an IAPConfiguration
to store your application's registration details and use it to create an IAPCredential
.
Use the following steps to create an IAPCredential
:
-
To establish trust between your application and the IAP, you administrator registers your application with the Microsoft Identity Platform. Following this, you will be able to review the client ID, tenant ID, redirect url, and so on.
-
Create an
IAPConfiguration
using these application registration details. Depending on your workflow, you can initialize anIAPConfiguration
by either providing the details in a JSON file or supplying them directly in the application's code.-
To initialize the
IAPConfiguration
with a JSON file, create a Microsort Entra Application Proxy JSON file containing the following key/value pairs:Use dark colors for code blocks Copy { "authorize_url" : "https://login.microsoftonline.com/<tenant_id>/oauth2/v2.0/authorize", "token_url" : "https://login.microsoftonline.com/<tenant_id>/oauth2/v2.0/token", "logout_url" : "https://login.microsoftonline.com/<tenant_id>/oauth2/v2.0/logout", "client_id" : "<client_id>", "redirect_url" : "<redirect_url>", "scope" : [ "<client_id>/.default", "offline_access", "openid", "profile" ], "hosts_behind_proxy" : ["*.domain.com"], "authorization_prompt_type" : "<empty string, none, login, consent, or select_account>" }
The keys are defined as follows:
- authorize_url - The authorize endpoint of the Identity-Aware Proxy (IAP) portal.
- token_url - The token endpoint of the Identity-Aware Proxy (IAP) portal.
- logout_url - The logout endpoint of the Identity-Aware Proxy (IAP) portal.
- client_id - A unique identifier associated with an application which is registered with the Identity-Aware Proxy (IAP) portal.
- redirect_url - The URL that the Identity-Aware Proxy (IAP) login and logout pages will redirect to when authentication completes. The scheme of this URL must be registered as a custom URL scheme in the application.
- scope - The scope of user's account.
- hosts_behind_proxy - The hosts to be accessed behind the Identity-Aware Proxy (IAP).
- authorization_prompt_type - The type of user interaction required for authentication and consent while signing in to the Identity-Aware Proxy (IAP).
-
Create the
IAPConfiguration
using theIAPConfiguration.configuration(from:)
initializer.Use dark colors for code blocks Copy static var iapConfigurationFromJSON: IAPConfiguration { get async throws { try await .configuration( from: URL(filePath: "/path/to/IAP configuration/file.json")! ) } }
If the JSON file is missing any required properties, this
IAPConfiguration
initializer will fail. -
Alternatively, create the
IAPConfiguration
by specifying each parameter in theIAPConfiguration.configuration
initializer.Use dark colors for code blocks Copy static var iapConfiguration: IAPConfiguration { try! .configuration( authorizeURL: URL(string: "https://login.microsoftonline.com/<tenant_id>/oauth2/v2.0/authorize")!, tokenURL: URL(string: "https://login.microsoftonline.com/<tenant_id>/oauth2/v2.0/token")!, logoutURL: URL(string: "https://login.microsoftonline.com/<tenant_id>/oauth2/v2.0/logout")!, clientID: "<client_id>", redirectURL: URL(string: "<redirect_url>")!, scopes: ["<client_id>/.default", "offline_access", "openid", "profile"], hostsBehindProxy: ["*.domain.com"]) }
Best Practice: To avoid storing secure information in you application's code, the recommended approach is to use the
IAPConfiguration.configuration(from:)
initializer uses a JSON file on disk to create aIAPConfiguration
. -
-
To ensure that the
IAPConfiguration
can be used when an authentication challenge is issued for IAP credential, callIAPConfiguration.canBeUsed(for:)
using a URL specified in the configuration’s hosts behind proxy.Use dark colors for code blocks Copy if iapConfiguration.canBeUsed(for: URL(string: "<ArcGIS Enterprise resource URL of host specified in hostsBehindProxy>")) { print("The IAP configuration supports access to the Identity-Aware Proxy.") } else { print("The IAP configuration can not be used for the given url. Review the configuration parameters.") }
-
Create the
IAPCredential
using theIAPConfiguration
. This will present the Microsoft sign-in page for the user to enter their username and password. Once theIAPCredential
is created, it will be added to theArcGISCredentialStore
and you will be able to access itstoken
property.Info Use dark colors for code blocks Copy let iapCredential = try await IAPCredential.credential(for: iapConfiguration) let tokenInfo = try await iapCredential.tokenInfo
-
During application sign-out, you must invalidate the credential by calling
IAPCredential.invalidate()
. This will present a Microsoft page that allows the user to sign-out. Note that after a successful sign-out, the user must click the Cancel button to return to your application.Use dark colors for code blocks Copy do { try await iapCredential.invalidate() } catch { print("IAP credential is not invalidated.") }
TokenCredential
To create a TokenCredential
, provide a secured service URL, valid username, and password. Optionally, you can specify token expiration minutes. Once a TokenCredential
is created, you will be able to access token information from the asynchronous token
property.
let credential = try await TokenCredential.credential(
for: URL(string: "portal-string")!,
username: "username",
password: "password",
tokenExpirationMinutes: 5
)
let tokenInfo = try await credential.tokenInfo
PregeneratedTokenCredential
To create a PregeneratedTokenCredential
, provide a previously generated short or long-lived access token. Use this credential when the access token is created using the generateToken REST endpoint directly. You must provide the referer if one was used while generating the token.
let tokenInfo = TokenInfo(
accessToken: "<access-token",
expirationDate: date,
isSSLRequired: true
)
let credential = PregeneratedTokenCredential(
url: URL(string: "service-string")!,
tokenInfo: tokenInfo!,
referer: "referer"
)
OAuthApplicationCredential
To create an OAuthApplicationCredential
, provide a valid portal URL, a client ID, and a client secret. Optionally, you can specify the token expiration in minutes. Once the OAuthApplicationCredential
is created, you will be able to access the token information from the asynchronous token
property.
let credential = try await OAuthApplicationCredential.credential(
for: URL(string: "portal-string")!,
clientID: "client-ID",
clientSecret: "client-secret",
tokenExpirationMinutes: 5
)
let tokenInfo = try await credential.tokenInfo
Network credentials
You can access resources secured by network authentication using the following credential types.
- PasswordCredential - A credential object that is used to authenticate HTTP Basic/Digest or Integrated Windows Authentication (IWA) secured resources.
- CertificateCredential - A credential object that is used to authenticate Client Certificate (PKI) secured resources.
- ServerTrust - A network credential that specifies that a server should be trusted.
PasswordCredential
The PasswordCredential
is used to authenticate HTTP Basic/Digest, Integrated Windows Authentication (IWA) secured resources. To create a PasswordCredential
, use a static function of NetworkCredential with username and a password.
// Password credential for HTTP Basic/Digest, Integrated Windows Authentication (IWA)
let passwordCredential = NetworkCredential.password(username: "my-username", password: "my-password")
CertificateCredential
A CertificateCredential
is used to authenticate Public Key Infrastructure (PKI) secured resources. To create a CertificateCredential
, use a static function of NetworkCredential
with the URL to a .p12
or .pfx
extension certificate file on disk and a password.
let credential = try NetworkCredential.certificate(at: URL(fileURLWithPath: "file URL to .p12 or .pfx file"), password: "password")
ServerTrust
To trust a development server that uses a self-signed certificate (untrusted host), create a NetworkCredential
and specify that the server should be trusted.
// Server trust credential for host with self-signed certificate
let credential = NetworkCredential.serverTrust