org.gluu.oxd.client

Interface ClientInterface

@Path(value="/")
public interface ClientInterface

Author:

yuriyz

Method Summary

Modifier and Type	Method and Description
AuthorizationCodeFlowResponse	authorizationCodeFlow(String authorization, String authorizationOxdId, AuthorizationCodeFlowParams params)
CheckAccessTokenResponse	checkAccessToken(String authorization, String authorizationOxdId, CheckAccessTokenParams params)
CheckIdTokenResponse	checkIdToken(String authorization, String authorizationOxdId, CheckIdTokenParams params)
GetClientTokenResponse	getAccessTokenByRefreshToken(String authorization, String authorizationOxdId, GetAccessTokenByRefreshTokenParams params)
GetAuthorizationCodeResponse	getAuthorizationCode(String authorization, String authorizationOxdId, GetAuthorizationCodeParams params)
GetAuthorizationUrlResponse	getAuthorizationUrl(String authorization, String authorizationOxdId, GetAuthorizationUrlParams params)
GetClientTokenResponse	getClientToken(GetClientTokenParams params)
GetDiscoveryResponse	getDiscovery(GetDiscoveryParams params)
GetIssuerResponse	getIssuer(GetIssuerParams params)
GetJwksResponse	getJwks(String authorization, String authorizationOxdId, GetJwksParams params)
GetLogoutUriResponse	getLogoutUri(String authorization, String authorizationOxdId, GetLogoutUrlParams params)
String	getRequestObject(String value)
GetRequestObjectUriResponse	getRequestObjectUri(String authorization, String authorizationOxdId, GetRequestObjectUriParams params)
String	getRp(String authorization, String authorizationOxdId, GetRpParams params)
com.fasterxml.jackson.databind.JsonNode	getRpJwks()
GetTokensByCodeResponse2	getTokenByCode(String authorization, String authorizationOxdId, GetTokensByCodeParams params)
com.fasterxml.jackson.databind.JsonNode	getUserInfo(String authorization, String authorizationOxdId, GetUserInfoParams params)
String	healthCheck()
GetAuthorizationUrlResponse	initiateThirdPartyLogin(String authorization, String authorizationOxdId, String oxdId, String iss, String loginHint, String targetLinkUri)
IntrospectAccessTokenResponse	introspectAccessToken(String authorization, String authorizationOxdId, IntrospectAccessTokenParams params)
CorrectRptIntrospectionResponse	introspectRpt(String authorization, String authorizationOxdId, IntrospectRptParams params)
RegisterSiteResponse	registerSite(RegisterSiteParams params)
RemoveSiteResponse	removeSite(String authorization, String authorizationOxdId, RemoveSiteParams params)
RpGetClaimsGatheringUrlResponse	umaRpGetClaimsGatheringUrl(String authorization, String authorizationOxdId, RpGetClaimsGatheringUrlParams params)
RpGetRptResponse	umaRpGetRpt(String authorization, String authorizationOxdId, RpGetRptParams params)
RsCheckAccessResponse	umaRsCheckAccess(String authorization, String authorizationOxdId, RsCheckAccessParams params)
RsModifyResponse	umaRsModify(String authorization, String authorizationOxdId, RsModifyParams params)
RsProtectResponse	umaRsProtect(String authorization, String authorizationOxdId, RsProtectParams2 params)
UpdateSiteResponse	updateSite(String authorization, String authorizationOxdId, UpdateSiteParams params)

Method Detail

healthCheck

@GET
 @Path(value="/health-check")
 @Produces(value="application/json")
String healthCheck()

getRpJwks

@GET
 @Path(value="/get-rp-jwks")
 @Produces(value="application/json")
com.fasterxml.jackson.databind.JsonNode getRpJwks()

getRequestObject

@GET
 @Path(value="/get-request-object/{request_object_id}")
 @Produces(value="text/plain")
String getRequestObject(@PathParam(value="request_object_id")
                                                                                                                    String value)

getClientToken

@POST
 @Path(value="/get-client-token")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetClientTokenResponse getClientToken(GetClientTokenParams params)

introspectAccessToken

@POST
 @Path(value="/introspect-access-token")
 @Produces(value="application/json")
 @Consumes(value="application/json")
IntrospectAccessTokenResponse introspectAccessToken(@HeaderParam(value="Authorization")
                                                                                                                                                                             String authorization,
                                                                                                                                                                             @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                             String authorizationOxdId,
                                                                                                                                                                             IntrospectAccessTokenParams params)

