GET /userinfo/auth_test

Examples

If the authorization information provided in the HTTP request headers is valid,
the response will be:

  200 OK
  {
    "message": null,
    "result": null
  }

otherwise it will be:

  401 Unauthorized
  {
    "message": null,
    "result": null
  }

GET /userinfo/v1/people/by_username/<resource>/<username>

Examples

This route maps usernames(logins) on xsede resources to people and returns person information.
For example, to get the information for the login 'tg455671' on 'stampede.tacc.xsede':

GET /userinfo/v1/people/by_username/stampede.tacc.xsede/tg455671
{
    "message": null,
    "result": {
        "person_id": 148,
        "last_name": "Navarro",
        "first_name": "John-Paul",
        "middle_name": null,
        "organization": "Argonne National Laboratory",
        "department": "Mathematics & Computer Science Division",
        "street1": "9700 S. Cass Ave.",
        "street2": "TCS, Building 240",
        "city": "Lemont",
        "state": "Illinois",
        "zipcode": "60439-4844",
        "country": "United States",
        "email": "navarro@mcs.anl.gov",
        "phone": "630-252-1233",
        "status": "inactive"
    }
}

Or to get the information for the person with portal login 'mshapiro':

GET /userinfo/v1/people/by_username/portal.teragrid/mshapiro
{
    "message": null,
    "result": {
        "person_id": 150,
        "last_name": "Shapiro",
        "first_name": "Michael",
        "middle_name": null,
        "organization": "University of Illinois at Urbana-Champaign",
        "department": "NCSA",
        "street1": "MC 257 - 1008 NCSA",
        "street2": "1205 W. Clark St.",
        "city": "Urbana",
        "state": "Illinois",
        "zipcode": "61801",
        "country": "United States",
        "email": "mshapiro@ncsa.uiuc.edu",
        "phone": "(217) 244-1514",
        "status": "active"
    }
}

NOTE: status will be one of: vetted, active, inactive, expired

GET /userinfo/v1/resources/usernames/<resource>

Examples

This route returns all the users on a resource with their usernames.
This example JSON is a truncated list of the users on ranger.tacc.teragrid.
The actual list would contain over 7500 users.
NOTE: some users have more than one username (eg, p4rodrig)

GET /userinfo/v1/resources/usernames/ranger.tacc.teragrid
{
    "message": null,
    "result": {
        "resource": "ranger.tacc.teragrid",
        "site": "TACC",
        "users": [
            {
                "personId": 12755,
                "portalLogin": "mvitse",
                "sitePersonId": "807549",
                "usernames": [
                    "vitse"
                ]
            },
            {
                "personId": 12750,
                "portalLogin": "elvati",
                "sitePersonId": "807818",
                "usernames": [
                    "elvati"
                ]
            },
            {
                "personId": 12753,
                "portalLogin": "prablen1",
                "sitePersonId": "807819",
                "usernames": [
                    "prablen1"
                ]
            },
            {
                "personId": 17711,
                "portalLogin": "p4rodrig",
                "sitePersonId": "813287",
                "usernames": [
                    "p4rodrig",
                    "tg810159"
                ]
            },
            {
                "personId": 17718,
                "portalLogin": "sszpakow",
                "sitePersonId": "813292",
                "usernames": [
                    "sszpakow"
                ]
            },
            {
                "personId": 17722,
                "portalLogin": "bjerg",
                "sitePersonId": "813296",
                "usernames": [
                    "bjerg"
                ]
            }
        ]
    }
}