Oauth

class matterapi.endpoints.async_api.OauthApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)

Endpoints for configuring and interacting with Mattermost as an OAuth 2.0 service provider.

async create_oauth_app(*, json_body: Union[matterapi.models.CreateOAuthAppJsonBody, Dict]) → matterapi.models.OAuthApp

Register OAuth app

Register an OAuth 2.0 client application with Mattermost as the service provider.

Permissions:

Must have manage_oauth permission.

Api Reference:

CreateOAuthApp

async delete_oauth_app(app_id: str) → matterapi.models.StatusOK

Delete an OAuth app

Delete and unregister an OAuth 2.0 client application

Permissions:

If app creator, must have mange_oauth permission otherwise manage_system_wide_oauth permission is required.

Api Reference:

DeleteOAuthApp

async get_authorized_oauth_apps_for_user(user_id: str, *, page: Optional[int] = 0, per_page: Optional[int] = 60) → List[matterapi.models.OAuthApp]

Get authorized OAuth apps

Get a page of OAuth 2.0 client applications authorized to access a user’s account.

Permissions:

Must be authenticated as the user or have edit_other_users permission.

Api Reference:

GetAuthorizedOAuthAppsForUser

async get_oauth_app(app_id: str) → matterapi.models.OAuthApp

Get an OAuth app

Get an OAuth 2.0 client application registered with Mattermost.

Permissions:

If app creator, must have mange_oauth permission otherwise manage_system_wide_oauth permission is required.

Api Reference:

GetOAuthApp

async get_oauth_app_info(app_id: str) → matterapi.models.OAuthApp

Get info on an OAuth app

Get public information about an OAuth 2.0 client application registered with Mattermost. The application’s client secret will be blanked out.

Permissions:

Must be authenticated.

Api Reference:

GetOAuthAppInfo

async get_oauth_apps(*, page: Optional[int] = 0, per_page: Optional[int] = 60) → List[matterapi.models.OAuthApp]

Get OAuth apps

Get a page of OAuth 2.0 client applications registered with Mattermost.

Permissions:

With manage_oauth permission, the apps registered by the logged in user are returned. With manage_system_wide_oauth permission, all apps regardless of creator are returned.

Api Reference:

GetOAuthApps

async regenerate_oauth_app_secret(app_id: str) → matterapi.models.OAuthApp

Regenerate OAuth app secret

Regenerate the client secret for an OAuth 2.0 client application registered with Mattermost.

Permissions:

If app creator, must have mange_oauth permission otherwise manage_system_wide_oauth permission is required.

Api Reference:

RegenerateOAuthAppSecret

async update_oauth_app(app_id: str, *, json_body: Union[matterapi.models.UpdateOAuthAppJsonBody, Dict]) → matterapi.models.OAuthApp

Update an OAuth app

Update an OAuth 2.0 client application based on OAuth struct.

Permissions:

If app creator, must have mange_oauth permission otherwise manage_system_wide_oauth permission is required.

Api Reference:

UpdateOAuthApp