v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB

Users

Retrieve a User's External Identity

Retrieves detailed information about a single external identity linked to the user. External identities represent accounts linked from external services or identity providers (e.g., ORCID, institutions). Only the authenticated user can view their own external identities.

Returns

Returns a JSON object with a data key containing the details of the requested external identity.

Errors

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed.

get/users/{user_id}/settings/identities/{identity_id}

Path parameters

user_idstring required

The unique identifier of the user whose external identity is being retrieved. Example: abc123

identity_idstring required

The unique identifier of the external identity to retrieve. Example: orcid

Response

A single external identity for the user.

idstring required

The unique identifier of the user entity.

typestring required

The type identifier of the user entity (users).

Example response

{
  "data": {
    "type": "users",
    "id": "{user_id}",
    "attributes": {
      "full_name": "Casey M. Rollins",
      "middle_names": "Marie",
      "social": {
        "github": [
          "https://github.com/caseyrollins"
        ],
        "twitter": [
          "https://twitter.com/crollins"
        ]
      },
      "employment": [
        {
          "title": "Data Scientist",
          "institution": "Open Science Framework",
          "department": "Engineering",
          "startYear": 2018,
          "startMonth": 5,
          "ongoing": true
        }
      ],
      "education": [
        {
          "degree": "MS in Computer Science",
          "institution": "University of Somewhere",
          "department": "Computer Science",
          "startYear": 2014,
          "startMonth": 9,
          "endYear": 2016,
          "endMonth": 6,
          "ongoing": false
        }
      ]
    }
  }
}