providers/mattermost

Functions

default()

Signature

default<P>(config: Omit<Partial<OAuthConfig<P>>, "type" | "options"> & Required<Pick<OAuthConfig<P>, "clientId" | "clientSecret">> & { issuer: string  }): OAuthConfig<P>

To create your Mattermost OAuth2 app visit http://<your Mattermost instance url>/<your team>/integrations/oauth2-apps

Example

import Mattermost from "@auth/core/providers/mattermost";
...
providers: [
  Mattermost({
    clientId: env.MATTERMOST_ID,
    clientSecret: env.MATTERMOST_SECRET,
    // The base url of your Mattermost instance. e.g https://my-cool-server.cloud.mattermost.com
    issuer: env.MATTERMOST_ISSUER,
  })
]
...

danger

The Mattermost provider requires the issuer option to be set. This is the base url of your Mattermost instance. e.g https://my-cool-server.cloud.mattermost.com

Type parameters

• P extends MattermostProfile

Parameters

Name	Type
config	Omit<Partial<OAuthConfig<P>>, "type" | "options"> & Required<Pick<OAuthConfig<P>, "clientId" | "clientSecret">> & { issuer: string }

Returns

OAuthConfig<P>

Interfaces

MattermostProfile

See

Get a user

Properties

create_at

create_at: number

The time in milliseconds a user was created

delete_at

delete_at: number

The time in milliseconds a user was deleted

update_at

update_at: number

The time in milliseconds a user was last updated

terms_of_service_create_at

terms_of_service_create_at?: number

The time in milliseconds the user accepted the terms of service

terms_of_service_id

terms_of_service_id?: string

ID of accepted terms of service, if any. This field is not present if empty.