User info

OpenID Connect 1.0 endpoint for obtaining attributes of a Human Service Consumer conform scope defined in access token.

Request

HTTP methods

  • POST

Parameters

Example

> Authorization: Bearer IIeDIrdnYo2ngwDQYJKoZIhvcNAQELBQAwSDEZMBcGA1UEAwwQaVNIQ
< Content-Type: application/json; charset=UTF-8

POST /connect/userinfo

Response

Headers

  • Content-Type

    String.

    Defines response body content type. MUST be equal to application/jwt.

HTTP status codes

  • 200 OK

    When a valid request is sent an OK result should be returned.

  • 400 Bad Request

    When an access token is valid but request itself is invalid.

  • 401 Unauthorized

    When Authorization header is either missing, invalid or token has already expired.

Parameters

Since response Content-Type is application/jwt it should be expected to retrieve a signed JWT. JWT should be iSHARE compliant and its payload should contain delegation evidence. In addition, JWT payload might also contain the following parameters:

  • first_name

    String. Optional.

    First name of the human who’s access token is used.

  • last_name

    String. Optional.

    Last name of the human who’s access token is used.

  • gender

    String. Optional.

    Gender of the human who’s access token is used. Available values are male, female, TBD.

  • company_id

    String. Optional.

    TBD.

  • company_name

    String. Optional.

    TBD.

200 OK Example

< Content-Type: application/jwt

example TBD

Decoded JWT Payload

{
    "example": "TBD"
}

Note

This page must be considered part of the iSHARE Trust Framework

Last updated

Logo

Copyright © 2024 iSHARE Foundation