Skip to content
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

Mds/okta 524282/okta 528021 update mobile sdk overview #4332

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

mauricesharp-okta
Copy link
Contributor

@mauricesharp-okta mauricesharp-okta commented Aug 22, 2023

Latest preview build (Sep 5 5:15PM Eastern)

Android/Kotlin
Swift/iOS

Description:

What's changed?

  • Updated the mobile SDK Overview for the latest versions of the Kotlin and Swift Okta Identity Engine SDK
  • Includes change some of the object types used in the sign-in flow, including InteractionCodeFlow
  • Updated images and tables to use new objects
  • Updated text to use new objects
  • Updated code in examples to use new objects
  • For Swift, updated the code to use InteractionCodeFlowDelegate and to publish the relevant state variables.

Is this PR related to a Monolith release?
No

Resolves:

- Updated main index and diagrams for modified object names.
- Initial update of iOS
- Added and modified new files for Android
Copy link

@rajdeepnanua-okta rajdeepnanua-okta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Left a suggestion for updating a diagram

Copy link
Contributor

@danielmaharry-okta danielmaharry-okta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird case of deja vu here in that the Kotlin SDK class diagram doesn't match the text. I know I did a PR review for you where this was also true. Also have suggested a few spots where code lines are too long for a midsized browser window. I don't know how easy it is to split Swift code over two lines though.

- Fine tuned text based on review comments
- Revised the Android flow image to use proper object names
- **Authenticator:** Represents an authenticator that's used to verify the identity of a user, such as Okta Verify.
- **Method:** Represents a channel for an authenticator, such as using SMS or voice for an authenticator that uses a phone. An authenticator may have zero or more.
- **Method:** Represents a channel for an authenticator, such as using SMS or voice for an authenticator that uses a phone. An authenticator may have zero or more methods.
- **Capability:** A user action associated with a remediation, authenticator, or method, such as requesting a new OTP or a password reset.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A capability can also indicate additional data associated with an authenticator that isn't always present. For example, a Password authenticator may sometimes return "PasswordSettings" to describe the password complexity requirements (usually only available when setting a new password). Another useful one is the "Profile" capability, which returns additional display information for the authenticator that can be used to render a UI (such as the redacted email address or phone number used within an authenticator).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How's this?

  • Capability: A user action or additional information that is associated with a remediation, authenticator, or method, such as requesting a new OTP or a redacted email.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Instead of "redacted email", I'd clarify further, such as: "or the email address or phone number associated with the authenticator (redacted for security)."

@mikenachbaur-okta
Copy link
Contributor

For the Swift samples, is it using the new code in the SwiftUI-Improvements branch?

Copy link
Contributor

@danielmaharry-okta danielmaharry-okta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mauricesharp-okta
Copy link
Contributor Author

/netlify preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants