@liveryvideo/player
Version:
Livery video player for use in web browsers.
194 lines (99 loc) • 3.04 kB
Markdown
[@liveryvideo/player](../index.md) / AuthClaims
Type Alias: AuthClaims
**AuthClaims** = `object`
Authentication claims.
Of these claims the following are externally defined standard OpenID:
`sub, updated_at, phone_number_verified, email_verified`
And these are user editable standard OpenID:
`given_name, family_name, middle_name, preferred_username, picture, email, gender, birthdate, locale, phone_number`
And these are Livery specific:
`verified, minimum_age`
For detailed descriptions see:
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
# Indexable
\[`claim`: `string`\]: `unknown`
Unknown claims.
# Properties
## birthdate?
`optional` **birthdate**: `string`
End-User's birthday, represented as an ISO 8601-1 [ISO8601‑1] YYYY-MM-DD format.
***
## custom1?
`optional` **custom1**: `string`
Custom Livery user property 1.
***
## custom2?
`optional` **custom2**: `string`
Custom Livery user property 2.
***
## custom3?
`optional` **custom3**: `string`
Custom Livery user property 3.
***
## custom4?
`optional` **custom4**: `string`
Custom Livery user property 4.
***
## custom5?
`optional` **custom5**: `string`
Custom Livery user property 5.
***
## email?
`optional` **email**: `string`
End-User's preferred e-mail address.
***
## email\_verified?
`optional` **email\_verified**: `boolean`
True if the End-User's e-mail address has been verified; otherwise false.
***
## family\_name?
`optional` **family\_name**: `string`
Surname(s) or last name(s) of the End-User.
***
## gender?
`optional` **gender**: `string`
End-User's gender.
***
## given\_name?
`optional` **given\_name**: `string`
Given name(s) or first name(s) of the End-User.
***
## locale?
`optional` **locale**: `string`
End-User's locale, represented as a BCP47 [RFC5646] language tag.
***
## middle\_name?
`optional` **middle\_name**: `string`
Middle name(s) of the End-User.
***
## minimum\_age?
`optional` **minimum\_age**: `number`
Age as entered by user for minimum age consideration.
***
## phone\_number?
`optional` **phone\_number**: `string`
End-User's preferred telephone number.
***
## phone\_number\_verified?
`optional` **phone\_number\_verified**: `boolean`
True if the End-User's phone number has been verified; otherwise false.
***
## picture?
`optional` **picture**: `string`
URL of the End-User's profile picture.
***
## preferred\_username?
`optional` **preferred\_username**: `string`
Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe.
***
## sub?
`optional` **sub**: `string`
Subject - Identifier for the End-User at the Issuer.
***
## updated\_at?
`optional` **updated\_at**: `number`
Time the End-User's information was last updated as number of seconds from 1970-01-01T00:00:00Z.
***
## verified?
`optional` **verified**: `boolean`
True if the user is verified, usually by email or phone number; otherwise false.