Class AccountCredentialResource
- java.lang.Object
-
- org.keycloak.services.resources.account.AccountCredentialResource
-
public class AccountCredentialResource extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AccountCredentialResource.CredentialContainer
-
Field Summary
Fields Modifier and Type Field Description static String
TYPE
static String
USER_CREDENTIALS
-
Constructor Summary
Constructors Constructor Description AccountCredentialResource(KeycloakSession session, UserModel user, Auth auth)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Stream<AccountCredentialResource.CredentialContainer>
credentialTypes(String type, Boolean userCredentials)
Retrieve the stream of credentials available to the current logged in user.void
removeCredential(String credentialId)
Remove a credential of current uservoid
setLabel(String credentialId, String userLabel)
Update a user label of specified credential of current user
-
-
-
Field Detail
-
TYPE
public static final String TYPE
- See Also:
- Constant Field Values
-
USER_CREDENTIALS
public static final String USER_CREDENTIALS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AccountCredentialResource
public AccountCredentialResource(KeycloakSession session, UserModel user, Auth auth)
-
-
Method Detail
-
credentialTypes
@GET @Produces("application/json") public Stream<AccountCredentialResource.CredentialContainer> credentialTypes(@QueryParam("type") String type, @QueryParam("user-credentials") Boolean userCredentials)
Retrieve the stream of credentials available to the current logged in user. It will return only credentials of enabled types, which user can use to authenticate in some authentication flow.- Parameters:
type
- Allows to filter just single credential type, which will be specified as this parameter. If null, it will return all credential typesuserCredentials
- specifies if user credentials should be returned. If true, they will be returned in the "userCredentials" attribute of particular credential. Defaults to true.- Returns:
-
removeCredential
@Path("{credentialId}") @DELETE public void removeCredential(@PathParam("credentialId") String credentialId)
Remove a credential of current user- Parameters:
credentialId
- ID of the credential, which will be removed
-
setLabel
@PUT @Consumes("application/json") @Path("{credentialId}/label") public void setLabel(@PathParam("credentialId") String credentialId, String userLabel)
Update a user label of specified credential of current user- Parameters:
credentialId
- ID of the credential, which will be updateduserLabel
- new user label as JSON string
-
-