ktor-client-auth
Module Contents
alltypes
Module Contents
class
Auth
Module Contents
Auth
(
providers
:
MutableList
<
AuthProvider
>
=
mutableListOf()
)
companion
object
Feature
:
HttpClientFeature
<
Auth
,
Auth
>
Module Contents
fun
install
(
feature
:
Auth
,
scope
:
HttpClient
)
:
Unit
val
key
:
AttributeKey
<
Auth
>
fun
prepare
(
block
:
Auth
.
(
)
->
Unit
)
:
Auth
fun
install
(
feature
:
Auth
,
scope
:
HttpClient
)
:
Unit
val
key
:
AttributeKey
<
Auth
>
fun
prepare
(
block
:
Auth
.
(
)
->
Unit
)
:
Auth
val
providers
:
MutableList
<
AuthProvider
>
interface
AuthProvider
Module Contents
abstract
suspend
fun
addRequestHeaders
(
request
:
HttpRequestBuilder
)
:
Unit
abstract
fun
isApplicable
(
auth
:
HttpAuthHeader
)
:
Boolean
open
suspend
fun
refreshToken
(
response
:
HttpResponse
)
:
Boolean
abstract
val
sendWithoutRequest
:
Boolean
open
fun
sendWithoutRequest
(
request
:
HttpRequestBuilder
)
:
Boolean
class
BasicAuthConfig
Module Contents
BasicAuthConfig
(
)
fun
credentials
(
block
:
suspend
(
)
->
BasicAuthCredentials
?
)
:
Unit
lateinit
var
password
:
String
var
realm
:
String
?
var
sendWithoutRequest
:
Boolean
fun
sendWithoutRequest
(
block
:
(
HttpRequestBuilder
)
->
Boolean
)
:
Unit
lateinit
var
username
:
String
class
BasicAuthCredentials
Module Contents
BasicAuthCredentials
(
username
:
String
,
password
:
String
)
val
password
:
String
val
username
:
String
class
BasicAuthProvider
:
AuthProvider
Module Contents
BasicAuthProvider
(
username
:
String
,
password
:
String
,
realm
:
String
?
=
null
,
sendWithoutRequest
:
Boolean
=
false
)
BasicAuthProvider
(
credentials
:
suspend
(
)
->
BasicAuthCredentials
?
,
realm
:
String
?
=
null
,
sendWithoutRequestCallback
:
(
HttpRequestBuilder
)
->
Boolean
=
{ false }
)
suspend
fun
addRequestHeaders
(
request
:
HttpRequestBuilder
)
:
Unit
fun
isApplicable
(
auth
:
HttpAuthHeader
)
:
Boolean
suspend
fun
refreshToken
(
response
:
HttpResponse
)
:
Boolean
val
sendWithoutRequest
:
Boolean
fun
sendWithoutRequest
(
request
:
HttpRequestBuilder
)
:
Boolean
class
BearerAuthConfig
Module Contents
BearerAuthConfig
(
)
fun
loadTokens
(
block
:
suspend
(
)
->
BearerTokens
?
)
:
Unit
var
realm
:
String
?
fun
refreshTokens
(
block
:
suspend
(
response
:
HttpResponse
)
->
BearerTokens
?
)
:
Unit
fun
sendWithoutRequest
(
block
:
(
HttpRequestBuilder
)
->
Boolean
)
:
Unit
class
BearerAuthProvider
:
AuthProvider
Module Contents
BearerAuthProvider
(
refreshTokens
:
suspend
(
response
:
HttpResponse
)
->
BearerTokens
?
,
loadTokens
:
suspend
(
)
->
BearerTokens
?
,
sendWithoutRequestCallback
:
(
HttpRequestBuilder
)
->
Boolean
=
{ true }
,
realm
:
String
?
)
suspend
fun
addRequestHeaders
(
request
:
HttpRequestBuilder
)
:
Unit
suspend
fun
clearToken
(
)
:
Unit
fun
isApplicable
(
auth
:
HttpAuthHeader
)
:
Boolean
suspend
fun
refreshToken
(
response
:
HttpResponse
)
:
Boolean
val
sendWithoutRequest
:
Boolean
fun
sendWithoutRequest
(
request
:
HttpRequestBuilder
)
:
Boolean
class
BearerTokens
Module Contents
BearerTokens
(
accessToken
:
String
,
refreshToken
:
String
)
val
accessToken
:
String
val
refreshToken
:
String
class
DigestAuthConfig
Module Contents
DigestAuthConfig
(
)
var
algorithmName
:
String
fun
credentials
(
block
:
suspend
(
)
->
DigestAuthCredentials
?
)
:
Unit
var
password
:
String
var
realm
:
String
?
var
username
:
String
class
DigestAuthCredentials
Module Contents
DigestAuthCredentials
(
username
:
String
,
password
:
String
)
val
password
:
String
val
username
:
String
class
DigestAuthProvider
:
AuthProvider
Module Contents
DigestAuthProvider
(
username
:
String
,
password
:
String
,
realm
:
String
?
=
null
,
algorithmName
:
String
=
"MD5"
)
DigestAuthProvider
(
credentials
:
suspend
(
)
->
DigestAuthCredentials
?
,
realm
:
String
?
=
null
,
algorithmName
:
String
=
"MD5"
)
suspend
fun
addRequestHeaders
(
request
:
HttpRequestBuilder
)
:
Unit
val
algorithmName
:
String
fun
isApplicable
(
auth
:
HttpAuthHeader
)
:
Boolean
val
password
:
String
val
realm
:
String
?
suspend
fun
refreshToken
(
response
:
HttpResponse
)
:
Boolean
val
sendWithoutRequest
:
Boolean
fun
sendWithoutRequest
(
request
:
HttpRequestBuilder
)
:
Boolean
val
username
:
String
io.ktor.client.HttpClientConfig
Module Contents
fun
HttpClientConfig
<
*
>
.
Auth
(
block
:
Auth
.
(
)
->
Unit
)
:
Unit
package
io.ktor.client.features.auth
Module Contents
class
Auth
Module Contents
Auth
(
providers
:
MutableList
<
AuthProvider
>
=
mutableListOf()
)
companion
object
Feature
:
HttpClientFeature
<
Auth
,
Auth
>
Module Contents
fun
install
(
feature
:
Auth
,
scope
:
HttpClient
)
:
Unit
val
key
:
AttributeKey
<
Auth
>
fun
prepare
(
block
:
Auth
.
(
)
->
Unit
)
:
Auth
fun
install
(
feature
:
Auth
,
scope
:
HttpClient
)
:
Unit
val
key
:
AttributeKey
<
Auth
>
fun
prepare
(
block
:
Auth
.
(
)
->
Unit
)
:
Auth
val
providers
:
MutableList
<
AuthProvider
>
interface
AuthProvider
Module Contents
abstract
suspend
fun
addRequestHeaders
(
request
:
HttpRequestBuilder
)
:
Unit
abstract
fun
isApplicable
(
auth
:
HttpAuthHeader
)
:
Boolean
open
suspend
fun
refreshToken
(
response
:
HttpResponse
)
:
Boolean
abstract
val
sendWithoutRequest
:
Boolean
open
fun
sendWithoutRequest
(
request
:
HttpRequestBuilder
)
:
Boolean
io.ktor.client.HttpClientConfig
Module Contents
fun
HttpClientConfig
<
*
>
.
Auth
(
block
:
Auth
.
(
)
->
Unit
)
:
Unit
package
io.ktor.client.features.auth.providers
Module Contents
class
BasicAuthConfig
Module Contents
BasicAuthConfig
(
)
fun
credentials
(
block
:
suspend
(
)
->
BasicAuthCredentials
?
)
:
Unit
lateinit
var
password
:
String
var
realm
:
String
?
var
sendWithoutRequest
:
Boolean
fun
sendWithoutRequest
(
block
:
(
HttpRequestBuilder
)
->
Boolean
)
:
Unit
lateinit
var
username
:
String
class
BasicAuthCredentials
Module Contents
BasicAuthCredentials
(
username
:
String
,
password
:
String
)
val
password
:
String
val
username
:
String
class
BasicAuthProvider
:
AuthProvider
Module Contents
BasicAuthProvider
(
username
:
String
,
password
:
String
,
realm
:
String
?
=
null
,
sendWithoutRequest
:
Boolean
=
false
)
BasicAuthProvider
(
credentials
:
suspend
(
)
->
BasicAuthCredentials
?
,
realm
:
String
?
=
null
,
sendWithoutRequestCallback
:
(
HttpRequestBuilder
)
->
Boolean
=
{ false }
)
suspend
fun
addRequestHeaders
(
request
:
HttpRequestBuilder
)
:
Unit
fun
isApplicable
(
auth
:
HttpAuthHeader
)
:
Boolean
suspend
fun
refreshToken
(
response
:
HttpResponse
)
:
Boolean
val
sendWithoutRequest
:
Boolean
fun
sendWithoutRequest
(
request
:
HttpRequestBuilder
)
:
Boolean
class
BearerAuthConfig
Module Contents
BearerAuthConfig
(
)
fun
loadTokens
(
block
:
suspend
(
)
->
BearerTokens
?
)
:
Unit
var
realm
:
String
?
fun
refreshTokens
(
block
:
suspend
(
response
:
HttpResponse
)
->
BearerTokens
?
)
:
Unit
fun
sendWithoutRequest
(
block
:
(
HttpRequestBuilder
)
->
Boolean
)
:
Unit
class
BearerAuthProvider
:
AuthProvider
Module Contents
BearerAuthProvider
(
refreshTokens
:
suspend
(
response
:
HttpResponse
)
->
BearerTokens
?
,
loadTokens
:
suspend
(
)
->
BearerTokens
?
,
sendWithoutRequestCallback
:
(
HttpRequestBuilder
)
->
Boolean
=
{ true }
,
realm
:
String
?
)
suspend
fun
addRequestHeaders
(
request
:
HttpRequestBuilder
)
:
Unit
suspend
fun
clearToken
(
)
:
Unit
fun
isApplicable
(
auth
:
HttpAuthHeader
)
:
Boolean
suspend
fun
refreshToken
(
response
:
HttpResponse
)
:
Boolean
val
sendWithoutRequest
:
Boolean
fun
sendWithoutRequest
(
request
:
HttpRequestBuilder
)
:
Boolean
class
BearerTokens
Module Contents
BearerTokens
(
accessToken
:
String
,
refreshToken
:
String
)
val
accessToken
:
String
val
refreshToken
:
String
class
DigestAuthConfig
Module Contents
DigestAuthConfig
(
)
var
algorithmName
:
String
fun
credentials
(
block
:
suspend
(
)
->
DigestAuthCredentials
?
)
:
Unit
var
password
:
String
var
realm
:
String
?
var
username
:
String
class
DigestAuthCredentials
Module Contents
DigestAuthCredentials
(
username
:
String
,
password
:
String
)
val
password
:
String
val
username
:
String
class
DigestAuthProvider
:
AuthProvider
Module Contents
DigestAuthProvider
(
username
:
String
,
password
:
String
,
realm
:
String
?
=
null
,
algorithmName
:
String
=
"MD5"
)
DigestAuthProvider
(
credentials
:
suspend
(
)
->
DigestAuthCredentials
?
,
realm
:
String
?
=
null
,
algorithmName
:
String
=
"MD5"
)
suspend
fun
addRequestHeaders
(
request
:
HttpRequestBuilder
)
:
Unit
val
algorithmName
:
String
fun
isApplicable
(
auth
:
HttpAuthHeader
)
:
Boolean
val
password
:
String
val
realm
:
String
?
suspend
fun
refreshToken
(
response
:
HttpResponse
)
:
Boolean
val
sendWithoutRequest
:
Boolean
fun
sendWithoutRequest
(
request
:
HttpRequestBuilder
)
:
Boolean
val
username
:
String
fun
Auth
.
basic
(
block
:
BasicAuthConfig
.
(
)
->
Unit
)
:
Unit
fun
Auth
.
bearer
(
block
:
BearerAuthConfig
.
(
)
->
Unit
)
:
Unit
fun
Auth
.
digest
(
block
:
DigestAuthConfig
.
(
)
->
Unit
)
:
Unit