providers/kick
KickProfile
Properties
data
data: {
email: string;
name: string;
profile_picture: string;
user_id: number;
}[];
email: string;
Email address of the user.
name
name: string;
Display name of the user.
profile_picture
profile_picture: string;
URL of the user’s profile picture.
user_id
user_id: number;
Unique identifier for the user.
message
message: string;
Response message from the API.
default()
function default(options): OAuthConfig<KickProfile>
Add Kick login to your page.
Setup
Callback URL
https://example.com/api/auth/callback/kick
Configuration
import { Auth } from "@auth/core"
import Kick from "@auth/core/providers/kick"
const request = new Request(origin)
const response = await Auth(request, {
providers: [
Kick({
clientId: KICK_CLIENT_ID,
clientSecret: KICK_CLIENT_SECRET,
}),
],
})
Scopes
The Kick provider uses the user:read
scope by default to access basic user information.
For a complete list of available scopes and their descriptions, see the
Kick Scopes documentation.
Resources
Notes
By default, Auth.js assumes that the Kick provider is based on the OAuth 2.0 specification.
The Kick provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.
Disclaimer If you think you found a bug in the default configuration, you can open an issue.
Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.
Parameters
Parameter | Type |
---|---|
options | OAuthUserConfig <KickProfile > |