People

>>>

GET //v1/people/<username>
get person info from identity service

Examples

GET /v1/people/mshapiro
{
   "message":null,
   "result":{
      "username":"mshapiro",
      "firstName":"Michael",
      "middleName":null,
      "lastName":"Shapiro",
      "email":"mshapiro@ncsa.edu",
      "phone":"(217) 244-1514",
      "organization":"University of Illinois at Urbana-Champaign",
      "academicStatus":"Center Researcher Staff",
      "residenceCountry":"United States",
      "isReconciled":true,
      "orcid":null,
      "hasOrcidToken":false
   }
}

NOTE: These are the required fields. The identity service may include other fields in the result.

Params

Param name Description
username
required

Validations:

  • Must be a String

Returns

Code: 200

Description:

OK

Param name Description
username
required

Validations:

  • Must be a String
firstName
required

Validations:

  • Must be a String
middleName
required

Validations:

  • Must be a String
lastName
required

Validations:

  • Must be a String
email
required

Validations:

  • Must be a String
phone
required

Validations:

  • Must be a String
organization
required

Validations:

  • Must be a String
academicStatus
required

Validations:

  • Must be a String
residenceCountry
required

Validations:

  • Must be a String
isReconciled
required

Validations:

  • Must be one of: true, false.
orcid
required

Validations:

  • Must be a String
hasOrcidToken
required

Validations:

  • Must be one of: true, false.
>>>

POST //v1/people/<username>
add or update a person

Params

Param name Description
username
optional

Validations:

  • Must be a String
firstName
optional

Validations:

  • Must be a String
middleName
optional

Validations:

  • Must be a String
lastName
optional

Validations:

  • Must be a String
email
optional

Validations:

  • Must be a String
phone
optional

Validations:

  • Must be a String
academicStatus
optional

Validations:

  • Must be a String
residenceCountry
optional

Validations:

  • Must be a String
isReconciled
optional

(default true) – only used when creating the user in XRAS

Validations:

  • Must be one of: true, false.

Returns

Code: 200

Description:

OK

Param name Description
>>>

GET //v1/search/people
get people matching query string(s)

Examples

GET /v1/search/people?q=hack
{
    "message": null,
    "result": [
        {
            "academicStatus": "Center Non-Researcher Staff",
            "email": "hackworth@psc.edu",
            "firstName": "Ken",
            "lastName": "Hackworth",
            "middleName": null,
            "organization": "Pittsburgh Supercomputing Center",
            "phone": "412-268-7081",
            "residenceCountry": "United States",
            "username": "hackwort"
        },
        {
            "academicStatus": "Faculty",
            "email": "tjhacker@purdue.edu",
            "firstName": "Thomas",
            "lastName": "Hacker",
            "middleName": null,
            "organization": "Purdue University",
            "phone": "765-494-4465",
            "residenceCountry": "United States",
            "username": "tjhacker"
        },
        {
            "academicStatus": "Undergraduate Student",
            "email": "rpchack2@illinois.edu",
            "firstName": "Rishy",
            "lastName": "Chacko",
            "middleName": "Philip",
            "organization": "University of Illinois at Urbana-Champaign",
            "phone": "2245551212",
            "residenceCountry": "United States",
            "username": "rishy"
        }
    ]
}


GET /v1/search/people?q=ken+hack
{
    "message": null,
    "result": [
        {
            "academicStatus": "Center Non-Researcher Staff",
            "email": "hackworth@psc.edu",
            "firstName": "Ken",
            "lastName": "Hackworth",
            "middleName": null,
            "organization": "Pittsburgh Supercomputing Center",
            "phone": "412-268-7081",
            "residenceCountry": "United States",
            "username": "hackwort"
        }
    ]
}

Params

Param name Description
q
required

A name or username to search by

Validations:

  • Must be a String

Returns

Code: 200

Description:

OK

Param name Description
username
required

Validations:

  • Must be a String
firstName
required

Validations:

  • Must be a String
middleName
required

Validations:

  • Must be a String
lastName
required

Validations:

  • Must be a String
email
required

Validations:

  • Must be a String
phone
required

Validations:

  • Must be a String
organization
required

Validations:

  • Must be a String
academicStatus
required

Validations:

  • Must be a String
residenceCountry
required

Validations:

  • Must be a String
isReconciled
required

Validations:

  • Must be one of: true, false.
orcid
required

Validations:

  • Must be a String
hasOrcidToken
required

Validations:

  • Must be one of: true, false.
>>>

POST //v1/people/<username>/merge/<new_username>
merge a username into an existing/new username

Params

Param name Description
username
required

The user to merge. This account will be deleted

Validations:

  • Must be a String
new_username
required

The user account to merge into. This account will be retained

Validations:

  • Must be a String