Skip to main content

Get a user by identity provider external ID

GET 

/u/by-external/:provider/:external_id.json

Get a user by identity provider external ID

Request

Path Parameters

    provider stringrequired

    Authentication provider name. Can be found in the provider callback URL: /auth/{provider}/callback

    external_id stringrequired

Header Parameters

    Api-Key stringrequired
    Api-Username stringrequired

Responses

user response

Schema
    user_badges undefined[]required
    user objectrequired
    id integerrequired
    username stringrequired
    name stringrequired
    avatar_template stringrequired
    last_posted_at stringnullrequired
    last_seen_at stringnullrequired
    created_at stringrequired
    ignored booleanrequired
    muted booleanrequired
    can_ignore_user booleanrequired
    can_mute_user booleanrequired
    can_send_private_messages booleanrequired
    can_send_private_message_to_user booleanrequired
    trust_level integerrequired
    moderator booleanrequired
    admin booleanrequired
    title stringnullrequired
    badge_count integerrequired
    second_factor_backup_enabled booleanrequired
    user_fields object
    1 stringnullrequired
    2 stringnullrequired
    custom_fields objectrequired
    first_name stringnullrequired
    time_read integerrequired
    recent_time_read integerrequired
    primary_group_id stringnullrequired
    primary_group_name stringnullrequired
    flair_group_id stringnullrequired
    flair_name stringnullrequired
    flair_url stringnullrequired
    flair_bg_color stringnullrequired
    flair_color stringnullrequired
    featured_topic stringnullrequired
    staged booleanrequired
    can_edit booleanrequired
    can_edit_username booleanrequired
    can_edit_email booleanrequired
    can_edit_name booleanrequired
    uploaded_avatar_id stringnullrequired
    has_title_badges booleanrequired
    pending_count integerrequired
    pending_posts_count integerrequired
    profile_view_count integerrequired
    second_factor_enabled booleanrequired
    can_upload_profile_header booleanrequired
    can_upload_user_card_background booleanrequired
    post_count integerrequired
    can_be_deleted booleanrequired
    can_delete_all_posts booleanrequired
    locale stringnullrequired
    muted_category_ids undefined[]required
    regular_category_ids undefined[]required
    watched_tags undefined[]required
    watching_first_post_tags undefined[]required
    tracked_tags undefined[]required
    muted_tags undefined[]required
    tracked_category_ids undefined[]required
    watched_category_ids undefined[]required
    watched_first_post_category_ids undefined[]required
    system_avatar_upload_id stringnullrequired
    system_avatar_template stringrequired
    muted_usernames undefined[]required
    ignored_usernames undefined[]required
    allowed_pm_usernames undefined[]required
    mailing_list_posts_per_day integerrequired
    can_change_bio booleanrequired
    can_change_location booleanrequired
    can_change_website booleanrequired
    can_change_tracking_preferences booleanrequired
    user_api_keys stringnullrequired
    user_passkeys arrayrequired
    sidebar_tags arrayrequired
    sidebar_category_ids arrayrequired
    display_sidebar_tags booleanrequired
    can_pick_theme_with_custom_homepage booleanrequired
    user_auth_tokens object[]required
  • Array [
  • id integerrequired
    client_ip stringrequired
    location stringrequired
    browser stringrequired
    device stringrequired
    os stringrequired
    icon stringrequired
    created_at stringrequired
    seen_at stringrequired
    is_active booleanrequired
  • ]
  • user_notification_schedule objectrequired
    enabled booleanrequired
    day_0_start_time integerrequired
    day_0_end_time integerrequired
    day_1_start_time integerrequired
    day_1_end_time integerrequired
    day_2_start_time integerrequired
    day_2_end_time integerrequired
    day_3_start_time integerrequired
    day_3_end_time integerrequired
    day_4_start_time integerrequired
    day_4_end_time integerrequired
    day_5_start_time integerrequired
    day_5_end_time integerrequired
    day_6_start_time integerrequired
    day_6_end_time integerrequired
    use_logo_small_as_avatar booleanrequired
    featured_user_badge_ids undefined[]required
    invited_by stringnullrequired
    groups object[]required
  • Array [
  • id integerrequired
    automatic booleanrequired
    name stringrequired
    display_name stringrequired
    user_count integerrequired
    mentionable_level integerrequired
    messageable_level integerrequired
    visibility_level integerrequired
    primary_group booleanrequired
    title stringnullrequired
    grant_trust_level stringnullrequired
    incoming_email stringnullrequired
    has_messages booleanrequired
    flair_url stringnullrequired
    flair_bg_color stringnullrequired
    flair_color stringnullrequired
    bio_raw stringnullrequired
    bio_cooked stringnullrequired
    bio_excerpt stringnullrequired
    public_admission booleanrequired
    public_exit booleanrequired
    allow_membership_requests booleanrequired
    full_name stringnullrequired
    default_notification_level integerrequired
    membership_request_template stringnullrequired
    members_visibility_level integerrequired
    can_see_members booleanrequired
    can_admin_group booleanrequired
    publish_read_state booleanrequired
  • ]
  • group_users object[]required
  • Array [
  • group_id integerrequired
    user_id integerrequired
    notification_level integerrequired
    owner booleanrequired
  • ]
  • user_option objectrequired
    user_id integerrequired
    mailing_list_mode booleanrequired
    mailing_list_mode_frequency integerrequired
    email_digests booleanrequired
    email_level integerrequired
    email_messages_level integerrequired
    external_links_in_new_tab booleanrequired
    bookmark_auto_delete_preference integerrequired
    color_scheme_id stringnullrequired
    dark_scheme_id stringnullrequired
    dynamic_favicon booleanrequired
    enable_quoting booleanrequired
    enable_defer booleanrequired
    digest_after_minutes integerrequired
    automatically_unpin_topics booleanrequired
    auto_track_topics_after_msecs integerrequired
    notification_level_when_replying integerrequired
    new_topic_duration_minutes integerrequired
    email_previous_replies integerrequired
    email_in_reply_to booleanrequired
    like_notification_frequency integerrequired
    include_tl0_in_digests booleanrequired
    theme_ids undefined[]required
    theme_key_seq integerrequired
    allow_private_messages booleanrequired
    enable_allowed_pm_users booleanrequired
    homepage_id stringnullrequired
    hide_profile_and_presence booleanrequired
    text_size stringrequired
    text_size_seq integerrequired
    title_count_mode stringrequired
    timezone stringnullrequired
    skip_new_user_tips booleanrequired
    default_calendar stringrequired
    oldest_search_log_date stringnullrequired
    sidebar_link_to_filtered_list booleanrequired
    sidebar_show_count_of_new_items booleanrequired
    watched_precedence_over_muted booleannullrequired
    seen_popups arraynullrequired
    topics_unread_when_closed booleanrequired
Loading...