Authorise
OpenID Connect endpoint for redirecting Human Service Consumer for authentication by the Identity Provider. Server response is directed to the Service Provider's return endpoint.
Defines request body content type. MUST be equal to application/x-www-form-urlencoded.
x-www-form-urlencodedOAuth 2.0 Response Type. For iSHARE using the Authorization Code Flow, with value ‘code’ is REQUIRED. MUST be identical to the response_type value in the request JWT.
response_typeOAuth 2.0 scope for OpenID Connect 1.0. MUST contain the ‘openid’ scope value and one or more scopes identifying the attributes from the Human Service Consumer that are requested. Supported scopes under iSHARE are described on the Technical Agreements page, in the Human2Machine interaction section. MUST be identical to the scope value in the request JWT. Scope values determine the permissions to be asked to the user.
scopeOpenID Connect 1.0 client ID. Used in iSHARE for all client identification for OAuth/OpenID Connect. MUST contain a valid iSHARE identifier. MUST be identical to the client_id value in the request JWT.
client_idOpenID Connect 1.0 signed JWT containing all request parameters. See also Generic iSHARE JWT specifications for a.o. basic content and signing requirements. Additionally JWT MUST be encrypted using JWE as a user can access this JWT itself and decode the data contained therein.
requestOK
OK
Request
Request Parameter JWT
This parameter is an iSHARE-compliant JWT, with additional parameters within this token. The request JWT contains the modified sub parameter and the following additional parameters:
subString. This parameter overrides the iSHARE-compliant JWT payload. A URN specifying the subject for this authorisation request. Since the ID or pseudonym of the user is not known upfront, the urn: TBD value should be used (TBD means To Be Determined). In response, a pseudonym of the user MUST be returned by the Identity Provider.response_typeString. (Required) OAuth 2.0 Response Type. To use the Authorisation Code Flow in iSHARE, a value code is REQUIRED. MUST be identical to the response_type value in the body parameter of the /authorise request.client_idString. (Required) OpenID Connect 1.0 client ID. Used in iSHARE for all client identification for OAuth/OpenID Connect. MUST contain a valid iSHARE identifier. MUST be identical to the client_id value in the body parameter of the /authorise request.scopeString. (Required) OAuth 2.0 scope for OpenID Connect 1.0. The scope parameter MUST contain at least the openid and the iSHARE scope values. In addition to that, it MAY also contain one or more scopes identifying the attributes from the Human Service Consumer that are requested (depending on the OpenID implementation of the Identity Provider). The iSHARE scope contains the minimal information required for authorisations. The scope parameter MUST be identical to the scope value in the body parameter of the /authorise request. MUST be identical to the scope value in the body parameter of the /authorise request.redirect_uriString. OpenID Connect 1.0 redirection URI to which the response will be sent. Note that by transporting the redirect_uri in a signed and encrypted JWT, security considerations regarding un-pre-registered redirect_uris are properly addressed.stateString. OpenID Connect 1.0 opaque value used to maintain state between the request and the callback. The client application needs to verify if the sent value is equal to the value which comes back from the IdP /authorise endpoint response.nonceString. OpenID Connect 1.0 value used to associate a client session with an ID Token. The client application needs to verify if the sent value is equal to the value which comes back from the IdP /token endpoint response.acr_valuesString. OpenID Connect 1.0 authentication context class reference value. Space-separated string that specifies the ACR values that the Identity Provider is being requested to use for processing this request, with the values appearing in order of preference. MUST either contain urn:http://eidas.europa.eu/LoA/NotNotified/low, urn:http://eidas.europa.eu/LoA/NotNotified/substantial or urn:http://eidas.europa.eu/LoA/NotNotified/high, depending on the quality of the authentication method. To understand authentication requirements for each level of assurance, please look at the LOA table.languageString. Optional. iSHARE specific two-letter indicator (ISO 639-1 Code) that guides the language of the user interface shown by the Identity Broker or Identity Provider. If provided, must display the login page according to the provided language; else should display the default page.
Example
Levels of Assurance
Level of Assurance
Authentication assurance
Low
Single factor, e.g. username and password
Substantial
Multi-factor, e.g. mobile phone + PIN
High
Multi-factor, e.g. mobile phone + PIN
Must access private data/keys stored on tamper-resistant hardware token
Cryptographic protection of personally identifying information (PII)
Example
Tip
request The parameter is encrypted, so you won’t be able to inspect its payload. However, if you’d like to see the JWT payload, please refer to the section.
(URL encoding removed, and line breaks added for readability)
Response
HTTP status codes
302 Found
When a valid request is sent, a redirection should happen to the Identity Provider’s login page to allow the user to authenticate themselves.
When an invalid request is sent, a redirection should happen to the Identity Provider’s error page. Redirection should not be made to a URI which was provided in a request JWT payload redirect_uri parameter due to potential security risks. To learn more, please read the OAuth 2.0 Security: OAuth Open Redirector section 2.
Parameters
returnUrlOn a successful request, a redirection to the login should happen. Once the user has logged in, a callback to authorise endpoint needs to be done in order to issue a code to the Service Provider. This parameter value should be an encoded URL to the callback endpoint.
Warning
Authorise callback endpoint usually requires the same parameters that were sent towards the authorise endpoint in order to identify which request was. Signed and encrypted JWT is too long and MUST NOT be included in returnUrl.
302 Found Example
(URL encoding removed, and line break added for readability)
Callback
On successful login callback towards the authorise endpoint is invoked. It’s out of iSHARE’s scope to document the Identity Provider’s internal functionality. However, there are still a few requirements because the Service Provider’s return endpoint expects a specific call.
On successful callback, Identity Provider should redirect the user to the URI which was provided in the request JWT payload redirect_uri parameter with added query parameters that are defined in a section below.
Parameters
codeAn authorisation code, which is going to be used to request an access token. The authorisation code MUST expire shortly after it is issued to mitigate the risk of leaks. A maximum authorisation code lifetime of 10 minutes is RECOMMENDED. The client MUST NOT use the authorisation code more than once. If an authorisation code is used more than once, the authorisation server MUST deny the request and SHOULD revoke (when possible) all tokens previously issued based on that authorisation code. The authorisation code is bound to the client identifier and redirection URI.stateOpenID Connect 1.0 opaque value used to maintain state between the request and the callback. The client application needs to verify if the sent value is equal to this returned value.
302 Found Example
Last updated