Package org.keycloak.protocol.oid4vc.model

Class CredentialScopeRepresentation

java.lang.Object

org.keycloak.representations.idm.ClientScopeRepresentation

org.keycloak.protocol.oid4vc.model.CredentialScopeRepresentation

public class CredentialScopeRepresentation
extends ClientScopeRepresentation

An extension of ClientScopeRepresentation which and adds additional functionality for OID4VCI

Author:

Thomas Diesler

Field Summary

Fields inherited from class org.keycloak.representations.idm.ClientScopeRepresentation

attributes, description, id, name, protocol, protocolMappers

Constructor Summary

Constructors

Constructor	Description
CredentialScopeRepresentation(String name)
CredentialScopeRepresentation(ClientScopeModel clientScope)
CredentialScopeRepresentation(ClientScopeRepresentation clientScope)

Method Summary

Modifier and Type	Method	Description
String	getAttribute(String key)
String	getBuildConfigHashAlgorithm()
List<String>	getBuildConfigSdJwtVisibleClaims()
String	getBuildConfigTokenJwsType()
String	getCredentialConfigurationId()
String	getCredentialIdentifier()
List<String>	getCryptographicBindingMethods()
String	getDisplay()
Integer	getExpiryInSeconds()
String	getFormat()
boolean	getIncludeInTokenScope()
String	getIssuerDid()
List<String>	getRequiredKeyAttestationKeyStorage()
List<String>	getRequiredKeyAttestationUserAuthentication()
Integer	getSdJwtNumberOfDecoys()
String	getSigningAlg()
String	getSigningKeyId()
List<String>	getSupportedCredentialTypes()
List<String>	getVcContexts()
String	getVct()
boolean	isKeyAttestationRequired()
CredentialScopeRepresentation	setBuildConfigHashAlgorithm(String hashAlgorithm)
CredentialScopeRepresentation	setBuildConfigSdJwtVisibleClaims(String sdJwtVisibleClaims)
CredentialScopeRepresentation	setBuildConfigSdJwtVisibleClaims(List<String> sdJwtVisibleClaims)
CredentialScopeRepresentation	setBuildConfigTokenJwsType(String tokenJwsType)
CredentialScopeRepresentation	setCredentialConfigurationId(String credentialConfigurationId)
CredentialScopeRepresentation	setCredentialIdentifier(String credentialIdentifier)
CredentialScopeRepresentation	setCryptographicBindingMethods(String cryptographicBindingMethods)
CredentialScopeRepresentation	setCryptographicBindingMethods(List<String> cryptographicBindingMethods)
CredentialScopeRepresentation	setDisplay(String vcDisplay)
CredentialScopeRepresentation	setExpiryInSeconds(Integer expiryInSeconds)
CredentialScopeRepresentation	setFormat(String credentialFormat)
CredentialScopeRepresentation	setIncludeInTokenScope(boolean includeInScope)
CredentialScopeRepresentation	setIssuerDid(String issuerDid)
CredentialScopeRepresentation	setKeyAttestationRequired(boolean keyAttestationRequired)
CredentialScopeRepresentation	setRequiredKeyAttestationKeyStorage(List<String> keyStorage)
CredentialScopeRepresentation	setRequiredKeyAttestationUserAuthentication(List<String> userAuthentication)
CredentialScopeRepresentation	setSdJwtNumberOfDecoys(Integer sdJwtNumberOfDecoys)
CredentialScopeRepresentation	setSigningAlg(String signingAlg)
CredentialScopeRepresentation	setSigningKeyId(String signingKeyId)
CredentialScopeRepresentation	setSupportedCredentialTypes(String supportedCredentialTypes)
CredentialScopeRepresentation	setSupportedCredentialTypes(List<String> supportedCredentialTypes)
CredentialScopeRepresentation	setVcContexts(String vcContexts)
CredentialScopeRepresentation	setVcContexts(List<String> vcContexts)
CredentialScopeRepresentation	setVct(String vct)

Methods inherited from class org.keycloak.representations.idm.ClientScopeRepresentation

equals, getAttributes, getDescription, getId, getName, getProtocol, getProtocolMappers, hashCode, setAttributes, setDescription, setId, setName, setProtocol, setProtocolMappers

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CredentialScopeRepresentation

public CredentialScopeRepresentation(String name)

CredentialScopeRepresentation

public CredentialScopeRepresentation(ClientScopeModel clientScope)

CredentialScopeRepresentation

