Package io.github.ma1uta.matrix.client.api

Interface OpenIdApi

  • @Path("/_matrix/client/r0")
@Consumes("application/json")
@Produces("application/json")
public interface OpenIdApi
    This module allows users to verify their identity with a third party service. The third party service does need to be matrix-aware in that it will need to know to resolve matrix homeservers to exchange the user's token for identity information.

    • Method Summary

      Modifier and Type Method Description
      void requestToken​(String userId, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)
      Gets an OpenID token object that the requester may supply to another service to verify their identity in Matrix.

    • Method Detail

      • requestToken

        @POST
@Path("/user/{userId}/openid/request_token")
void requestToken​(@PathParam("userId")
                  String userId,
                  @Context
                  javax.ws.rs.core.UriInfo uriInfo,
                  @Context
                  javax.ws.rs.core.HttpHeaders httpHeaders,
                  @Suspended
                  javax.ws.rs.container.AsyncResponse asyncResponse,
                  @Context
                  javax.ws.rs.core.SecurityContext securityContext)
        Gets an OpenID token object that the requester may supply to another service to verify their identity in Matrix. The generated token is only valid for exchanging for user information from the federation API for OpenID.
        The access token generated is only valid for the OpenID API. It cannot be used to request another OpenID access token or call /sync, for example.
        Rate-limited: Yes. Requires auth: Yes.
        Return: OpenIdResponse.

        Status code 200: OpenID token information. This response is nearly compatible with the response documented in the OpenID 1.0 Specification with the only difference being the lack of an id_token. Instead, the Matrix homeserver's name is provided.

        Status code 429: This request was rate-limited.

        Parameters:
        userId - Required. The user to request and OpenID token for. Should be the user who is authenticated for the request.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.