introspectRpt

@POST
 @Path(value="/introspect-rpt")
 @Produces(value="application/json")
 @Consumes(value="application/json")
CorrectRptIntrospectionResponse introspectRpt(@HeaderParam(value="Authorization")
                                                                                                                                                              String authorization,
                                                                                                                                                              @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                              String authorizationOxdId,
                                                                                                                                                              IntrospectRptParams params)

registerSite

@POST
 @Path(value="/register-site")
 @Produces(value="application/json")
 @Consumes(value="application/json")
RegisterSiteResponse registerSite(RegisterSiteParams params)

updateSite

@POST
 @Path(value="/update-site")
 @Produces(value="application/json")
 @Consumes(value="application/json")
UpdateSiteResponse updateSite(@HeaderParam(value="Authorization")
                                                                                                                                           String authorization,
                                                                                                                                           @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                           String authorizationOxdId,
                                                                                                                                           UpdateSiteParams params)

removeSite

@POST
 @Path(value="/remove-site")
 @Produces(value="application/json")
 @Consumes(value="application/json")
RemoveSiteResponse removeSite(@HeaderParam(value="Authorization")
                                                                                                                                           String authorization,
                                                                                                                                           @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                           String authorizationOxdId,
                                                                                                                                           RemoveSiteParams params)

getAuthorizationUrl

@POST
 @Path(value="/get-authorization-url")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetAuthorizationUrlResponse getAuthorizationUrl(@HeaderParam(value="Authorization")
                                                                                                                                                                       String authorization,
                                                                                                                                                                       @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                       String authorizationOxdId,
                                                                                                                                                                       GetAuthorizationUrlParams params)

getAuthorizationCode

@POST
 @Path(value="/get-authorization-code")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetAuthorizationCodeResponse getAuthorizationCode(@HeaderParam(value="Authorization")
                                                                                                                                                                          String authorization,
                                                                                                                                                                          @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                          String authorizationOxdId,
                                                                                                                                                                          GetAuthorizationCodeParams params)

getTokenByCode

@POST
 @Path(value="/get-tokens-by-code")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetTokensByCodeResponse2 getTokenByCode(@HeaderParam(value="Authorization")
                                                                                                                                                            String authorization,
                                                                                                                                                            @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                            String authorizationOxdId,
                                                                                                                                                            GetTokensByCodeParams params)

getUserInfo

@POST
 @Path(value="/get-user-info")
 @Produces(value="application/json")
 @Consumes(value="application/json")
com.fasterxml.jackson.databind.JsonNode getUserInfo(@HeaderParam(value="Authorization")
                                                                                                                                                                   String authorization,
                                                                                                                                                                   @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                   String authorizationOxdId,
                                                                                                                                                                   GetUserInfoParams params)

getLogoutUri

@POST
 @Path(value="/get-logout-uri")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetLogoutUriResponse getLogoutUri(@HeaderParam(value="Authorization")
                                                                                                                                                  String authorization,
                                                                                                                                                  @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                  String authorizationOxdId,
                                                                                                                                                  GetLogoutUrlParams params)

getAccessTokenByRefreshToken

@POST
 @Path(value="/get-access-token-by-refresh-token")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetClientTokenResponse getAccessTokenByRefreshToken(@HeaderParam(value="Authorization")
                                                                                                                                                                                       String authorization,
                                                                                                                                                                                       @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                                       String authorizationOxdId,
                                                                                                                                                                                       GetAccessTokenByRefreshTokenParams params)

umaRsProtect

@POST
 @Path(value="/uma-rs-protect")
 @Produces(value="application/json")
 @Consumes(value="application/json")
RsProtectResponse umaRsProtect(@HeaderParam(value="Authorization")
                                                                                                                                               String authorization,
                                                                                                                                               @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                               String authorizationOxdId,
                                                                                                                                               RsProtectParams2 params)

umaRsModify

@POST
 @Path(value="/uma-rs-modify")
 @Produces(value="application/json")
 @Consumes(value="application/json")
RsModifyResponse umaRsModify(@HeaderParam(value="Authorization")
                                                                                                                                            String authorization,
                                                                                                                                            @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                            String authorizationOxdId,
                                                                                                                                            RsModifyParams params)

umaRsCheckAccess

@POST
 @Path(value="/uma-rs-check-access")
 @Produces(value="application/json")
 @Consumes(value="application/json")
