APIKeyAuth
public extension APIKeyAuth
-
Cria uma chave de API do usuário que pode ser usada para autenticar como o usuário atual. @param name O nome da chave API a ser criada. @returns Um editor que eventualmente retorna
UserAPIKey
ouError
.Declaração
Swift
func createAPIKey(named: String) -> Future<UserAPIKey, Error>
-
Busca uma chave de API de usuário associada ao usuário atual. @param objectId O ObjectId da chave de API a ser buscada. @returns Um editor que eventualmente retorna
UserAPIKey
ouError
.Declaração
Swift
func fetchAPIKey(_ objectId: ObjectId) -> Future<UserAPIKey, Error>
-
Busca as chaves de API do usuário associadas ao usuário atual. @returns Um editor que eventualmente retorna
[UserAPIKey]
ouError
.Declaração
Swift
func fetchAPIKeys() -> Future<[UserAPIKey], Error>
-
Exclui uma chave de API de usuário associada ao usuário atual. @param objectId O ObjectId da chave de API a ser excluída. @returns Um editor que eventualmente retorna
Result.success
ouError
.Declaração
Swift
func deleteAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
-
Habilita uma chave de API de usuário associada ao usuário atual. @param objectId O ObjectId da chave de API a ser habilitada. @returns Um editor que eventualmente retorna
Result.success
ouError
.Declaração
Swift
func enableAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
-
Desabilita uma chave de API de usuário associada ao usuário atual. @param objectId O ObjectId da chave de API a ser desabilitada. @returns Um editor que eventualmente retorna
Result.success
ouError
.Declaração
Swift
func disableAPIKey(_ objectId: ObjectId) -> Future<Void, Error>
-
Cria uma chave de API do usuário que pode ser usada para autenticar como o usuário atual. @param name O nome da chave API a ser criada. @completion Uma conclusão que eventualmente retorna
Result.success(UserAPIKey)
ouResult.failure(Error)
.Declaração
Swift
func createAPIKey(named: String, completion: @escaping (Result<UserAPIKey, Error>) -> Void)
-
Busca uma chave de API de usuário associada ao usuário atual. @param objectId O ObjectId da chave de API a ser buscada. @completion Uma conclusão que eventualmente retorna
Result.success(UserAPIKey)
ouResult.failure(Error)
.Declaração
Swift
func fetchAPIKey(_ objectId: ObjectId, _ completion: @escaping (Result<UserAPIKey, Error>) -> Void)
-
Busca as chaves de API do usuário associadas ao usuário atual. @completion Uma conclusão que eventualmente retorna
Result.success([UserAPIKey])
ouResult.failure(Error)
.Declaração
Swift
func fetchAPIKeys(_ completion: @escaping (Result<[UserAPIKey], Error>) -> Void)