UNPKG

@auth/core

Version:

Authentication for the Web.

67 lines 2.18 kB
/** * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}> * <span>Built-in <b>Roblox</b> integration.</span> * <a href="https://roblox.com/"> * <img style={{display: "block"}} src="https://authjs.dev/img/providers/roblox.svg" height="48" width="48"/> * </a> * </div> * * @module providers/roblox */ import type { OIDCUserConfig, OIDCConfig } from "./index.js"; /** * Corresponds to the user structure documented here: * https://create.roblox.com/docs/cloud/reference/oauth2 (Example User with Profile Scope) */ export interface RobloxProfile extends Record<string, any> { sub: string; name: string; nickname: string; preferred_username: string; created_at: number; profile: string; picture: string | null; } /** * Add Roblox login to your page. * * ### Setup * * #### Callback URL * ``` * https://example.com/api/auth/callback/roblox * ``` * * #### Configuration *```ts * import { Auth } from "@auth/core" * import Roblox from "@auth/providers/roblox" * * const request = new Request(origin) * const response = await Auth(request, { * providers: [ * Roblox({ * clientId: AUTH_ROBLOX_ID, * clientSecret: AUTH_ROBLOX_SECRET, * }), * ], * }) * ``` * * ### Resources * * - [Roblox OAuth documentation](https://create.roblox.com/docs/cloud/open-cloud/oauth2-overview) * - [Roblox OAuth apps](https://create.roblox.com/dashboard/credentials?activeTab=OAuthTab) * * :::info **Disclaimer** * * If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-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](https://authjs.dev/new/github-discussions). * * ::: */ export default function Roblox(options: OIDCUserConfig<RobloxProfile>): OIDCConfig<RobloxProfile>; //# sourceMappingURL=roblox.d.ts.map