Huggingface.js documentation

Interface: UserInfo

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Interface: UserInfo

Properties

canPay

Optional canPay: boolean

Hugging Face field. Whether the user has a payment method set up. Needs “read-billing” scope.

Defined in

hub/src/lib/oauth-handle-redirect.ts:45


email

Optional email: string

OpenID Connect field, available if scope “email” was granted.

Defined in

hub/src/lib/oauth-handle-redirect.ts:24


email _ verified

Optional email_verified: boolean

OpenID Connect field, available if scope “email” was granted.

Defined in

hub/src/lib/oauth-handle-redirect.ts:20


isPro

isPro: boolean

Hugging Face field. Whether the user is a pro user.

Defined in

hub/src/lib/oauth-handle-redirect.ts:41


name

name: string

OpenID Connect field. The user’s full name.

Defined in

hub/src/lib/oauth-handle-redirect.ts:12


orgs

Optional orgs: { canPay?: boolean ; isEnterprise: boolean ; missingMFA?: boolean ; name: string ; pendingSSO?: boolean ; picture: string ; preferred_username: string ; roleInOrg?: string ; sub: string }[]

Hugging Face field. The user’s orgs

Defined in

hub/src/lib/oauth-handle-redirect.ts:49


picture

picture: string

OpenID Connect field. The user’s profile picture URL.

Defined in

hub/src/lib/oauth-handle-redirect.ts:28


preferred _ username

preferred_username: string

OpenID Connect field. The user’s username.

Defined in

hub/src/lib/oauth-handle-redirect.ts:16


profile

profile: string

OpenID Connect field. The user’s profile URL.

Defined in

hub/src/lib/oauth-handle-redirect.ts:32


sub

sub: string

OpenID Connect field. Unique identifier for the user, even in case of rename.

Defined in

hub/src/lib/oauth-handle-redirect.ts:8


website

Optional website: string

OpenID Connect field. The user’s website URL.

Defined in

hub/src/lib/oauth-handle-redirect.ts:36

< > Update on GitHub