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

Documentation: Clarify how to provide Temporary Credentials when using a Custom Credentials Provider #160

Open
2 tasks
ruisebas opened this issue Jul 24, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation feature-request New feature or request

Comments

@ruisebas
Copy link
Member

ruisebas commented Jul 24, 2024

On which framework/platform would you like to see this feature implemented?

iOS

Which UI component is this feature-request for?

Liveness

Please describe your feature-request in detail.

The Custom Credentials Provider section under the Liveness startup guide has a simple code snippet on how to provide credentials:

struct MyCredentialsProvider: AWSCredentialsProvider {
    func fetchAWSCredentials() async throws -> AWSCredentials { 
        // Fetch the credentials
    }
}

However, if temporary credentials are provided, developers must return an instance of a type conforming to AWSTemporaryCredentials instead, otherwise the service will reject them.

Please describe a solution you'd like.

Just have a callout in this section stating that AWSTemporaryCredentials exists and when it should be used.

We love contributors! Is this something you'd be interested in working on?

  • 👋 I may be able to implement this feature request.
  • ⚠️ This feature might incur a breaking change.
@ruisebas ruisebas added the feature-request New feature or request label Jul 24, 2024
@github-actions github-actions bot added the pending-triage Issue is pending triage label Jul 24, 2024
@ruisebas ruisebas added documentation Improvements or additions to documentation and removed pending-triage Issue is pending triage labels Jul 24, 2024
@thaddmt thaddmt transferred this issue from aws-amplify/amplify-ui Jul 24, 2024
Copy link

This issue was opened by a maintainer of this repository; updates will be posted here. If you are also experiencing this issue, please comment here with any relevant information so that we're aware and can prioritize accordingly.

@thaddmt
Copy link
Member

thaddmt commented Jul 24, 2024

Transferring this task to the swift library as it seems specific to the Swift liveness component

@github-actions github-actions bot added pending-maintainer-response Issue is pending response from an Amplify team member and removed pending-maintainer-response Issue is pending response from an Amplify team member labels Dec 5, 2024
@ruisebas ruisebas changed the title FR (Docs): [iOS] [Liveness] Clarify how to provide temporary credentials when using a Custom Credentials Provider Documentation: Clarify how to provide Temporary Credentials when using a Custom Credentials Provider Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature-request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants