Interface StatusApi
-
@Path("/_matrix/identity/api/v1") @Produces("application/json") public interface StatusApi
Checks that an Identity server is available at this API endpoint.
-
-
Method Summary
Modifier and Type Method Description void
v1Status(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse)
To discover that an Identity server is available at a specific URL, this endpoint can be queried and will return an empty object.
-
-
-
Method Detail
-
v1Status
@GET @Path("") void v1Status(@Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.HttpHeaders httpHeaders, @Suspended javax.ws.rs.container.AsyncResponse asyncResponse)
To discover that an Identity server is available at a specific URL, this endpoint can be queried and will return an empty object.
This is primarly used for auto-discovery and health check purposes by entities acting as a client for the Identity server.
Return:EmptyResponse
.Status code 200: An identity server is ready to serve requests.
- Parameters:
uriInfo
- Request information.httpHeaders
- Http headers.asyncResponse
- Asynchronous response.
-
-