This class allows submitting credentials and events to any credential manager enabled on the system.
By informing credential managers of new, updated, removed, or revoked credentials, they can stay synchronized with the credential information of the person using the device.
In order to protect the user's privacy, `ASCredentialDataManager` does not indicate whether the operation succeeded.
A successful call only indicates that the parameters passed were well formed.
final func reportUnusedPasswordCredential(domain: String, userName: String) async throws
Report an unused password credential for a given domain and username. Password managers may remove or hide the password credential.
This information is shared with all password managers enabled in the system.
- Parameters:
- domain: The website domain that the credential is saved for.
- userName: The account user name.
- Throws: `ASAuthorizationError` if the system failed to accept the update.
final func reportPublicKeyCredentialUpdate(relyingPartyIdentifier: String, userHandle: Data, newName: String) async throws
Report an update to a credential's name, such as when changing the user name on an account.
This information is shared with all password managers enabled in the system.
- Parameters:
- relyingPartyIdentifier: Relying party (website) that the credential is saved for.
- userHandle: User identifier.
- newName: The new user name for the credential.
- Throws: `ASAuthorizationError` if the system failed to accept the update.
final func reportUnknownPublicKeyCredential(relyingPartyIdentifier: String, credentialID: Data) async throws
Report that a specific credential is unknown or no longer accepted. The credential may be removed or hidden by a password manager.
This information is shared with all password managers enabled in the system.
- Parameters:
- relyingPartyIdentifier: Relying party (website) that the credential is saved for.
- credentialID: An identifier that uniquely identifies this credential.
- Throws: `ASAuthorizationError` if the system failed to accept the update.
final func reportAllAcceptedPublicKeyCredentials(relyingPartyIdentifier: String, userHandle: Data, acceptedCredentialIDs: [Data]) async throws
Report a snapshot of all the credentialIDs that will be accepted for a `userHandle`. Credentials not present in the `acceptedCredentialIDs` may be removed or hidden by a password manager.
Relying party may choose to perform this periodically, e.g. on every sign in.
This information is shared with all password managers enabled in the system.
- Parameters:
- relyingPartyIdentifier: Relying party (website) that the credential is saved for.
- userHandle: User identifier.
- acceptedCredentialIDs: An array of identifiers that uniquely identifies the accepted credentials.
- Throws: `ASAuthorizationError` if the system failed to accept the update.
final func save(password: ASPasswordCredential, for scope: ASAutoFillURLScope, title: String? = nil, anchor: ASPresentationAnchor) async throws
Save or update a password credential to the user's preferred password manager in the system.
This functionality is equivalent to the saving behavior that occurs when submitting a form with a password field.
The credential will be associated with the scope.
- Parameters:
- password: The password credential to save.
- scope: The scope to associate this credential with.
- title: A custom title that credential managers may use to name the account.
- anchor: The anchor for which any UI should be presented from.
- Throws: `ASAuthorizationError` if the system failed to accept the update.
- Note: The scope's URL must be listed as an associated domain for Web Credentials for the current app _or_ the app must have the `com.apple.developer.web-browser` entitlement.
