@webitel/api-services
    Preparing search index...

    Interface WebitelImApiGatewayV1Identity

    interface WebitelImApiGatewayV1Identity {
        birthdate?: string;
        email?: string;
        emailVerified?: boolean;
        familyName?: string;
        gender?: string;
        givenName?: string;
        iss?: string;
        locale?: string;
        metadata?: WebitelImApiGatewayV1IdentityMetadata;
        middleName?: string;
        name?: string;
        phoneNumber?: string;
        phoneNumberVerified?: boolean;
        picture?: string;
        profile?: string;
        sub?: string;
        zoneinfo?: string;
    }
    Index

    Properties

    birthdate? email? emailVerified? familyName? gender? givenName? iss? locale? metadata? middleName? name? phoneNumber? phoneNumberVerified? picture? profile? sub? zoneinfo?

    Properties

    birthdate?: string

    OPTIONAL. End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed.

    email?: string

    End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.

    emailVerified?: boolean

    True if the End-User's e-mail address has been verified; otherwise false.

    familyName?: string

    Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

    gender?: string

    OPTIONAL. End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.

    givenName?: string

    Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

    iss?: string

    REQUIRED. Issuer Identifier for the Issuer of the response. The iss value is a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components.

    locale?: string

    End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or uk-UA.

    metadata?: WebitelImApiGatewayV1IdentityMetadata

    End-User's extra attributes (claims) metadata.

    middleName?: string

    Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.

    name?: string

    REQUIRED. End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

    phoneNumber?: string

    End-User's preferred telephone number. E.164 is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.

    phoneNumberVerified?: boolean

    True if the End-User's phone number has been verified; otherwise false.

    picture?: string

    OPTIONAL. URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.

    profile?: string

    OPTIONAL. URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. NOTE: Issuer SP (IdP) related URL.

    sub?: string

    REQUIRED. Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client, e.g., 24400320 or AItOawmwtWwcT0k51BayewNvutrJUqsvl6qs7A4. It MUST NOT exceed 255 ASCII characters in length. The sub value is a case sensitive string.

    zoneinfo?: string

    OPTIONAL. String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Kyiv or America/Los_Angeles.

    Settings

    Member Visibility

    On This Page

    Properties