Evergage Core API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Glossary:

Attribute Provider (AP) Manages and provides assertions of identity attributes to other relying and federated parties.

Relying Party (RP) An entity that relies upon a subject’s authenticator(s) and credentials or an IDP's assertion of a subject’s identity, typically to process a transaction or to grant access to information or a system. - in this case, the RP is the Evergage app.

Hierarchy

  • ValueMetadata

Index

Properties

Optional classification

classification: Classification

Metadata relevant or pertaining to the security classification of a given attribute's value

Optional gearId

gearId: string

the ID of the Evergage gear that updated the attribute, or null if it was not updated by a gear

Optional lastUpdated

lastUpdated: Date

The date and time when the attribute was last updated

Optional lastVerified

lastVerified: Date

The date and time when the attribute value was last verified as being true and belonging to the specified individual

Optional origin

origin: string

The name of the entity that issues or creates the initial attribute value.

The Origin element conveys the name of the entity that established the initial attribute value. This may or may not be an authoritative entity, or the provider; if, for example, the AP generates the attribute value through a derivation process, then the AP would be the origin. The key distinction between the origin and the provider is the act of initially generating, capturing, or provisioning the attribute's value, rather than just asserting the attribute's value to an RP.

e.g. CRM, PointOfSaleSystem, FulfillmentSystem, or LoyaltySystem

Optional provider

provider: string

The name of the entity that is providing the attribute.

This specifies the name of the entity that supplies the attribute value to the RP. This does not have to be the AP itself. This element enables RPs to understand and evaluate the source of the individual attribute values that may be included in a bundle of attributes. For example, if a full service credential provider generates an assertion with several identity attributes provided by multiple APs, the {@code provider} element enables the RP to understand, at a granular level, where each has come from and determine whether or not that value can be used for access to specific resources. In instances where a single attribute is asserted directly to the RP, this element may be omitted since the assertion itself will carry the provider information as well as a certificate or digital signature.

e.g. CsvUserEtlJob:user-20190528.csv.gz

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc