oauth

Get user info

Changed on

Get information about the user. Only available through oauth access tokens. Information varies depending on the scope of the oauth app and what permissions the user granted to the oauth app.

get/oauth/userinfo

Request

  • Base URL: https://huggingface.co
  • URL: https://huggingface.co/oauth/userinfo
  • Auth: HTTP bearer

Response

User info

substring required

ID of the user

namestring

Full name of the user

preferred_usernamestring

Username of the user

profilestring uri

Profile URL of the user

picturestring uri

Avatar URL of the user

websitestring uri

Website of the user

emailstring

Email of the user

email_verifiedboolean

Whether the email is verified

isProboolean required

Whether the user is a Pro user

canPayboolean

Whether the user has access to billing. You should check canPay first.

billingMode'prepaid' | 'postpaid'

Whether the user is on prepaid or postpaid billing

Changes

  • bd17546f47b8Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to boolean for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the //// response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the /// response's property type changed from no type to string for status

  • 99cb19038135Revision changes
    • warning

      added the new admin enum value to the //// response property for the response status

    • warning

      added the new admin enum value to the // response property for the response status

    • warning

      added the new contributor enum value to the //// response property for the response status

    • warning

      added the new contributor enum value to the // response property for the response status

    • warning

      added the new no_access enum value to the //// response property for the response status

    • warning

      added the new no_access enum value to the // response property for the response status

    • warning

      added the new read enum value to the //// response property for the response status

    • warning

      added the new read enum value to the // response property for the response status

    • warning

      added the new write enum value to the //// response property for the response status

    • warning

      added the new write enum value to the // response property for the response status

    • info

      removed subschema #1 subschema #2 from the //// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the // response property anyOf list for the response status