RsCheckAccessResponse umaRsCheckAccess(@HeaderParam(value="Authorization")
                                                                                                                                                            String authorization,
                                                                                                                                                            @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                            String authorizationOxdId,
                                                                                                                                                            RsCheckAccessParams params)

umaRpGetRpt

@POST
 @Path(value="/uma-rp-get-rpt")
 @Produces(value="application/json")
 @Consumes(value="application/json")
RpGetRptResponse umaRpGetRpt(@HeaderParam(value="Authorization")
                                                                                                                                             String authorization,
                                                                                                                                             @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                             String authorizationOxdId,
                                                                                                                                             RpGetRptParams params)

umaRpGetClaimsGatheringUrl

@POST
 @Path(value="/uma-rp-get-claims-gathering-url")
 @Produces(value="application/json")
 @Consumes(value="application/json")
RpGetClaimsGatheringUrlResponse umaRpGetClaimsGatheringUrl(@HeaderParam(value="Authorization")
                                                                                                                                                                                            String authorization,
                                                                                                                                                                                            @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                                            String authorizationOxdId,
                                                                                                                                                                                            RpGetClaimsGatheringUrlParams params)

authorizationCodeFlow

@POST
 @Path(value="/authorization-code-flow")
 @Produces(value="application/json")
 @Consumes(value="application/json")
AuthorizationCodeFlowResponse authorizationCodeFlow(@HeaderParam(value="Authorization")
                                                                                                                                                                             String authorization,
                                                                                                                                                                             @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                             String authorizationOxdId,
                                                                                                                                                                             AuthorizationCodeFlowParams params)

checkAccessToken

@POST
 @Path(value="/check-access-token")
 @Produces(value="application/json")
 @Consumes(value="application/json")
CheckAccessTokenResponse checkAccessToken(@HeaderParam(value="Authorization")
                                                                                                                                                              String authorization,
                                                                                                                                                              @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                              String authorizationOxdId,
                                                                                                                                                              CheckAccessTokenParams params)

checkIdToken

@POST
 @Path(value="/check-id-token")
 @Produces(value="application/json")
 @Consumes(value="application/json")
CheckIdTokenResponse checkIdToken(@HeaderParam(value="Authorization")
                                                                                                                                                  String authorization,
                                                                                                                                                  @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                  String authorizationOxdId,
                                                                                                                                                  CheckIdTokenParams params)

getRp

@POST
 @Path(value="/get-rp")
 @Produces(value="application/json")
 @Consumes(value="application/json")
String getRp(@HeaderParam(value="Authorization")
                                                                                                                     String authorization,
                                                                                                                     @HeaderParam(value="AuthorizationOxdId")
                                                                                                                     String authorizationOxdId,
                                                                                                                     GetRpParams params)

getJwks

@POST
 @Path(value="/get-jwks")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetJwksResponse getJwks(@HeaderParam(value="Authorization")
                                                                                                                                  String authorization,
                                                                                                                                  @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                  String authorizationOxdId,
                                                                                                                                  GetJwksParams params)

getDiscovery

@POST
 @Path(value="/get-discovery")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetDiscoveryResponse getDiscovery(GetDiscoveryParams params)

getIssuer

@POST
 @Path(value="/get-issuer")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetIssuerResponse getIssuer(GetIssuerParams params)

getRequestObjectUri

@POST
 @Path(value="/get-request-object-uri")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetRequestObjectUriResponse getRequestObjectUri(@HeaderParam(value="Authorization")
                                                                                                                                                                        String authorization,
                                                                                                                                                                        @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                        String authorizationOxdId,
                                                                                                                                                                        GetRequestObjectUriParams params)

initiateThirdPartyLogin

@GET
 @Path(value="/initiate-third-party-login/{oxd_id}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
GetAuthorizationUrlResponse initiateThirdPartyLogin(@HeaderParam(value="Authorization")
                                                                                                                                                                                        String authorization,
                                                                                                                                                                                        @HeaderParam(value="AuthorizationOxdId")
                                                                                                                                                                                        String authorizationOxdId,
                                                                                                                                                                                        @PathParam(value="oxd_id")
                                                                                                                                                                                        String oxdId,
                                                                                                                                                                                        @QueryParam(value="iss")
                                                                                                                                                                                        String iss,
                                                                                                                                                                                        @QueryParam(value="login_hint")
                                                                                                                                                                                        String loginHint,
                                                                                                                                                                                        @QueryParam(value="target_link_uri")
                                                                                                                                                                                        String targetLinkUri)