APIKeyAuth
public extension APIKeyAuth
-
現在のユーザーとして認証するために使用できるユーザー API キーを作成します。 @ param name 作成する API キーの名前。 @returns は最終的に
UserAPIKey
またはError
を返す出版社を返します。宣言
Swift
func createAPIKey(named: String) -> Future<UserAPIKey, Error>
-
現在のユーザーに関連付けられているユーザー API キーを取得します。 @ObjectId ObjectIdAPI取得する キーの 。@returns は最終的に
UserAPIKey
またはError
を返す出版社を返します。宣言
Swift
func fetchAPIKey(_ objectId: ObjectId) -> Future<UserAPIKey, Error>
-
現在のユーザーに関連付けられているユーザー API キーを取得します。 @returns は最終的に
[UserAPIKey]
またはError
を返す出版社を返します。宣言
Swift
func fetchAPIKeys() -> Future<[UserAPIKey], Error>
-
現在のユーザーに関連付けられているユーザー API キーを削除します。 @ObjectId ObjectIdAPI削除する キーの 。@returns は最終的に
Result.success
またはError
を返す出版社を返します。宣言
Swift
func deleteAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
-
現在のユーザーに関連付けられているユーザー API キーを有効にします。 @ObjectId ObjectIdAPI有効にする キーの 。@returns は最終的に
Result.success
またはError
を返す出版社を返します。宣言
Swift
func enableAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
-
現在のユーザーに関連付けられているユーザー API キーを無効にします。 @ObjectId 無効にするObjectId APIキーの 。@returns は最終的に
Result.success
またはError
を返す出版社を返します。宣言
Swift
func disableAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
-
現在のユーザーとして認証するために使用できるユーザー API キーを作成します。 @ param name 作成する API キーの名前。 @completed 最終的に
Result.success(UserAPIKey)
またはResult.failure(Error)
を返す完了。宣言
Swift
@preconcurrency func createAPIKey(named: String, completion: @escaping @Sendable (Result<UserAPIKey, Error>) -> Void)
-
現在のユーザーに関連付けられているユーザー API キーを取得します。 @ObjectId ObjectIdAPI取得する キーの 。@completed 最終的に
Result.success(UserAPIKey)
またはResult.failure(Error)
を返す完了。宣言
Swift
@preconcurrency func fetchAPIKey(_ objectId: ObjectId, _ completion: @escaping @Sendable (Result<UserAPIKey, Error>) -> Void)
-
現在のユーザーに関連付けられているユーザー API キーを取得します。 @completion A completion that eventually return
Result.success([UserAPIKey])
orResult.failure(Error)
.宣言
Swift
@preconcurrency func fetchAPIKeys(_ completion: @escaping @Sendable (Result<[UserAPIKey], Error>) -> Void)