Module net.bis5.mattermost4j.core
Package net.bis5.mattermost.client4.api

Interface OAuthApi

  • All Known Implementing Classes:
    MattermostClient
    public interface OAuthApi
    OAuth API.
    Author:
    Takayuki Maruyama

    • Method Detail

      • createOAuthApp

        ApiResponse<OAuthApp> createOAuthApp​(OAuthApp app)
        will register a new OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

      • getOAuthApps

        default ApiResponse<List<OAuthApp>> getOAuthApps()
        gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0 service provider.

      • getOAuthApps

        ApiResponse<List<OAuthApp>> getOAuthApps​(Pager pager)
        gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0 service provider.

      • getOAuthApp

        ApiResponse<OAuthApp> getOAuthApp​(String appId)
        gets a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

      • getOAuthAppInfo

        ApiResponse<OAuthApp> getOAuthAppInfo​(String appId)
        gets a sanitized version of a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

      • deleteOAuthApp

        ApiResponse<Boolean> deleteOAuthApp​(String appId)
        deletes a registered OAuth 2.0 client application.

      • regenerateOAuthAppSecret

        ApiResponse<OAuthApp> regenerateOAuthAppSecret​(String appId)
        regenerates the client secret for a registered OAuth 2.0 client application.

      • getAuthorizedOAuthAppsForUser

        default ApiResponse<List<OAuthApp>> getAuthorizedOAuthAppsForUser​(String userId)
        gets a page of OAuth 2.0 client applications the user authorized to use access their account.

      • getAuthorizedOAuthAppsForUser

        ApiResponse<List<OAuthApp>> getAuthorizedOAuthAppsForUser​(String userId,
                                                          Pager pager)
        gets a page of OAuth 2.0 client applications the user authorized to use access their account.

      • authorizeOAuthApp

        String authorizeOAuthApp​(AuthorizeRequest authRequest)
        will authorize an OAuth 2.0 client application to access a user's account and provide a redirect link to follow.

      • deauthorizeOAuthApp

        ApiResponse<Boolean> deauthorizeOAuthApp​(String appId)
        will deauthorize an OAuth 2.0 client application from accessing a user's account.