UserInfo Endpoint

POST 
/v3/service/extension/oidc/:organisationId/userinfo

OpenID Connect UserInfo endpoint that returns claims about the authenticated end-user. Requires a valid access token obtained from the token endpoint to be provided in the Authorization header. The endpoint accepts GET and POST. Error answers of the provider have an empty body, and the WWW-Authenticate header holds the reason.

Request

Path Parameters

organisationId stringrequired

The ID of the organisation

Responses

200

User information

Response Headers

application/json

Schema

Schema

sub string

Unique identifier for the user, resolved with the identity matching attributes or the callback of the client

presentation object
The presented credentials. This is an object, not an array. Each key is the index of a presentation as a string, starting at "0". Each value holds the claims of that presentation, and its content depends on the credential format.
property name* object
property name* any

Example (from schema)

{
  "sub": "[email protected]",
  "presentation": {
    "0": {
      "vct": "urn:eudi:pid:1",
      "email": "[email protected]"
    }
  }
}

400

Bad request. The provider answers with an empty body and the WWW-Authenticate header when a request parameter occurs more than once. The answer has errorCode and errorDescription when the organisation is not found.

Response Headers

• WWW-Authenticate string

  The Bearer challenge. It holds error and error_description when the provider gives a reason.

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized. The access token is missing, not valid or expired. The body is empty.

Response Headers

• WWW-Authenticate string

  The Bearer challenge. It holds error and error_description when the provider gives a reason.

403

Forbidden. The access token does not have the scope openid. The body is empty.

Response Headers

• WWW-Authenticate string

  The Bearer challenge. It holds error and error_description when the provider gives a reason.

404

Not found. The Passwordless Login extension has never been enabled for the organisation.

Response Headers

application/json

Schema

Schema

error string

The error code, for example invalid_request, not_found or server_error

error_description string

The reason for the error

Example (from schema)

{
  "error": "string",
  "error_description": "string"
}

Example

{
  "error": "not_found",
  "error_description": "Not found"
}

500

Internal server error. The answer has errorCode and errorDescription when it cannot reach the provider.

Response Headers

application/json

Schema

Schema

oneOf
Provider error
error string
The error code, for example invalid_request, not_found or server_error
error_description string
The reason for the error
API error
errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "error": "server_error",
  "error_description": "Internal server error"
}

Loading...