public CredentialScopeRepresentation(ClientScopeRepresentation clientScope)

Method Details

getIncludeInTokenScope

public boolean getIncludeInTokenScope()

setIncludeInTokenScope

public CredentialScopeRepresentation setIncludeInTokenScope(boolean includeInScope)

getIssuerDid

public String getIssuerDid()

setIssuerDid

public CredentialScopeRepresentation setIssuerDid(String issuerDid)

getCredentialConfigurationId

public String getCredentialConfigurationId()

setCredentialConfigurationId

public CredentialScopeRepresentation setCredentialConfigurationId(String credentialConfigurationId)

getCredentialIdentifier

public String getCredentialIdentifier()

setCredentialIdentifier

public CredentialScopeRepresentation setCredentialIdentifier(String credentialIdentifier)

getFormat

public String getFormat()

setFormat

public CredentialScopeRepresentation setFormat(String credentialFormat)

getExpiryInSeconds

public Integer getExpiryInSeconds()

setExpiryInSeconds

public CredentialScopeRepresentation setExpiryInSeconds(Integer expiryInSeconds)

getSdJwtNumberOfDecoys

public Integer getSdJwtNumberOfDecoys()

setSdJwtNumberOfDecoys

public CredentialScopeRepresentation setSdJwtNumberOfDecoys(Integer sdJwtNumberOfDecoys)

getVct

public String getVct()

setVct

public CredentialScopeRepresentation setVct(String vct)

getBuildConfigTokenJwsType

public String getBuildConfigTokenJwsType()

setBuildConfigTokenJwsType

public CredentialScopeRepresentation setBuildConfigTokenJwsType(String tokenJwsType)

getSigningKeyId

public String getSigningKeyId()

setSigningKeyId

public CredentialScopeRepresentation setSigningKeyId(String signingKeyId)

getBuildConfigHashAlgorithm

public String getBuildConfigHashAlgorithm()

setBuildConfigHashAlgorithm

public CredentialScopeRepresentation setBuildConfigHashAlgorithm(String hashAlgorithm)

getSupportedCredentialTypes

public List<String> getSupportedCredentialTypes()

setSupportedCredentialTypes

public CredentialScopeRepresentation setSupportedCredentialTypes(String supportedCredentialTypes)

setSupportedCredentialTypes

public CredentialScopeRepresentation setSupportedCredentialTypes(List<String> supportedCredentialTypes)

getVcContexts

public List<String> getVcContexts()

setVcContexts

public CredentialScopeRepresentation setVcContexts(String vcContexts)

setVcContexts

public CredentialScopeRepresentation setVcContexts(List<String> vcContexts)

getSigningAlg

public String getSigningAlg()

setSigningAlg

public CredentialScopeRepresentation setSigningAlg(String signingAlg)

getCryptographicBindingMethods

public List<String> getCryptographicBindingMethods()

setCryptographicBindingMethods

public CredentialScopeRepresentation setCryptographicBindingMethods(String cryptographicBindingMethods)

setCryptographicBindingMethods

public CredentialScopeRepresentation setCryptographicBindingMethods(List<String> cryptographicBindingMethods)

getBuildConfigSdJwtVisibleClaims

public List<String> getBuildConfigSdJwtVisibleClaims()

setBuildConfigSdJwtVisibleClaims

public CredentialScopeRepresentation setBuildConfigSdJwtVisibleClaims(String sdJwtVisibleClaims)

setBuildConfigSdJwtVisibleClaims

public CredentialScopeRepresentation setBuildConfigSdJwtVisibleClaims(List<String> sdJwtVisibleClaims)

getDisplay

public String getDisplay()

setDisplay

public CredentialScopeRepresentation setDisplay(String vcDisplay)

isKeyAttestationRequired

public boolean isKeyAttestationRequired()

setKeyAttestationRequired

public CredentialScopeRepresentation setKeyAttestationRequired(boolean keyAttestationRequired)

getRequiredKeyAttestationKeyStorage

public List<String> getRequiredKeyAttestationKeyStorage()

setRequiredKeyAttestationKeyStorage

public CredentialScopeRepresentation setRequiredKeyAttestationKeyStorage(List<String> keyStorage)

getRequiredKeyAttestationUserAuthentication

public List<String> getRequiredKeyAttestationUserAuthentication()

setRequiredKeyAttestationUserAuthentication

public CredentialScopeRepresentation setRequiredKeyAttestationUserAuthentication(List<String> userAuthentication)

getAttribute

public String getAttribute(String key)