Package org.keycloak.admin.client.resource

Interface UserVerifiableCredentialResource

public interface UserVerifiableCredentialResource

Since:

Keycloak 26.7.0 All the child endpoints are also available since that version

This endpoint including all the child endpoints requires feature Profile.Feature.OID4VC_VCI to be enabled and also requires "verifiable credentials" to be enabled for the realm

Method Summary

Modifier and Type	Method	Description
org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation	createCredential(org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation representation)
List<org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation>	getCredentials()
List<org.keycloak.representations.idm.oid4vc.IssuedVerifiableCredentialRepresentation>	getIssuedCredentials()
void	revokeCredential(String credentialScopeName)
void	revokeIssuedCredential(String credentialId)
void	sendCredentialOffer(String clientId, String redirectUri, Integer lifespan, org.keycloak.representations.idm.oid4vc.VerifiableCredentialOfferActionConfig credentialOfferConfig)
org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation	updateCredential(String credentialScopeName)

Method Details

createCredential

@POST
@Path("credentials")
@Consumes("application/json")
org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation createCredential(org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation representation)

getCredentials

@GET
@Path("credentials")
@Produces("application/json")
List<org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation> getCredentials()

revokeCredential

@DELETE
@Path("credentials/{credentialScopeName}")
void revokeCredential(@PathParam("credentialScopeName")
 String credentialScopeName)

updateCredential

@PUT
@Path("credentials/{credentialScopeName}")
@Produces("application/json")
org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation updateCredential(@PathParam("credentialScopeName")
 String credentialScopeName)

getIssuedCredentials

@GET
@Path("issued-credentials")
@Produces("application/json")
List<org.keycloak.representations.idm.oid4vc.IssuedVerifiableCredentialRepresentation> getIssuedCredentials()

revokeIssuedCredential

@DELETE
@Path("issued-credentials/{id}")
void revokeIssuedCredential(@PathParam("id")
 String credentialId)

sendCredentialOffer

@PUT
@Path("credentials/send-credential-offer")
@Consumes("application/json")
void sendCredentialOffer(@QueryParam("client_id")
 String clientId,
 @QueryParam("redirect_uri")
 String redirectUri,
 @QueryParam("lifespan")
 Integer lifespan,
 org.keycloak.representations.idm.oid4vc.VerifiableCredentialOfferActionConfig credentialOfferConfig)