APIKeyAuth

public extension APIKeyAuth
Show on GitHub

  • Creates a user API key that can be used to authenticate as the current user. @param name The name of the API key to be created. @returns A publisher that eventually return UserAPIKey or Error.

    Declaration

    Swift

    func createAPIKey(named: String) -> Future<UserAPIKey, Error>
    Show on GitHub

  • Fetches a user API key associated with the current user. @param objectId The ObjectId of the API key to fetch. @returns A publisher that eventually return UserAPIKey or Error.

    Declaration

    Swift

    func fetchAPIKey(_ objectId: ObjectId) -> Future<UserAPIKey, Error>
    Show on GitHub

  • Fetches the user API keys associated with the current user. @returns A publisher that eventually return [UserAPIKey] or Error.

    Declaration

    Swift

    func fetchAPIKeys() -> Future<[UserAPIKey], Error>
    Show on GitHub

  • Deletes a user API key associated with the current user. @param objectId The ObjectId of the API key to delete. @returns A publisher that eventually return Result.success or Error.

    Declaration

    Swift

    func deleteAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
    Show on GitHub

  • Enables a user API key associated with the current user. @param objectId The ObjectId of the API key to enable. @returns A publisher that eventually return Result.success or Error.

    Declaration

    Swift

    func enableAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
    Show on GitHub

  • Disables a user API key associated with the current user. @param objectId The ObjectId of the API key to disable. @returns A publisher that eventually return Result.success or Error.

    Declaration

    Swift

    func disableAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
    Show on GitHub

  • Creates a user API key that can be used to authenticate as the current user. @param name The name of the API key to be created. @completion A completion that eventually return Result.success(UserAPIKey) or Result.failure(Error).

    Declaration

    Swift

    @preconcurrency
func createAPIKey(named: String, completion: @escaping @Sendable (Result<UserAPIKey, Error>) -> Void)
    Show on GitHub

  • Fetches a user API key associated with the current user. @param objectId The ObjectId of the API key to fetch. @completion A completion that eventually return Result.success(UserAPIKey) or Result.failure(Error).

    Declaration

    Swift

    @preconcurrency
func fetchAPIKey(_ objectId: ObjectId, _ completion: @escaping @Sendable (Result<UserAPIKey, Error>) -> Void)
    Show on GitHub

  • Fetches the user API keys associated with the current user. @completion A completion that eventually return Result.success([UserAPIKey]) or Result.failure(Error).

    Declaration

    Swift

    @preconcurrency
func fetchAPIKeys(_ completion: @escaping @Sendable (Result<[UserAPIKey], Error>) -> Void)
    Show on GitHub