Jive V3 Core API: Using /people Service for Authentication + Profile Information

Version 8

    When Authenticating with the Jive Instance, you can do the following REST call:

     

    Prompt screen for:

    • username
    • password

     

    Construct a REST call to w/Basic Auth:

    • BasicAuth: username/password
    • Host:  https://community.jivesoftware.com
    • Resource:  /api/core/v3/people/username/username
    • Parameters (optional, default is full data set):
      • fields=id,name,emails,thumbnailUrl,photos,jive

    Results:

    • Success = 200
    • Unauthorized = 401

     

    Example Call w/curl:

     

    Requested Fields (highlighted in green in example output, below)

    • id
    • displayName
    • location
    • emails
      • primary=true
    • phoneNumbers
      • primary=true
    • jive
      • username
    • thumbnailUrl
    • profile
      • Company
      • Industry
      • Title
      • Job Function

     

    Example Output:

    throw 'allowIllegalResourceCall is false.';

    {

      "name" : {

        "givenName" : "Ryan",

        "familyName" : "Rutan",

        "formatted" : "Ryan Rutan"

      },

      "location" : "Austin, Texas",

      "type" : "person",

    "displayName" : "Ryan Rutan",

      "tags" : [ "community", "developer", "java", "marketing", "jive", "collaboration", "apple", "iphone", "donne", "strategic", "teacher", "relaxed", "energetic", "learner", "mentor", "family", "communication", "entrepreneur", "texas", "theatre", "sandals", "volleyball", "dogs", "sudoku", "competitive", "movies", "untucked", "travel", "technology", "extrovert", "running", "ninja", "gamer", "autobot", "analytical", "sandwiches", "user_groups", "architect", "products", "jiveworld", "information_technology", "external_community", "jiveapps", "cmgr", "socbiz", "social_intranet", "regional", "custserv", "producteev" ],

      "status" : "Rock'n the socbiz in my favorite community tonight!",

      "published" : "2007-06-05T12:25:40.397+0000",

      "followingCount" : 321,

    "thumbnailUrl" : "https://community.jivesoftware.com/api/core/v3/people/32109/avatar",

      "jive" : {

        "timeZone" : "America/Chicago",

        "locale" : "en_US",

        "username" : "ryanrutan",

       "profile" : [ {

          "value" : "Social Business Architect",

          "jive_label" : "Occupation"

        }, {

          "value" : "http://www.ryanrutan.com",

          "jive_label" : "URL"

        }, {

          "value" : "I've been using Jive to solve both internal, external, and mixed-mode collaboration problems for over 3 years.  Implemented and/or upgraded practically every version of Jive SBS (formerly Clearspace) and released numerous high value plugins to the Jive Community.  Recently upgraded National Instruments to the Jive 5 platform, prior to transitioning to a new role at Jive Software as the Jive Community Manager",

          "jive_label" : "Biography"

        }, {

          "value" : "Enterprise Collaboration SEO Email Deliverability Content Management Web Analytics Public Speaking Project Management Java certified Struts2 Freemarker Spring (IOC,MVC,Security) OpenSocial REST JSON SOAP JUnit JPA/JDO/JDBC JEE JSP Google App Engine RegEx Maven2 CXF JMS Commons JMeter JavaScript/jQuery HTML/CSS SQL JBoss Tomcat MySQL Oracle Postgres Eclipse IntelliJ TOAD GIT Perforce SubVersion Mac OS X RHEL/CentOS Ubuntu Office® Project® Visio® ",

          "jive_label" : "Expertise"

        }, {

          "value" : "Technology",

          "jive_label" : "Industry"

        }, {

          "value" : "",

          "jive_label" : "Company"

        }, {

          "value" : "Community Management",

          "jive_label" : "Job Function"

        }, {

          "value" : "1-499",

          "jive_label" : "Company Size"

        }, {

          "value" : "Community Marketing Manager",

          "jive_label" : "Title"

        }, {

          "value" : "I have exactly 1 grey hair, wait...now 2!",

          "jive_label" : "Fun Fact"

        }, {

          "value" : "ryanrutan",

          "jive_label" : "Twitter Account Name"

        } ],

        "external" : false,

        "visible" : true,

        "enabled" : true,

        "externalContributor" : false,

        "federated" : false

      },

      "updated" : "2013-06-26T16:26:53.477+0000",

      "emails" : [ {

        "value" : "xxxxxx",

        "type" : "work",

        "jive_label" : "Email",

       "primary" : true

      } ],

      "phoneNumbers" : [ {

        "value" : "xxxxxxx",

        "type" : "work",

        "jive_label" : "Phone Number",

        "primary" : true

      } ]

      "photos" : [ {

        "value" : "https://community.jivesoftware.com/api/core/v3/people/32109"

      }, {

        "value" : "https://community.jivesoftware.com/api/core/v3/people/32109"

      }, {

        "value" : "https://community.jivesoftware.com/api/core/v3/people/32109"

      }, {

        "value" : "https://community.jivesoftware.com/api/core/v3/people/32109"

      } ],

      "thumbnailId" : "6572",

      "followerCount" : 663,

      "resources" : {

        "following" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109/@following",

          "allowed" : [ "GET" ]

        },

        "followers" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109/@followers",

          "allowed" : [ "GET" ]

        },

        "images" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109/images",

          "allowed" : [ "POST", "GET" ]

        },

        "streams" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109/streams",

          "allowed" : [ "POST", "GET" ]

        },

        "self" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109",

          "allowed" : [ "PUT", "DELETE", "GET" ]

        },

        "html" : {

          "ref" : "https://community.jivesoftware.com/people/ryanrutan",

          "allowed" : [ "GET" ]

        },

        "tasks" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109/tasks",

          "allowed" : [ "POST", "GET" ]

        },

        "followingIn" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109/followingIn",

          "allowed" : [ "GET" ]

        },

        "blog" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/places/596831",

          "allowed" : [ "GET" ]

        },

        "avatar" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109/avatar",

          "allowed" : [ "GET" ]

        },

        "members" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/members/people/32109",

          "allowed" : [ "GET" ]

        },

        "activity" : {

          "ref" : "https://community.jivesoftware.com/api/core/v3/people/32109/activities",

          "allowed" : [ "GET" ]

        }

      },

      "id" : "32109"

    }

     

    For more information see:

    Jive REST Rest API v3.6 → Person service