-
Notifications
You must be signed in to change notification settings - Fork 12
doc authenticator #154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
doc authenticator #154
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
25deaa6
doc authenticator
rolson 8d0f6bd
undo accidental changes
rolson 1f295a2
Update Documentation/Authenticator/README.md
rolson ee55443
Update Documentation/Authenticator/README.md
rolson 80fad71
Update Documentation/Authenticator/README.md
rolson 21ab2db
Update Documentation/Authenticator/README.md
rolson fd2fcb6
Update Documentation/README.md
rolson f49b052
Update README.md
rolson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Authentication Example App | ||
|
||
This is an application that shows how to use the Authenticator toolkit component to fully support ArcGIS authentication and network authentication in an application. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Authenticator | ||
|
||
Displays user interface when network and ArcGIS authentication challenges occur. | ||
|
||
## Features | ||
|
||
The Authenticator is a view modifier that will cause a prompt when the Authenticator is asked to handle an authentication challenge. This will handle many different types of authentication, for example: | ||
- ArcGIS authentication (token and OAuth) | ||
- Integrated Windows Authentication (IWA) | ||
- Client Certificate (PKI) | ||
|
||
The Authenticator can be configured to support securely persisting credentials to the keychain. | ||
|
||
## Behavior: | ||
|
||
The Authenticator view modifier will display an alert or a full screen modal view to prompt the user for credentials. | ||
|
||
## Usage | ||
|
||
```swift | ||
init() { | ||
// Create an authenticator. | ||
authenticator = Authenticator( | ||
// If you want to use OAuth, uncomment this code: | ||
//oAuthConfigurations: [.arcgisDotCom] | ||
) | ||
// Set the challenge handler to be the authenticator we just created. | ||
ArcGISRuntimeEnvironment.authenticationChallengeHandler = authenticator | ||
} | ||
|
||
var body: some SwiftUI.Scene { | ||
WindowGroup { | ||
HomeView() | ||
.authenticator(authenticator) | ||
.task { | ||
// Here we make the authenticator persistent, which means that it will synchronize | ||
// with they keychain for storing credentials. | ||
rolson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// It also means that a user can sign in without having to be prompted for | ||
// credentials. Once credentials are cleared from the stores ("sign-out"), | ||
// then the user will need to be prompted once again. | ||
try? await authenticator.setupPersistentCredentialStorage(access: .whenUnlockedThisDeviceOnly) | ||
} | ||
} | ||
} | ||
``` | ||
|
||
To see the `Authenticator` in action, check out the [Authentication Examples](../../AuthenticationExample) and refer to [AuthenticationApp.swift](../../AuthenticationExample/AuthenticationExample/AuthenticationApp.swift) in the project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.