OpenidConnectIdpService

Overview

The OpenidConnectIdpService provides various functionalities to handle OpenID Connect (OIDC) authentication and OAuth 2.0 token operations. This service supports authorization, token requests, user information retrieval, token introspection, revocation, logout, and consent management.

This documentation is intended for technical implementers integrating OpenID Connect features into their applications.

Available Functions

authorize(NativeObject requestDto): ResponseToBrowser

Processes an authorization request.

• Parameters:

  • requestDto (NativeObject): The authorization request details.

• Returns:

  • ResponseToBrowser: The authorization response.

requestToken(NativeObject requestDto): ResponseToBrowser

Processes an OAuth2 token request.

• Parameters:

  • requestDto (NativeObject): The token request details.

• Returns:

  • ResponseToBrowser: The token response.

userInfo(NativeObject requestDto): ResponseToBrowser

Retrieves user information using an access token.

• Parameters:

  • requestDto (NativeObject): The user info request details.

• Returns:

  • ResponseToBrowser: The user info response.

openidConfiguration(NativeObject requestDto): ResponseToBrowser

Retrieves OpenID Connect configuration details.

• Parameters:

  • requestDto (NativeObject): The request details.

• Returns:

  • ResponseToBrowser: The OpenID configuration response.

tokenInfo(NativeObject requestDto): ResponseToBrowser

Processes a token introspection request.

• Parameters:

  • requestDto (NativeObject): The introspection request details.

• Returns:

  • ResponseToBrowser: The introspection response.

revokeToken(NativeObject requestDto): ResponseToBrowser

Revokes an OAuth2 token.

• Parameters:

  • requestDto (NativeObject): The token revocation request details.

• Returns:

  • ResponseToBrowser: The revocation response.

logout(NativeObject requestDto): ResponseToBrowser

Processes an OpenID Connect logout request.

• Parameters:

  • requestDto (NativeObject): The logout request details.

• Returns:

  • ResponseToBrowser: The logout response.

approveConsent(long consentId, NativeObject requestDto): ResponseToBrowser

Approves a consent request.

• Parameters:

  • consentId (long): The consent ID.

  • requestDto (NativeObject): The request details.

• Returns:

  • ResponseToBrowser: The approval response.

approveConsent(long consentId, String scopeString, NativeObject requestDto): ResponseToBrowser

Approves a consent request with specific scopes.

• Parameters:

  • consentId (long): The consent ID.

  • scopeString (String): The scopes to approve.

  • requestDto (NativeObject): The request details.

• Returns:

  • ResponseToBrowser: The approval response.

denyConsent(long consentId, NativeObject requestDto): ResponseToBrowser

Denies a consent request.

• Parameters:

  • consentId (long): The consent ID.

  • requestDto (NativeObject): The request details.

• Returns:

  • ResponseToBrowser: The denial response.

getConsent(long consentId, NativeObject requestDto): ResponseToBrowser

Retrieves consent details.

• Parameters:

  • consentId (long): The consent ID.

  • requestDto (NativeObject): The request details.

• Returns:

  • ResponseToBrowser: The consent details in JSON format.

RequestDto Class

The RequestDto class represents an HTTP request structure used in this service.

Properties:

• method (HttpMethod): The HTTP method (GET, POST, etc.).

• requestURL (URL): The request URL.

• headers (Map<String, String>): Request headers.

• parameters (Map<String, String>): Request parameters.

• body (String): The request body.

Methods:

• getMethod(): HttpMethod – Returns the HTTP method.

• getRequestURL(): URL – Returns the request URL.

• getHeaders(): Map<String, String> – Returns the headers.

• getParameters(): Map<String, String> – Returns the parameters.

• getBody(): String – Returns the request body.

• getRequestContext(HeaderSupport headerSupport): RequestContext – Extracts request context.

Summary

The OpenidConnectIdpService enables OpenID Connect authentication and OAuth 2.0 token operations, including:

• Authorization and token requests.

• User information retrieval.

• Token introspection and revocation.

• OpenID Connect logout.

• Consent approval and denial.

This service is essential for managing authentication flows in an OpenID Connect environment.