Interface ScopeConfig

Generic scope configuration (not specifically OAuth).

Hierarchy

Properties

claimNames description properties rawSpecification timeToLive

Methods

asMap exposeInMetadata getClaimNames getDescription getProperties getRawSpecification getSuffix getTimeToLive isConsentable isPrefix isRequired matches toLogString

Properties

claimNames

claimNames: JavaSet<string>

description

description: string

properties

properties: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

rawSpecification

rawSpecification: string

timeToLive

timeToLive: Optional<Duration>

Returns

time-to-live if any. If not-specified, should be treated as infinite.

Methods

asMap

  • Returns

    representation of this Object as a Map that can be safely serialized to JSON.

    Returns object

exposeInMetadata

  • Returns boolean

getClaimNames

  • Returns JavaSet<string>

getDescription

  • Returns string

getProperties

  • Returns {
        [key: string]: string;
    }

    • [key: string]: string

getRawSpecification

  • Returns string

getSuffix

  • Parameters

    • scope: string

    Returns null | string

getTimeToLive

  • Returns

    time-to-live if any. If not-specified, should be treated as infinite.

    Returns Optional<Duration>

isConsentable

  • Returns boolean

isPrefix

  • Returns boolean

isRequired

  • Returns boolean

matches

  • Parameters

    • scope: string

    Returns boolean

toLogString

  • Returns string

Settings

Member Visibility

Theme