Interface ClaimConfig

A configured claim.

Hierarchy

  • ClaimConfig

Properties

claimValueSource claimsProviderId description inputAttributeNames name properties valueTransformationScript

Methods

exposeInMetadata getClaimValueSource getClaimsProviderId getDescription getInputAttributeNames getName getProperties getValueTransformationScript isConsentable isRequired isScopeRequired isSystemClaim

Properties

claimValueSource

claimValueSource: any

claimsProviderId

claimsProviderId: Optional<string>

Deprecated

description

description: null | string

inputAttributeNames

inputAttributeNames: any[]

Returns

a collection of attribute names that are used as parameters to a transformation procedure

name

name: string

properties

properties: object

valueTransformationScript

valueTransformationScript: null | string

Returns

the script that takes the input attributes and transforms those into the value of this claim; when this value is null, input attributes may be empty, and the claim provider's attribute with the name of the claim will be used to establish the value of this claim.

Methods

exposeInMetadata

  • Returns boolean

getClaimValueSource

  • Returns any

getClaimsProviderId

  • Deprecated

    Returns Optional<string>

getDescription

  • Returns null | string

getInputAttributeNames

  • Returns

    a collection of attribute names that are used as parameters to a transformation procedure

    Returns any[]

getName

  • Returns string

getProperties

  • Returns object

getValueTransformationScript

  • Returns

    the script that takes the input attributes and transforms those into the value of this claim; when this value is null, input attributes may be empty, and the claim provider's attribute with the name of the claim will be used to establish the value of this claim.

    Returns null | string

isConsentable

  • Returns boolean

isRequired

  • Returns boolean

isScopeRequired

  • Returns

    true if, for it to be issued, this claim requires at least one of the scopes it is attached to to also be issued.

    Returns boolean

isSystemClaim

  • Returns boolean

Settings

Member Visibility

Theme