Package io.quarkus.oidc.client
Interface OidcClient
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
OidcClientImpl
Token grant client
-
Method Summary
Modifier and TypeMethodDescriptiondefault io.smallrye.mutiny.Uni<Tokens>
Get the grant access and refresh tokens.io.smallrye.mutiny.Uni<Tokens>
Get the grant access and refresh tokens with additional grant parameters.default io.smallrye.mutiny.Uni<Tokens>
refreshTokens
(String refreshToken) Refresh and return a new pair of access and refresh tokens.io.smallrye.mutiny.Uni<Tokens>
refreshTokens
(String refreshToken, Map<String, String> additionalGrantParameters) Refresh and return a new pair of access and refresh tokens.default io.smallrye.mutiny.Uni<Boolean>
revokeAccessToken
(String accessToken) Revoke the access token.io.smallrye.mutiny.Uni<Boolean>
revokeAccessToken
(String accessToken, Map<String, String> additionalParameters) Revoke the access token.
-
Method Details
-
getTokens
Get the grant access and refresh tokens. -
getTokens
Get the grant access and refresh tokens with additional grant parameters.- Parameters:
additionalGrantParameters
- additional grant parameters- Returns:
- Uni
-
refreshTokens
Refresh and return a new pair of access and refresh tokens. Note a refresh token grant will typically return not only a new access token but also a new refresh token.- Parameters:
refreshToken
- refresh token- Returns:
- Uni
-
refreshTokens
io.smallrye.mutiny.Uni<Tokens> refreshTokens(String refreshToken, Map<String, String> additionalGrantParameters) Refresh and return a new pair of access and refresh tokens. Note a refresh token grant will typically return not only a new access token but also a new refresh token.- Parameters:
refreshToken
- refresh tokenadditionalGrantParameters
- additional grant parameters- Returns:
- Uni
-
revokeAccessToken
Revoke the access token.- Parameters:
accessToken
- access token which needs to be revoked- Returns:
- Uni
true if the token has been revoked or found already being invalidated, false if the token can not be currently revoked in which case a revocation request might be retried.
-
revokeAccessToken
io.smallrye.mutiny.Uni<Boolean> revokeAccessToken(String accessToken, Map<String, String> additionalParameters) Revoke the access token.- Parameters:
accessToken
- access token which needs to be revokedadditionalParameters
- additional parameters- Returns:
- Uni
true if the token has been revoked or found already being invalidated, false if the token can not be currently revoked in which case a revocation request might be retried.
-